Events
The events you can subscribe a webhook to.
Each event name is type.action. Subscribe to any of them when you set up a webhook; see Setting up.
| Event | When it is sent |
|---|---|
client.created | A client is created |
client.updated | A client is updated |
staff.created | A staff member is created |
staff.updated | A staff member is updated |
appointment.created | A shift or appointment is created |
appointment.updated | A shift or appointment is updated |
appointment.deleted | A shift or appointment is deleted |
appointment.cancelled | A shift or appointment is cancelled |
incident.created | An incident is reported |
incident.updated | An incident is updated |
incident.deleted | An incident is deleted |
form.submitted | A form is submitted |
prospect.created | A prospect is created |
prospect.updated | A prospect is updated |
prospect.deleted | A prospect is deleted |
Appointment events cover single, group and site shifts, and incident events cover site incidents too.
Clients and staff are archived rather than removed, so archiving one sends an updated event.
Each event tells you what changed in its changed_fields list. See Payloads for the full event shape.
Was this page helpful?