- Home
- API reference
- Webhooks
- List webhook deliveries
List webhook deliveries
Lists event deliveries, newest first, with their retry count and final status.
/v1/webhook-deliverieswebhooks:read permission.Query parameters
Section titled “Query parameters”endpoint_idstringoptionalOnly the deliveries to this endpoint.
Example: whk_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with whk_.
payment_idstringoptionalOnly the deliveries about this payment.
Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with pay_.
statusstringoptionalOnly deliveries in this status: pending, retrying, succeeded or failed.
Example: failed
Possible values: pending, retrying, succeeded, failed
starting_afterstringoptionalThe id of the last item on the page you have. The next page starts after it.
Example: wdl_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with wdl_.
limitintegeroptionalHow many items one page holds, from 1 to 100. The default is 20.
Example: 20
Minimum: 1
Maximum: 100
Response (200)
Section titled “Response (200)”Returns a page of a list: data holds the items, and meta.pagination says how the list goes on. Page with limit and starting_after (the id of the last item you have), or fetch meta.pagination.next.
dataarray of objectrequiredThe returned object, or an array of objects for a list.
idstringrequiredThe id of the delivery (wdl_…).
Example: wdl_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with wdl_.
event_idstringrequiredThe event that was sent (wev_…).
Example: wev_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with wev_.
event_typestringrequiredEvent name in the payload, such as payment.succeeded; use it to decide which event handler should run.
Example: payment.succeeded
Possible values: payment.created, payment.succeeded, payment.failed, payment.expired, payment.settled, payment.anomaly, payment.unsettled, payment.reversed, payment.reversal_cancelled, payment.attempt.created, payment.attempt.failed, payment_link.created, payment_link.cancelled, payment_link.expired, payment_link.completed, payment_link.limit_reached, invoice.issued, invoice.paid, invoice.voided, project.created, project.updated, project.activated, project.deactivated, project.payment_methods_changed, project.live_requested, project.live_approved, project.live_revision_requested, api_key.created, api_key.rotated, api_key.revoked, webhook_endpoint.created, webhook_endpoint.updated, webhook_endpoint.deleted, webhook_endpoint.secret_rotated, webhook_endpoint.disabled, webhook.test
payment_idstring | nullrequiredRelated payment; null when the event is not about a payment.
Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with pay_.
simulatedbooleanrequiredtrue for a test event or a sandbox scenario.
endpoint_idstringrequiredThe endpoint it was sent to (whk_…).
Example: whk_01k7q3m8x2v5t9n4b6c1d0e7fa
Prefixed with whk_.
statusstringrequiredpending is queued, retrying will be sent again, succeeded means the endpoint returned a 2xx response, and failed means no more retries are scheduled.
Example: succeeded
Possible values: pending, retrying, succeeded, failed
attempt_countintegerrequiredNumber of delivery attempts made so far, including the latest attempt.
Example: 1
next_attempt_atstring | nullrequiredScheduled time of the next delivery retry; null when no retry is scheduled.
Example: 2026-10-26T03:04:05.000Z
Format: date-time
last_status_codeinteger | nullrequiredThe HTTP status your server answered on the last try; null when it did not answer.
Example: 200
last_error_codestring | nullrequiredA short code for why the last try failed; null when it did not.
Example: string
delivered_atstring | nullrequiredWhen the endpoint first accepted the event; null until a delivery succeeds.
Example: 2026-10-26T03:04:05.000Z
Format: date-time
created_atstringrequiredWhen this object was created (RFC 3339, UTC). Use it to sort objects by creation time.
Example: 2026-10-26T03:04:05.000Z
Format: date-time
metaobjectrequiredRequest details such as its id and pagination cursor.
request_idstringrequiredThe id of this request. Quote it when you ask support about it.
Example: req_Hy3k9QzT2LmN8vXa
paginationobjectrequiredPagination details for a list response. Use next to fetch the next page, or starting_after to build the URL yourself.
per_pageintegerrequiredNumber of items returned on this page.
Example: 20
has_morebooleanrequiredtrue means more items are available on another page.
nextstring | nullrequiredThe address of the next page, with your filters kept; null on the last page.
Example: string
A failed request answers with the common error shape; see Errors.
curl "https://api.baiyar.com/v1/webhook-deliveries" \ -H "Authorization: Bearer $BAIYAR_KEY"{ "data": [ { "id": "wdl_01k7q3m8x2v5t9n4b6c1d0e7fa", "event_id": "wev_01k7q3m8x2v5t9n4b6c1d0e7fa", "event_type": "payment.succeeded", "payment_id": "pay_01k7q3m8x2v5t9n4b6c1d0e7fa", "simulated": false, "endpoint_id": "whk_01k7q3m8x2v5t9n4b6c1d0e7fa", "status": "succeeded", "attempt_count": 1, "next_attempt_at": "2026-10-26T03:04:05.000Z", "last_status_code": 200, "last_error_code": "string", "delivered_at": "2026-10-26T03:04:05.000Z", "created_at": "2026-10-26T03:04:05.000Z" } ], "meta": { "request_id": "req_Hy3k9QzT2LmN8vXa", "pagination": { "per_page": 20, "has_more": true, "next": "https://api.baiyar.com/v1/webhook-deliveries?starting_after=wdl_01k7q3m8x2v5t9n4b6c1d0e7fa" } }}