Docs
Dashboard Get an API key

Webhooks

List deliveries

The endpoint's delivery log, newest first: every event queued for it in the last 30 days and how it went.

GET/v1/webhooks/{uid}/deliveries

Payloads are left out here; get a delivery for one. A pending delivery with attempts above 0 is waiting for its next try at next_attempt.

Authorization

Authorizationstringheaderrequired
Bearer followed by your API key: Bearer sgk_…. The key also works in an X-Api-Key header. See Authentication.

Path parameters

uidstringpathrequired
The webhook's 8-character id. Not case-sensitive.

Query parameters

limitintegerquerydefault: 50
Deliveries per page, 1 to 200.
offsetintegerquerydefault: 0
How many to skip.

Response

200 OKA page of deliveries.
dataarray of objects
The deliveries, without payload.
ShowHide delivery attributes
uidstring
The delivery's id, also sent as X-Sigil-Delivery. A retry repeats it.
event_idstring
The event's id, the body's id: the same for this event's delivery to each of your endpoints.
typestring
The event type.
One of pact.sent pact.viewed pact.signed pact.declined pact.voided pact.sealed pact.lapsed ping
pact_uidstring | null
The pact the event is about. null for a ping.
statusstring
pending is queued or waiting for its next attempt; sent got a 2xx; failed was given up on.
One of pending sent failed
attemptsinteger
Attempts made so far (7 at most).
last_codeinteger | null
The HTTP status of the last attempt, or null when it got no response.
last_errorstring | null
Why the last attempt did not count as delivered: the status and the start of your response body, a timeout, or a connection error.
next_attemptstring (date-time) | null
When it will next be tried, while pending.
date_createdstring (date-time)
When the event was queued.
date_sentstring (date-time) | null
When it was delivered.
totalinteger
How many the endpoint has in all.
limitinteger
The page size used.
offsetinteger
The offset used.

Errors

StatusWhen
400 Bad Requestlimit or offset out of range.
401 UnauthorizedThe API key is missing, wrong or revoked.
403 ForbiddenThe account's plan does not include API access (Pro and Business do).
404 Not FoundNo webhook with that id belongs to your account.

Every error body is { "error": "message" }. See Errors.