Skip to main content
POST
/
platform
/
webhooks
/
{webhookId}
/
test
Test a platform webhook
curl --request POST \
  --url https://api.arkhq.io/v1/platform/webhooks/{webhookId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "MessageSent"
}
'
{
  "success": true,
  "data": {
    "success": true,
    "statusCode": 200,
    "durationMs": 156,
    "error": null
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Documentation Index

Fetch the complete documentation index at: https://arkhq.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
webhookId
string
required

Platform webhook ID

Body

application/json
​
event
enum<string>
required

Event type to simulate

Available options:
MessageSent,
MessageDelayed,
MessageDeliveryFailed,
MessageHeld,
MessageBounced,
MessageLinkClicked,
MessageLoaded,
DomainDNSError

Response

Test result

​
success
boolean
required
​
data
object
required
​
meta
object
required