Send a test webhook
POST/webhooks/endpoints/:key/test
Sends one signed webhook.test event to the endpoint now and waits up to 10 seconds for the answer. It signs the event the same way as real events.
- A receiver that fails, times out or refuses the address is a normal
200answer withdelivered: false. - When the receiver answered with a non-success status,
http_statuscarries that status anderrorisnull. erroris set only when the receiver gave no answer, and then holds a short cause (timeout,request failedorinvalid webhook destination) whilehttp_statusisnull.errorisnullwhen the event was delivered.- An unknown
key, and an endpoint you have not set or have deleted, answer404 NOT_FOUND.
Request
Responses
- 200
- 400
- 401
- 403
- 404
What the receiver answered
Error envelope
Error envelope
Error envelope
Error envelope