roster.published
A site's roster was published: drafts reached staff, changes were applied and removals made. Counts say what changed, including open shifts made available. Days a published pattern adds over time don't fire it.
Agoo sends this as a signed POST to every enabled endpoint subscribed to roster.published (or *). Verify the
signature, return any 2xx within 15 seconds, and de-duplicate on webhook-id.
webhook-id*stringThe event's ID. It is the same on every attempt and redelivery, so use it to de-duplicate.
^evt_[0-7][0-9a-hjkmnp-tv-z]{25}$"evt_01m4ww0ezgf2bryg9gxb2gbewx"webhook-timestamp*stringWhen this attempt was signed, in Unix seconds. Reject the request if it is more than 5 minutes from your clock.
^[0-9]+$webhook-signature*stringOne or more space-separated signatures, each v1,<base64>: the base64 HMAC-SHA256 of
{webhook-id}.{webhook-timestamp}.{raw body}, keyed with the base64-decoded part of your whsec_ secret.
During a secret rotation there are two. Accept the request if any one matches.
application/json- body
A site's roster was published.
id*EventIdThe event's ID. Webhook deliveries send it as webhook-id.
^evt_[0-7][0-9a-hjkmnp-tv-z]{25}$"evt_01m4ww0ezgf2bryg9gxb2gbewx"created_at*stringWhen the event happened.
date-timeorganisation_id*OrganisationIdAn organisation ID (TypeID with the org prefix).
^org_[0-7][0-9a-hjkmnp-tv-z]{25}$"org_01kjpsrza0etzb0a4vf72x8ang"livemode*booleanfalse for events in test mode.
type*"roster.published""roster.published"data*Return any 2xx status within 15 seconds to acknowledge the event. Agoo ignores the response body, so
acknowledge first and do slow work afterwards.
Example Requests
/roster.publishedleave.cancelled Webhook
Leave was cancelled while it waited, or before it started (its days come back to the balance). A private type of leave (sick and maternity by default) comes back as `kind: away`, without its type, reason or note. Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `leave.cancelled` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.
shift_swap.requested Webhook
A colleague took a shift offered to them, and the swap waits for your organisation's approvers. A swap that stands without approval fires shift_swap.approved only. Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `shift_swap.requested` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.