List webhook deliveries

List webhook deliveries

GET https://<your_gateway_host>/api/webhook-deliveries

This endpoint allows you to get all webhook event deliveries associated with your account.

Path Parameters

All path parameters are optional.

Name	Type	Description
page	number	Offset of the results.
limit	number	Size of the page.
webhook_ids	UUID(s)	ID(s) of the webhook endpoint.
webhook_event_ids	UUID(s)	ID(s) of the webhook event.
event_types	string(s)	Event types.
response_statuses	string(s)	Response status types. Options are: "2xx", "3xx", "4xx", and "5xx".
date_duration	integer	Duration in seconds (before current time) to retrieve recent deliveries.
date[from]	ISO date string	Start date for event delivery date range. Ignored if date_duration is passed.
date[to]	ISO date string	End date for event delivery date range. Ignored if date_duration is passed.

Response

Response fields definitions

Name	Type	Definition
meta.total	integer	Total number of results.
meta.current_page	integer	Current page of results.
meta.total_pages	integer	Total pages of results.
data[i].id	UUID	ID of this webhook event delivery.
data[i].created_at	ISO date string	Datetime of the delivery.
data[i].webhook_id	UUID	ID of the webhook endpoint.
data[i].webhook_event_id	UUID	ID of the webhook event.
data[i].event_type	string	Event type from the webhook event.
data[i].response_status	integer	Response status from the webhook endpoint. e.g. 200, 403, 500.
data[i].url	string	URL of the webhook endpont at the time of delivery. This value is preserved even if the webhook endpoint is updated later.
data[i].payload	JSON	Payload of the webhook event.

Sample response - 200

{
  "meta": {
    "total": 1,
    "current_page": 1,
    "total_pages": 1
  },
  "data": [
    {
      "id": "7897ce6d-1135-4397-a610-b2274e78bf34",
      "created_at": "2021-01-02T02:09:24.626Z",
      "webhook_id": "729309f3-2555-46b8-a2d7-ddb03e3edeaa",
      "webhook_event_id": "708c49d1-1dd5-76c5-c3cd-7e379caf15ad",
      "event_type": "PAYMENT_SALE",
      "response_status": 403,
      "url": "https://example.com/api/webhooks",
      "payload": {
        "event_uid": "708c49d11dd576c5c3cd7e379caf15ad",
        "event": "PAYMENT_SALE",
        "data": {
          "token": "card_test_T9F178frnidxbMvuYv88mp6J",
          "account_id": "3cab79a6-31bd-43e6-9a0c-e5870b18fa38",
          "gateway_id": "6a2ca39d-d958-455e-852c-eb975d781697",
          "payment_id": "76045ff4-412e-47d7-82af-6f299a579c89",
          "description": "",
          "merchant_id": "372eac3d-7059-42b1-942d-fa75cfdb2243",
          "sale_response": {
            // suppressed for documentation
          },
          "transaction_id": "d27d43bb-7427-474a-b84b-4ff0a6a558ee"
        }
      }
    }
  ]
}