Webhook Events

Webhook Event Schema

eventType string

The type entity that triggered this event

unifiedApi string

serviceId string

Service provider identifier

consumerId string

eventId string

Unique reference to this request event

entityId string

The service provider's ID of the entity that triggered this event

entityType string

The type entity that triggered this event

occurred_at string

ISO Datetime for when the original event occurred

Employee created event

{
  "eventType": "hris.employee.created",
  "unifiedApi": "hris",
  "serviceId": "bamboohr",
  "consumerId": "6457cde412554e3fb7190124",
  "eventId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entityId": "8",
  "entityType": "employee",
  "occurred_at": "2023-05-07T16:15:48.346Z"
}

Employee updated event

{
  "eventType": "hris.employee.updated",
  "unifiedApi": "hris",
  "serviceId": "bamboohr",
  "consumerId": "6457cde412554e3fb7190124",
  "eventId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entityId": "8",
  "entityType": "employee",
  "occurred_at": "2023-05-07T16:15:48.346Z"
}

Employee deleted event

{
  "eventType": "hris.employee.deleted",
  "unifiedApi": "hris",
  "serviceId": "bamboohr",
  "consumerId": "6457cde412554e3fb7190124",
  "eventId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entityId": "8",
  "entityType": "employee",
  "occurred_at": "2023-05-07T16:15:48.346Z"
}

Employee terminated event

{
  "eventType": "hris.employee.terminated",
  "unifiedApi": "hris",
  "serviceId": "bamboohr",
  "consumerId": "6457cde412554e3fb7190124",
  "eventId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entityId": "8",
  "entityType": "employee",
  "occurred_at": "2023-05-07T16:15:48.346Z"
}