v1

latestOpenAPI 3.1.02026-07-2469193340.0 KB

Webhooks

List deliveries for a webhook

NOTE: Webhook deliveries are stored for 7 days.

get/webhooks/{webhook_id}/deliveries

Path parameters

webhook_idstring required

Single value, exact match

Query parameters

refstring

Filter deliveries by ref (WebhookDelivery.data.ref), single value, exact match

per_pageinteger

Number of results per page, single value, exact match

starting_afterstring uuid

Display all webhook deliveries after this webhook delivery offset UUID, single value, exact match

event_type'See ([Data schemas](/#data-schemas))'

See (Data schemas) for a list of possible values, single value, exact match

sincestring date-time

Display all webhook deliveries after this date. Date/time UTC ISO 8601 format, single value, exact match

response_status_codestring[]

Single value / multiple values separated by commas

statestring[]

Filter deliveries by state, single value / multiple values separated by commas. See Our delivery promise

Response

dataobject[]

Example response

{
  "data": [
    {
      "id": "957d40a4-80f5-4dd2-8ada-8242d5ad66c1",
      "event_type": "payout_request.added",
      "state": "completed",
      "response_status_code": 200,
      "created_at": "2021-09-02 02:24:50 UTC",
      "payload_data_summary": [
        {
          "ref": "PR.ct5b"
        }
      ]
    },
    {
      "id": "29bb9835-7c69-4ecb-bf96-197d089d0ec3",
      "event_type": "creditor_debit.scheduled",
      "state": "completed",
      "response_status_code": 200,
      "created_at": "2021-09-02 02:24:50 UTC",
      "payload_data_summary": [
        {
          "ref": "D.hyy9"
        },
        {
          "ref": "D.6st93"
        }
      ]
    }
  ]
}