Event catalogue
Every event type in webhooks and the event stream, with payload fields and the required scope.
Developer documentation
This page lists every event type carried by webhooks and the event stream (GET /api/v1/events). The list is generated from the product's event catalogue at build time.
- To read an event the key must carry the type's scope. Types that need
events:readalso need the type's module to be turned on in the account and the role to see the whole account in that module. - The payload is thin: it carries IDs, statuses, days and months. Read the details from the matching endpoint.
- For a leave type hidden in the calendar,
leave_type_idis empty and the status is only the visible one: a request awaiting a document shows aspending, a rejected request ascancelled. - New event types, and new fields for a new type, can be added; a field of an existing type is never removed and its type never changes.
Event types
employee.created
An employee record was created (from the screen, an Excel import or a hire).
Scope: employees:read · Module: Employees
| Field | Type |
|---|---|
employee_ | ID (uuid) |
org_ | ID (uuid), nullable |
status | status: active, pre_start, inactive, terminated |
hire_ | day (YYYY-MM-DD), nullable |
employee.updated
An employee record changed. The payload carries only the names of the changed fields.
Scope: employees:read · Module: Employees
| Field | Type |
|---|---|
employee_ | ID (uuid) |
changed_ | field names: first_name, last_name, work_email, org_unit_id, job_title_id, position_id, manager_id, hire_date, service_start_date, sgk_entry_date, employment_type, probation_end |
employee.started
An employee reached their first working day and became active.
Scope: employees:read · Module: Employees
| Field | Type |
|---|---|
employee_ | ID (uuid) |
start_ | day (YYYY-MM-DD) |
employee.terminated
An employee exit was recorded. The exit reason is not in the payload.
Scope: employees:read · Module: Employees
| Field | Type |
|---|---|
employee_ | ID (uuid) |
last_ | day (YYYY-MM-DD) |
org_unit.changed
An organisational unit was created, updated, moved or removed.
Scope: org:read · Module: Organisation
| Field | Type |
|---|---|
org_ | ID (uuid) |
parent_ | ID (uuid), nullable |
change | status: created, updated, moved, removed |
leave.request.created
A leave request was created.
Scope: leave:read · Module: Leave
| Field | Type |
|---|---|
leave_ | ID (uuid) |
employee_ | ID (uuid) |
leave_ | ID (uuid), nullable |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
status | status: awaiting_document, pending, approved, rejected, cancelled |
leave.request.approved
A leave request was approved.
Scope: leave:read · Module: Leave
| Field | Type |
|---|---|
leave_ | ID (uuid) |
employee_ | ID (uuid) |
leave_ | ID (uuid), nullable |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
status | status: awaiting_document, pending, approved, rejected, cancelled |
leave.request.rejected
A leave request was rejected.
Scope: leave:read · Module: Leave
| Field | Type |
|---|---|
leave_ | ID (uuid) |
employee_ | ID (uuid) |
leave_ | ID (uuid), nullable |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
status | status: awaiting_document, pending, approved, rejected, cancelled |
leave.request.cancelled
A leave request was cancelled (a pending request was withdrawn or an approved leave was cancelled).
Scope: leave:read · Module: Leave
| Field | Type |
|---|---|
leave_ | ID (uuid) |
employee_ | ID (uuid) |
leave_ | ID (uuid), nullable |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
status | status: awaiting_document, pending, approved, rejected, cancelled |
overtime.request.approved
An overtime request was approved (auto-approval included). The duration is not in the payload.
Scope: events:read · Module: Overtime
| Field | Type |
|---|---|
overtime_ | ID (uuid) |
employee_ | ID (uuid) |
work_ | day (YYYY-MM-DD) |
shift.plan.published
A month of the shift plan was published, or refreshed by a roster publication.
Scope: shifts:read · Module: Shifts
| Field | Type |
|---|---|
shift_ | ID (uuid) |
org_ | ID (uuid), nullable |
month | month (YYYY-MM) |
shift.assignment.changed
A person's shift on that day was set, changed or cleared in a published plan.
Scope: shifts:read · Module: Shifts
| Field | Type |
|---|---|
employee_ | ID (uuid) |
work_ | day (YYYY-MM-DD) |
roster.published
A duty roster was approved and published.
Scope: health_scheduling:read · Module: Duty scheduling
| Field | Type |
|---|---|
roster_ | ID (uuid) |
org_ | ID (uuid), nullable |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
roster.assignment.changed
A cell changed in a published roster (an edit, a swap or an open shift).
Scope: health_scheduling:read · Module: Duty scheduling
| Field | Type |
|---|---|
roster_ | ID (uuid) |
employee_ | ID (uuid) |
work_ | day (YYYY-MM-DD) |
physician.availability.changed
The HBYS sync closed or reopened a physician's appointment interval (staff code and exact times are on the pull endpoint).
Scope: health_scheduling:read, leave:read · Module: Duty scheduling, Leave
| Field | Type |
|---|---|
employee_ | ID (uuid) |
start_ | day (YYYY-MM-DD) |
end_ | day (YYYY-MM-DD) |
status | status: closed, open |
payroll.period.approved
A payroll period was approved. No amounts are in the payload.
Scope: events:read · Module: Payroll
| Field | Type |
|---|---|
payroll_ | ID (uuid) |
period | month (YYYY-MM) |
expense.claim.approved
An expense claim was approved. The amount is not in the payload.
Scope: events:read · Module: Expenses
| Field | Type |
|---|---|
expense_ | ID (uuid) |
employee_ | ID (uuid) |
expense_ | day (YYYY-MM-DD) |
signature.envelope.completed
A signature envelope was completed. The document title and the signers are not in the payload.
Scope: events:read · Module: Documents
| Field | Type |
|---|---|
envelope_ | ID (uuid) |
employee_ | ID (uuid), nullable |
level | status: basic, qualified_or_wet |
outcome | status: approved, evidence, signed |
recruiting.application.hired
An application was marked as hired.
Scope: events:read · Module: Recruiting
| Field | Type |
|---|---|
application_ | ID (uuid) |
opening_ | ID (uuid) |
candidate_ | ID (uuid) |
approval.task.created
An approval task became due for its assignee. The subject of the request is not in the payload.
Scope: events:read · Module: Approvals
| Field | Type |
|---|---|
approval_ | ID (uuid) |
approval_ | ID (uuid) |
assignee_ | ID (uuid) |
stage | sequence number |
webhook.ping
A test event: delivered only to the named endpoint.
Scope: events:read
| Field | Type |
|---|---|
endpoint_ | ID (uuid) |