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
JWTwebhook:write

Path parameters

idstringrequired

Request body

eventstring

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

Length: [1,256]

Response

200 OK

succeededbooleanrequired

Whether the endpoint responded with a success status code.

urlstringrequired

The endpoint the test payload was delivered to.

eventstringrequired

The event the test payload was sent for.

requestBodystringrequired

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

signaturestringrequired

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

responseStatusCodeinteger

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

Format: int32

responseBodystring

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

errorMessagestring

The reason the delivery failed, null when it succeeded.