Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Webhooks

Timeoff > LeaveType > Updates

Subscription_type: timeoff/leave_type/update

postWebhookWebhooks > Timeoff > LeaveType > Updates

Payload

idstring required

Identifier of the leave type

namestring required

Name of the leave type

translated_namestring

Translated name of the leave type, if available

identifierstring required

Unique identifier of the leave type

colorstring required

The color associated with this leave type

activeboolean

Whether the leave type is active

editableboolean

Whether the leave type is editable

approval_requiredboolean

Whether approval is required for this leave type

accruesboolean

Whether the leave type accrues over time

attachmentboolean required

Whether an attachment is required for this leave type

allow_endlessboolean

Whether endless leave is allowed

restrictedboolean

Whether the leave type is restricted

visibilityboolean required

Whether the leave type is visible to employees

workableboolean required

Whether the leave type is workable

payableboolean

Whether the leave type is payable

company_idstring required

Identifier of the company associated with this leave type

is_attachment_mandatoryboolean

Whether the attachment is mandatory

allowance_idsstring[] required

List of allowance identifiers associated with this leave type

half_days_units_enabledboolean

Whether half-day units are enabled for this leave type

max_days_in_centsinteger

Maximum days in cents that can be taken

min_days_in_centsinteger

Minimum days in cents that must be taken

descriptionstring

Description of the leave type

details_requiredboolean required

Whether additional details are required for the leave type

Example payload

{
  "id": "1",
  "name": "Annual Leave",
  "translated_name": "Congé Annuel",
  "identifier": "annual_leave",
  "color": "red",
  "active": true,
  "approval_required": true,
  "accrues": true,
  "attachment": true,
  "visibility": true,
  "payable": true,
  "company_id": "1",
  "allowance_ids": [
    "1",
    "2"
  ],
  "half_days_units_enabled": true,
  "max_days_in_cents": 5000,
  "min_days_in_cents": 1000,
  "description": "This leave type is for annual holidays."
}

Response

Return a 200 status to indicate that the data was received successfully