v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB

Shifts Updated Event

Receive real-time data updates on shifts updates at your specified URL.

V1 (default): one event per individual user assignment.

V2: aggregates all user assignments of the same shift into a single event, with a combined list of assigned user IDs and a base shift ID. Contact us to enable V2 for your account.

Find more details about event types and payload examples in the Guides -> Webhooks section for a deeper understanding.

postWebhookShifts updated

Response

Successful Response

requestIdstring

The request id

companystring required

The company id

activityTypestring

The activity type

eventTimestampinteger required

The event unix timestamp

evnetTimestampinteger required

DEPRECATED: Use event_timestamp instead

eventTypestring

The event type that triggers the webhook

schedulerIdinteger required

The unique identifier of the schedule