Firsty

Search...

Search...

ManagementExperimental

List webhook deliveries

Lists the deliveries to one webhook endpoint over the last 7 days, newest first. A delivery is one event: attemptNumber counts the attempts made so far, payload is the body sent, and httpStatus and responseBody are the endpoint's answer to the latest attempt.

get/management/webhooks/{webhookEndpointReference}/deliveries

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

webhookEndpointReferencestringrequired

Webhook endpoint reference, as returned by GET /management/webhooks.

Query parameters

limitinteger

Maximum number of items to return (1-100)

Default20
cursorstring

Opaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.

Responses

200List of deliveriesapplication/json
Show response body
dataarray of WebhookDelivery
Show properties
eventTypestring
eventIdstring

The webhook-id header every attempt of this delivery carries.

payloadobject

The request body sent to the endpoint.

responseBodystring | null

Body the endpoint answered on the latest attempt. Null when no attempt reached it.

statusstring

pending and sending are in flight, failed will be retried at nextRetryAt, exhausted means every retry failed and no further attempt will be made.

Optionspendingsendingdeliveredfailedexhausted
attemptNumberinteger

Attempts made for this delivery so far.

httpStatusinteger | null

Status code the endpoint answered on the latest attempt. Null when no attempt reached it.

nextRetryAtstring | null · date-time
sentAtstring | null · date-time

When the latest attempt was sent.

deliveredAtstring | null · date-time

When the endpoint acknowledged the event with a 2xx.

paginationobject
Show properties
limitinteger

Maximum items per page

hasMoreboolean

Whether there are more items after this page

nextCursorstring | null

Opaque cursor token for the next page. Null when there are no more results.

400Bad request - invalid parameters401Unauthorized - missing or invalid API key404Resource not found429Rate limit exceeded. A `429` can also arrive without these headers or this body; handle it by its status code.500Internal server error