v8

OpenAPI 3.1.02026-08-033623795.0 MB

Webhooks

Send Test Event

Sends a sample payload for the given event to the webhook's URL and returns the delivery result.

post/webhooks/{id}/test

Headers

Idempotency-Keystring

Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

eventstring required

The event to test the webhook for, in dot form (for example payment.succeeded).

Response

test event sent

{"stackTrail":"paths:/webhooks/{id}/test:post:responses:200:content:application/json:schema:properties:body","oasType":"schema","type":"unknown","description":"The body of the webhook response."}

statusinteger required

The HTTP response code of this request.

successboolean required

Whether or not the webhook test was successful.