Last updated

Testing your integration

Use the test endpoint to send a synthetic signed delivery to your endpoint at any time — without creating a real event in history.

POST /v1/webhooks/subscriptions/{id}/test

Behavior

  • Synchronous — the API response contains the HTTP status and latency from your endpoint
  • Not recorded in event or delivery history
  • Uses the same signature headers as real deliveries — exercises your full verification path
  • Carries X-Webhook-Test: true so your handler can short-circuit it if needed

Test payload sent to your endpoint

{
  "id":          "test-event-uuid",
  "type":        "webhook.test",
  "occurredAt":  "2026-04-20T10:00:00.000Z",
  "data": {
    "subscriptionId": "a1b2c3d4-...",
    "message":        "This is a test webhook delivery from Jeeves."
  }
}

API response

{
  "result":        "success",
  "httpStatusCode": 200,
  "latencyMs":      143
}

result is success when your endpoint returns 2xx and failed otherwise. On failure, errorMessage is included.