Docs

Webhooks

Get a delivery

One delivery with the exact body that was posted.

GET/v1/webhooks/{uid}/deliveries/{id}

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.
idstringpathrequired
The delivery's uid (16 characters, as in X-Sigil-Delivery).

Response

200 OKThe delivery, with payload.
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.
payloadobject
The event body exactly as it was posted.
Only from Get a delivery.

Errors

StatusWhen
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.
404 Not FoundNo delivery with that id for this endpoint (it may be older than 30 days).

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