v2

latestSwagger 2.02026-08-08121119168.6 KB

Webhooks

Send a test delivery

Delivers a sample payload to the webhook right now and returns what your endpoint responded, so you can verify the URL, authentication and signature verification without waiting for a test to finish. Sample data is used, not a real test result. Rate limited separately from the rest of the API.

post/v1/webhooks/{id}/test

Path parameters

idinteger required

Numeric webhook ID.

Response

Send a test delivery

okboolean required

Whether the request reached the endpoint and returned a response.

statusinteger required

HTTP status your endpoint responded with.

duration_msinteger required

Round-trip time in milliseconds.

headersobject required

Response headers your endpoint returned, lower-cased.

bodystring required

Response body, truncated.

sent_payloadstring required

Exact body TestingBot sent, after variable substitution.