Sign in
Webhooks

List webhook deliveries

Changed on

What was sent, and what came of it. Newest first, unlike every other listing here: a delivery log is read to learn what just happened.

state is the field to branch on. delivered and failed are final; pending is neither — the event is waiting out its backoff and will be tried again. Reading is_successful: false as failure is the mistake the two stored flags invite.

payload is behind include=payload and off by default: a page of a hundred deliveries is a hundred employee records, and a caller watching its integration's health has no use for them. Reading one delivery answers with it either way.

webhook_id is null where the endpoint has since been removed.

get/company/v3/webhooks/deliveries

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/webhooks/deliveries
  • Auth: HTTP bearer

Query parameters

per_pageinteger

How many rows one page holds. Defaults to 50.

cursorstring nullable

The meta.next_cursor of the previous page. Omit it for the first. A cursor is bound to the filters it was issued under — change them and start again.

webhooksinteger[] nullable

Only deliveries to these endpoints, by id.

eventsstring[] nullable

Only deliveries of these events.

successfulboolean

Only deliveries that were accepted (true) or that were not (false).

pendingboolean

Only deliveries still waiting on a retry (true), or only those finished with (false).

sincestring date-time nullable

Only rows from this instant onward (ISO 8601).

includestring[] nullable

Relations to load, comma-separated. Anything not named is absent from the answer rather than null.

Response

Success

Changes