Skip to content

Test webhook delivery

POST
/api/webhooks/subscription/{id}/test
Code sample: Shell / cURL
curl --request POST \
--url https://api.ztlpay.io/api/webhooks/subscription/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test \
--header 'Authorization: Bearer <token>'

Sends a webhook.test event regardless of selected event types and returns the immediate delivery result. The test event contains id, type, and createdAt. HTTP 200 is returned even when delivery fails; check succeeded and error. Retryable failures follow the normal delivery retry policy. Test requests have an allowance of 10 per partner per application instance, shared across all subscriptions and refilled every 60 seconds. Requests that return a delivery failure or subscription error also consume the allowance.

id
required
string format: uuid

Test delivery result. Check succeeded before treating the endpoint as verified.

Media typeapplication/json
object
deliveryId
required
string format: uuid
succeeded
required
boolean
error
string | null

Example generated

{
"deliveryId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"succeeded": true,
"error": "example"
}

Enabled subscription was not found.

Partner test request limit exceeded. No test delivery is created.

Retry-After
integer
>= 1 <= 60

Seconds to wait before another test request.

Example
60