Docs
Dashboard Get an API key

Webhooks

List webhooks

Every webhook endpoint on the account, with how its deliveries have been going.

GET/v1/webhooks

Secrets are never listed. An endpoint that keeps failing shows a rising consecutive_failures and, once disabled, active: false with a date_disabled. The webhooks guide explains what is posted and how to verify it.

Authorization

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

Response

200 OKA list. There is no paging: an account has 10 endpoints at most.
dataarray of objects
The endpoints, without secret.
ShowHide webhook attributes
uidstring
The endpoint's id: 8 letters and digits.
urlstring
Where events are posted: a public HTTPS URL.
descriptionstring | null
Your note on what it is for (100 characters at most).
eventsarray of strings | null
The event types it receives, or null for every pact event. A ping is delivered whatever this says.
activeboolean
Whether events are delivered to it. Switched off by you, by a 410 Gone answer, or after 10 failed deliveries in a row; switch it on again with Update a webhook.
consecutive_failuresinteger
Deliveries given up on since the last success. Resets to 0 on the next success.
last_statusinteger | null
The HTTP status of the last attempt. null before the first attempt, and when the last attempt got no response.
date_last_successstring (date-time) | null
When a delivery last got a 2xx.
date_disabledstring (date-time) | null
When it was switched off, while it is.
date_createdstring (date-time)
When it was added.
date_updatedstring (date-time)
When its settings or secret last changed.
totalinteger
How many there are.

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).

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