Skip to Content
Apex Settlement
Webhooks

List an endpoint's deliveries

Required permissioncustomer:webhooks:manage
GET
/v1/webhooks/{id}/deliveries

The endpoint's deliveries, newest first: each event sent to it, its state (pending while attempts remain, delivered once one got a 2xx, failed after the last), how many attempts were made, the status, start of the body and duration of the last answer, and the exact payload sent.

Requires the customer:webhooks:manage permission. Not available for an End Customer: Apex-End-Customer is refused.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Path Parameters

id*string

The endpoint's id.

Formatuuid

Query Parameters

limit?integer

How many deliveries to answer.

Range1 <= value <= 100
Default50

Response Body

OK

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'http://localhost:3480/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries'
Example Response
[  {    "attempt": 1,    "created_at": "2026-11-12T09:31:05Z",    "delivered_at": "2026-11-12T09:31:06Z",    "duration_ms": 142,    "event_id": "9b2f7c1e-5d4a-5e8b-a3c6-0f1d2e3a4b5c",    "event_type": "payout.updated",    "id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",    "last_error": "string",    "next_attempt_at": "2019-08-24T14:15:22Z",    "payload": {},    "response_body": "ok",    "response_status": 200,    "state": "delivered"  }]