{
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sequence": 4503599627370495,
"data": {
"employeeId": "<string>",
"employeeNumber": "<string>",
"companyId": "<string>",
"effectiveDate": "<string>",
"changedFields": [],
"startDate": "<string>",
"lastDay": "<string>",
"hireId": "<string>",
"jobChangeId": "<string>",
"payChangeId": "<string>",
"leaveRequestId": "<string>",
"leaveTypeId": "<string>",
"cycleId": "<string>",
"documentId": "<string>",
"documentType": "<string>",
"status": "<string>",
"changeType": "<string>",
"kind": "<string>",
"endDate": "<string>",
"decidedAt": "2023-11-07T05:31:56Z",
"externalRef": {
"system": "<string>",
"id": "<string>"
},
"requestedVia": {
"keyId": "<string>"
}
},
"links": {
"employee": "<string>"
},
"details": {}
}Leave requestsubmitted
Needs Leave. A leave request was made, in the portal, the console or the API. data.leaveRequestId, data.leaveTypeId, data.startDate, data.endDate, data.status. Never sent for sick leave, which reaches you only as an approved absence on /time-off.
Signed with Standard Webhooks: webhook-id, webhook-timestamp and webhook-signature headers. Answer with any 2xx. At least once and not ordered: de-duplicate on id, order by occurredAt and sequence.
{
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sequence": 4503599627370495,
"data": {
"employeeId": "<string>",
"employeeNumber": "<string>",
"companyId": "<string>",
"effectiveDate": "<string>",
"changedFields": [],
"startDate": "<string>",
"lastDay": "<string>",
"hireId": "<string>",
"jobChangeId": "<string>",
"payChangeId": "<string>",
"leaveRequestId": "<string>",
"leaveTypeId": "<string>",
"cycleId": "<string>",
"documentId": "<string>",
"documentType": "<string>",
"status": "<string>",
"changeType": "<string>",
"kind": "<string>",
"endDate": "<string>",
"decidedAt": "2023-11-07T05:31:56Z",
"externalRef": {
"system": "<string>",
"id": "<string>"
},
"requestedVia": {
"keyId": "<string>"
}
},
"links": {
"employee": "<string>"
},
"details": {}
}Body
The event id. The same on every attempt and on a resend: use it to ignore a duplicate.
employee.hired, employee.started, employee.changed, employee.leaving, employee.left, employee.hire_withdrawn, employee.termination_cancelled, hire.status_changed, job_change.requested, job_change.decided, pay_change.requested, pay_change.decided, leave_request.submitted, leave_request.decided, performance.rating_released, document.added When the change was recorded.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Per person, in the order the changes took effect. Drop an event older than the last one seen for that person.
0 < x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Present only with Include details: the employee resource, limited to the endpoint's field groups.
Show child attributes
Show child attributes
Response
Received. Any 2xx counts; anything else, a timeout after 15 seconds or a redirect is retried.