Skip to content

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:read also 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_id is empty and the status is only the visible one: a request awaiting a document shows as pending, a rejected request as cancelled.
  • 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

employee.created: Payload fields
FieldType
employee_idID (uuid)
org_unit_idID (uuid), nullable
statusstatus: active, pre_start, inactive, terminated
hire_dateday (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

employee.updated: Payload fields
FieldType
employee_idID (uuid)
changed_fieldsfield 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

employee.started: Payload fields
FieldType
employee_idID (uuid)
start_dateday (YYYY-MM-DD)

employee.terminated

An employee exit was recorded. The exit reason is not in the payload.

Scope: employees:read · Module: Employees

employee.terminated: Payload fields
FieldType
employee_idID (uuid)
last_work_dayday (YYYY-MM-DD)

org_unit.changed

An organisational unit was created, updated, moved or removed.

Scope: org:read · Module: Organisation

org_unit.changed: Payload fields
FieldType
org_unit_idID (uuid)
parent_idID (uuid), nullable
changestatus: created, updated, moved, removed

leave.request.created

A leave request was created.

Scope: leave:read · Module: Leave

leave.request.created: Payload fields
FieldType
leave_request_idID (uuid)
employee_idID (uuid)
leave_type_idID (uuid), nullable
start_dateday (YYYY-MM-DD)
end_dateday (YYYY-MM-DD)
statusstatus: awaiting_document, pending, approved, rejected, cancelled

leave.request.approved

A leave request was approved.

Scope: leave:read · Module: Leave

leave.request.approved: Payload fields
FieldType
leave_request_idID (uuid)
employee_idID (uuid)
leave_type_idID (uuid), nullable
start_dateday (YYYY-MM-DD)
end_dateday (YYYY-MM-DD)
statusstatus: awaiting_document, pending, approved, rejected, cancelled

leave.request.rejected

A leave request was rejected.

Scope: leave:read · Module: Leave

leave.request.rejected: Payload fields
FieldType
leave_request_idID (uuid)
employee_idID (uuid)
leave_type_idID (uuid), nullable
start_dateday (YYYY-MM-DD)
end_dateday (YYYY-MM-DD)
statusstatus: 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

leave.request.cancelled: Payload fields
FieldType
leave_request_idID (uuid)
employee_idID (uuid)
leave_type_idID (uuid), nullable
start_dateday (YYYY-MM-DD)
end_dateday (YYYY-MM-DD)
statusstatus: 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

overtime.request.approved: Payload fields
FieldType
overtime_request_idID (uuid)
employee_idID (uuid)
work_dateday (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

shift.plan.published: Payload fields
FieldType
shift_plan_idID (uuid)
org_unit_idID (uuid), nullable
monthmonth (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

shift.assignment.changed: Payload fields
FieldType
employee_idID (uuid)
work_dateday (YYYY-MM-DD)

roster.published

A duty roster was approved and published.

Scope: health_scheduling:read · Module: Duty scheduling

roster.published: Payload fields
FieldType
roster_idID (uuid)
org_unit_idID (uuid), nullable
start_dateday (YYYY-MM-DD)
end_dateday (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

roster.assignment.changed: Payload fields
FieldType
roster_idID (uuid)
employee_idID (uuid)
work_dateday (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

physician.availability.changed: Payload fields
FieldType
employee_idID (uuid)
start_dateday (YYYY-MM-DD)
end_dateday (YYYY-MM-DD)
statusstatus: closed, open

payroll.period.approved

A payroll period was approved. No amounts are in the payload.

Scope: events:read · Module: Payroll

payroll.period.approved: Payload fields
FieldType
payroll_period_idID (uuid)
periodmonth (YYYY-MM)

expense.claim.approved

An expense claim was approved. The amount is not in the payload.

Scope: events:read · Module: Expenses

expense.claim.approved: Payload fields
FieldType
expense_claim_idID (uuid)
employee_idID (uuid)
expense_dateday (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

signature.envelope.completed: Payload fields
FieldType
envelope_idID (uuid)
employee_idID (uuid), nullable
levelstatus: basic, qualified_or_wet
outcomestatus: approved, evidence, signed

recruiting.application.hired

An application was marked as hired.

Scope: events:read · Module: Recruiting

recruiting.application.hired: Payload fields
FieldType
application_idID (uuid)
opening_idID (uuid)
candidate_idID (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

approval.task.created: Payload fields
FieldType
approval_task_idID (uuid)
approval_request_idID (uuid)
assignee_membership_idID (uuid)
stagesequence number

webhook.ping

A test event: delivered only to the named endpoint.

Scope: events:read

webhook.ping: Payload fields
FieldType
endpoint_idID (uuid)