Retrieve a webhook event delivery
Retrieve a webhook event delivery
GET
https://<your_gateway_host>/api/webhook-deliveries/<id>
This endpoint allows you to get the details of a single webhook event delivery.
Response
Name
Type
Description
id
UUID
ID of this webhook event delivery.
created_at
ISO date string
Datetime of the delivery.
webhook_id
UUID
ID of the webhook endpoint.
webhook_event_id
UUID
ID of the webhook event.
event_type
string
Event type from the webhook event.
response_status
integer
Response status from the webhook endpoint. e.g. 200, 403, 500.
url
string
URL of the webhook endpont at the time of delivery. This value is preserved even if the webhook endpoint is updated later.
payload
JSON
Payload of the webhook event.
{
"data": {
"id": "7897ce6d-1135-4397-a610-b2274e78bf34",
"url": "https://example.com/api/webhooks",
"event_type": "PAYMENT_SALE",
"created_at": "2021-01-02T02:09:24.626Z",
"webhook_id": "729309f3-2555-46b8-a2d7-ddb03e3edeaa",
"webhook_event_id": "708c49d1-1dd5-76c5-c3cd-7e379caf15ad",
"response_status": 403,
"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"
}
}
}
}
Last updated