Sign in
latestOpenAPI 3.0.42026-08-183012522.1 MB

66dcb6293180

Webhooks

Send a test event

Delivers a sample payload to the webhook url and returns the response, so the endpoint and its signature verification can be validated without waiting for a real event. The delivery is not recorded as a webhook event log and never suspends the webhook, whatever the outcome.

post/v3/webhooks/{id}/test

Path parameters

idstring required

Request body

eventstring nullable

The event to send a sample payload for. Defaults to the first event the webhook is subscribed to.

Response

OK

succeededboolean required

Whether the endpoint responded with a success status code.

urlstring required

The endpoint the test payload was delivered to.

eventstring required

The event the test payload was sent for.

requestBodystring required

The exact body which was signed and sent, so the signature can be reproduced.

signaturestring required

The value sent in the 'webhook-signature' header.

responseStatusCodeinteger nullable

The status code returned by the endpoint, null if no response was received.

responseBodystring nullable

The response body returned by the endpoint, truncated to 4096 characters.

errorMessagestring nullable

The reason the delivery failed, null when it succeeded.