Send a synthetic test delivery

Server URLloading...

POST

/v1/webhooks/{id}/test

Send

Authorization

Send a synthetic webhook.test event to the endpoint and return the delivery outcome (success, retry, or dead) in the response. The signing scheme, headers, and envelope are identical to a real delivery, so this is the right way to validate your HMAC verifier and TLS setup before subscribing to live events.

You cannot subscribe to webhook.test. The test endpoint always fires it regardless of which events the endpoint is subscribed to. The test delivery is recorded so you can review the result afterward from /v1/webhooks/deliveries.

Requires the webhooks:write scope.

Path Parameters

Response Body

curl -X POST "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test"

{
  "event_id": "evt_018f2d0c-7a4c-7f3e-8f1f-3a2b9c1d2e0f",
  "outcome": "success",
  "url": "https://hooks.example.com/y3labs/ops",
  "response_status": 200,
  "response_time_ms": 142,
  "response_body_excerpt": "{\"ok\":true}",
  "error": null
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "authentication failed",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "missing required scope",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "not found",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}