Skip to main content

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 200 answer with delivered: false.
  • When the receiver answered with a non-success status, http_status carries that status and error is null.
  • error is set only when the receiver gave no answer, and then holds a short cause (timeout, request failed or invalid webhook destination) while http_status is null.
  • error is null when the event was delivered.
  • An unknown key, and an endpoint you have not set or have deleted, answer 404 NOT_FOUND.

Request​

Responses​

What the receiver answered