Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Webhooks

BookkeepersManagement > Incidence > Updates

Subscription_type: bookkeepers_management/incidence/update

postWebhookWebhooks > BookkeepersManagement > Incidence > Updates

Payload

idstring required

identifier of the incidence (aka employee update).

employee_idstring

identifier of employee related.

legal_entity_idstring required

identifier of legal entity related.

namestring required

name of the incidence (aka employee update). It also represent the incidence type. For example a new hire incidence will be

custom_namestring
target_idstring required

The incidence (aka employee update) is also related to a another resource, for example for a leave target, the target identifier will be the leave id.

target_typestring required

The incidence (aka employee update) is also related to a another resource, for example a leave. This is the target type. The other types are Employee, Contracts::ContractVersion, BookkeepersManagement::ManualIncidence, Finance::CostCenterMembership.

starts_onstring

The date the incidence (aka employee update) starts.

ends_onstring

The date the incidence (aka employee update) end.

read_atstring

The date the incidence (aka employee update) was read.

statusstring required
company_idstring required

identifier of company related.

message_fromstring

Indicate the message sender on the incidence (aka employee update). It can be any of 'bookkeeper', 'admin'

has_messageboolean

Boolean that indicates if the incidence (aka employee update) has unread messages.

created_atstring required

Date in which incidence (aka employee update) was created.

is_reopenedboolean required

Boolean that indicates if the incidence (aka employee update) has been reopened.

legal_entity_namestring
employee_first_namestring
employee_last_namestring

Example payload

{
  "id": "1",
  "employee_id": "1",
  "legal_entity_id": "1",
  "name": "hiring",
  "target_id": "1",
  "target_type": "Timeoff::Leave",
  "starts_on": "2020-01-01",
  "ends_on": "2020-01-01",
  "read_at": "2020-01-01",
  "company_id": "1",
  "message_from": "admin",
  "has_message": true,
  "is_reopened": true
}

Response

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