POST · Bearer

POST /api/v1/webhooks/:id/test

All endpoints · Markdown

Summary

Send {type:"webhook.test", data:{webhook_id}} to this hook and wait for the response. Returns {delivery:{id, status, response_status, attempts, event_id}}. status is delivered or failed. A disabled hook returns 409 webhook_disabled and sends nothing. Another account's id is 404 webhook_not_found.

Request

{
  "webhook_id": "wh_…"
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 409 webhook_disabled
  • HTTP 404 webhook_not_found

Idempotency

This route does not document Idempotency-Key or client_id.