Skip to navigation
API ReferenceWebhooks

List webhook deliveries

List webhook deliveries.

Credential: Partner secret

Before you call

  • A server-side partner secret for the owning partner. Do not send an Origin header.
  • An active integration that your partner credential permits.

List attempts/results; choose at most one status/eventType/tradeId selector

from/to are UTC timestamps ending in Z; timezone offsets are rejected. status values are pending, delivering, retrying, delivered, failed and canceled. lastResult describes the last attempt, not event occurrence time.

Server-only partner credential access: a 403 means the integration is unauthorized or inactive. Mutations share 60/min per partner; test and replay allow 5/min each per endpoint, rotation 1/min per endpoint. Only committed changes count; identical idempotent replays within 24 hours do not. A 429 includes retryAfter. Conflict details.kind can include IDEMPOTENCY_CONFLICT, ENDPOINT_DELETED, ENDPOINT_LIMIT, REVISION_CONFLICT, VERIFICATION_REQUIRED, ROTATION_IN_PROGRESS or REPLAY_UNAVAILABLE. Webhook availability depends on environment readiness; confirm it with Sinbad.

Webhook delivery must be available in the selected environment. Confirm readiness with Sinbad.

Errors

StatusCodeWhat to do
400VALIDATION_ERRORCorrect the fields reported in details before retrying.
401UNAUTHENTICATEDCreate a new customer session or use a valid server credential.
403FORBIDDENUse a server credential permitted for this active integration.
404NOT_FOUNDCheck the resource ID. A resource that belongs to someone else also returns 404.
409CONFLICTRead the current state again before you prepare or retry.
429RATE_LIMITEDWait for Retry-After before retrying.
503UPSTREAM_ERRORRetry with backoff; preserve the same idempotency key for a repeated mutation.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

webhookIdstringRequiredformat: "^[A-Za-z0-9_-]{1,128}$"

Query parameters

limitintegerOptional1-100Defaults to 20
cursorstringOptional<=2048 characters
statusenumOptional
eventTypeenumOptional
Allowed values:
tradeIdstringOptionalformat: "^[A-Za-z0-9_-]{1,128}$"
fromdatetimeOptional
todatetimeOptional

Response headers

Cache-ControlstringOptional

no-store

Response

Success
deliverieslist of objects
nextCursorstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
503
Service Unavailable Error