v2

latestOpenAPI 3.1.02026-08-0810576180.4 KB
Webhooks

Test Webhook

Send a test payload to a webhook subscription.

Sends a sample payload to verify the webhook endpoint is working correctly.

Requires x-api-key header.

post/api/v1/webhooks/{webhook_id}/test

Path parameters

webhook_idinteger required

Headers

x-api-keystring nullable

Response

Successful Response

successboolean required

Whether the test delivery was successful

messagestring required

Status message

http_status_codeinteger nullable

HTTP status code from the webhook endpoint