Webhooks_test

Send a `webhook.test` event to the endpoint and wait for its response. Works whatever the webhook's status is.

POST

/webhooks/{webhook_id}/test

Send a webhook.test event to the endpoint and wait for its response. Works whatever the webhook's status is.

Authorization

ApiKeyAuth

headerAuthorizationBearer <token>

Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.

Required permission

webhook_id*string

Formatuuid

The request has succeeded.

application/json

Result of a test send. It is not added to the delivery history.

success*boolean

status_code?integer

Formatint32

error?string

duration_ms*integer

Formatint64

response_snippet?string

curl -X POST "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"

{  "success": true,  "status_code": 0,  "error": "string",  "duration_ms": 0,  "response_snippet": "string"}