attendance.break_started
Someone starts a break, where your organisation has break punches on: at a kiosk, in the Agoo Workspace app,
from your terminal, or a manager adds a Start break they missed (method manual). break_type says whether it's
a break (rest) or the paid nursing hour (nursing). They're still on site, and still clocked in.
Agoo sends this as a signed POST to every enabled endpoint subscribed to attendance.break_started (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
An event about a punch: a clock-in or clock-out, or a break punch.
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*string"attendance.clocked_in""attendance.clocked_out""attendance.late""attendance.voided""attendance.break_started""attendance.break_ended"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
/attendance.break_startedattendance.clocked_out Webhook
An employee clocks out, by any method, or a manager adds a clock-out they missed in the Console (method `manual`). Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `attendance.clocked_out` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.
attendance.break_ended Webhook
Someone ends a break, where your organisation has break punches on. `break_type` is the kind of break ended. How long the break was, and what came off worked time, is in the day's figures, not in the event: a break not ended before the clock-out sends no event and is flagged for a manager. Agoo sends this as a signed `POST` to every enabled endpoint subscribed to `attendance.break_ended` (or `*`). Verify the signature, return any `2xx` within 15 seconds, and de-duplicate on `webhook-id`.