Timeoff > LeaveType > Updates

Subscription_type: timeoff/leave_type/update

Payload

Callback payload

string
required

Identifier of the leave type

string
required

Name of the leave type

string

Translated name of the leave type, if available

string
required

Unique identifier of the leave type

string
required

The color associated with this leave type

boolean

Whether the leave type is active

boolean

Whether the leave type is editable

boolean

Whether leaves of this type must be approved before they take effect (when false, requests are auto-approved on creation)

boolean

Whether leaves of this type consume an accruing balance/allowance (vs. a non-accruing type that does not draw down a balance)

boolean
required

Whether an attachment (e.g. a sick note) can be added to leaves of this type

boolean

Whether leaves of this type may be open-ended (created with no finish date)

boolean

Whether requesting this leave type is restricted to specific employees or conditions rather than open to everyone

boolean
required

Whether the leave type is visible to employees (vs. admin-only)

boolean
required

Whether days taken under this leave type still count as workable (working) days

boolean

Whether leaves of this type are paid

string
required

ID of the company this leave type belongs to

boolean

Whether an attachment is mandatory (not just allowed) to request this leave type

allowance_ids
array of strings
required

IDs of the allowances this leave type draws its balance from

allowance_ids*
boolean

Whether leaves of this type can be requested in half-day units

integer

Maximum number of days a single request may take, in hundredths of a day (e.g. 5000 = 50 days); null if unbounded

integer

Minimum number of days a single request must take, in hundredths of a day (e.g. 1000 = 10 days); null if unbounded

string

Free-text description of the leave type

boolean
required

Whether the requester must provide additional details (a reason) when requesting this leave type

Response
200

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

LoadingLoading…