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

Authorizations

Authorization
string
header
required

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

Authorization: Bearer YOUR_API_KEY

Path Parameters

webhookId
string
required

Webhook ID or UUID

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