Test Webhook Public

curl --request POST \
  --url https://api.example.com/webhooks/{webhook_id}/test \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "statusCode": 123,
  "durationMs": 123,
  "error": "<string>"
}

POST

webhooks

{webhook_id}

test

Test Webhook Public

curl --request POST \
  --url https://api.example.com/webhooks/{webhook_id}/test \
  --header 'X-API-Key: <api-key>'

{
  "success": true,
  "statusCode": 123,
  "durationMs": 123,
  "error": "<string>"
}

X-API-Key

string

header

required

webhook_id

string<uuid>

required

Successful Response

Schema for webhook test response.

success

boolean

required

statusCode

integer | null

durationMs

integer | null

error

string | null

Documentation Index