ARarkhq-io
Platform Webhooks

Test a platform webhook

Changed on

Send a test payload to your platform webhook endpoint.

Use this to:

  • Verify your webhook URL is accessible
  • Test your payload handling code
  • Ensure your server responds correctly

The test payload is marked with _test: true so you can distinguish test events from real events.

post/platform/webhooks/{webhookId}/test

Request

Path parameters

webhookIdstring required

Platform 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,
    "durationMs": 156
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Changes