Employeehire withdrawn

A hire was withdrawn before the start date.

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.

WEBHOOK employee.hire_withdrawn

Example

{
  "id": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "sequence": 4503599627370495,
  "data": {
    "employeeId": "<string>",
    "employeeNumber": "<string>",
    "companyId": "<string>",
    "effectiveDate": "<string>",
    "changedFields": [],
    "startDate": "<string>",
    "lastDay": "<string>"
  },
  "links": {
    "employee": "<string>"
  },
  "details": {}
}

Body

application/json

id · string · required

The event id. The same on every attempt and on a resend: use it to ignore a duplicate.

type · enum<string> · required

Available options: employee.hired, employee.started, employee.changed, employee.leaving, employee.left, employee.hire_withdrawn, employee.termination_cancelled

occurredAt · string<date-time> · required

When the change was recorded.

Pattern: ^(?:(?:\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)))$

sequence · integer | null · required

Per person, in the order the changes took effect. Drop an event older than the last one seen for that person.

Required range: 0 < x <= 9007199254740991

data · object · required

Show child attributes

links · object · required

Show child attributes

details · object

Present only with Include details: the employee resource, limited to the endpoint's field groups.

Show child attributes

Response

200

Received. Any 2xx counts; anything else, a timeout after 15 seconds or a redirect is retried.