Graphon Engine

List webhook deliveries

List a webhook’s delivery log, newest first, with the last attempt of each delivery.

GET/webhooks/{webhook}/deliveries

PermissionCluster key, or a scoped key with read on a namespace or collection that the webhook covers. Key scopes and actions.

  • Lists return items and next_cursor. Keep the same key and filters for the next page. List cursors expire after one hour.
  • A delivery is one event queued at this webhook. An attempt is one POST of the batch that held it.
  • file_id finds the deliveries of one file. In the log of a wider webhook, a namespace key sees only its own namespace’s events, and a collection key only its own collections’ events.
  • The log keeps 30 days of events.

Path parameters

webhookstringrequired

Webhook ID with the whk_ prefix, or the webhook’s name.

Query parameters

statusstringoptionalaccepts null

Return only deliveries with this status.

pending
Queued, or waiting for a retry.
succeeded
The receiver answered 2xx to a batch that held the event.
failed
Engine will not send the event again unless you replay it.
event_typestringoptionalaccepts null

Return only deliveries of this event type, such as file.status_changed.

file_idstringoptionalaccepts null

Return only deliveries of events that name this fil_ ID.

cursorstringoptionalaccepts null

Opaque continuation token from next_cursor. Keep the same key, filters, and other request values. Omit it for the first page.

limitintegeroptional

Maximum resources in this page. Default 50, minimum 1, maximum 100.

Default: 50

  • Minimum: 1
  • Maximum: 100

Responses

200Success

A page of the delivery log, newest first.

application/json

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

itemsarray<object>required

Page of deliveries visible to this key. An empty array means no resources matched.

next_cursorstringrequiredaccepts null

Token for the next page, or null when this result has no next page. Do not parse or modify the token.

Errors

Select an error in the response example to see its JSON body. See error handling for the common error format.

400invalid_request

A field, path, parameter, or conditional request rule is invalid.

What to do: Correct the request. Unknown fields are rejected.

400invalid_cursor

The cursor expired or does not belong to this request and key.

What to do: Restart from the first page. Preserve the same key, filters, and request values when continuing.

401unauthenticated

The API key is missing, invalid, or revoked.

What to do: Send an active key in Authorization: Bearer or X-API-Key.

403forbidden

The key can see the resource but lacks permission for this operation.

What to do: Use a key with the required action or scope kind.

404not_found

The resource is absent, deleted, or outside this key’s scope.

What to do: Check the identifier and the key’s namespace and collection scope.

503temporarily_unavailable

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

500internal_error

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?
View as Markdown