Skip to main content

WebhookDeliveryResponse

successbooleanrequired
data object

Response payload for successful operations.

idstring<uuid>required
merchantIdstring<uuid>required
eventTypestringrequired
statusstringrequired

Possible values: [SUCCESS, FAILED, RETRYING]

targetUrlstring<uri>required
responseCodeintegernullable

Possible values: >= 100 and <= 599

attemptCountintegerrequired

Possible values: >= 1

nextRetryAtstring<date-time>nullable
createdAtstring<date-time>required
updatedAtstring<date-time>required
errorstring

Machine-readable error code.

messagestring

Human-readable response message.

WebhookDeliveryResponse
{
"success": true,
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"eventType": "string",
"status": "SUCCESS",
"targetUrl": "string",
"responseCode": 0,
"attemptCount": 0,
"nextRetryAt": "2024-07-29T15:51:28.071Z",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z"
},
"error": "string",
"message": "string"
}