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>'

• Production environment
• Sandbox environment for testing

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.

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

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"
}

404

Enabled subscription was not found.