Sign in

v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Webhooks

Test a webhook

Send a test payload to your webhook endpoint and verify it receives the data correctly.

Use this to:

  • Verify your webhook URL is accessible
  • Test your signature verification code
  • Ensure your server handles the payload format correctly

Test payload format: The test payload is identical to real webhook payloads, containing sample data for the specified event type. Your webhook should respond with a 2xx status code.

post/tenants/{tenantId}/webhooks/{webhookId}/test

Path parameters

tenantIdstring required

The tenant ID

webhookIdstring required

Webhook ID

Request body

event'MessageSent' | 'MessageDelayed' | 'MessageDeliveryFailed' | 'MessageHeld' | 'MessageBounced' | 'MessageLinkClicked' | 'MessageLoaded' | 'DomainDNSError' required

Event type to simulate

Response

Test result

successtrue required

Example response

{
  "data": {
    "statusCode": 200,
    "body": "OK",
    "duration": 245,
    "event": "MessageSent"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}