Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-05730512.7 KB
Webhooks

Send a test event

Enqueue a signed webhook.test event to the endpoint so you can confirm your receiver verifies the signature and returns 2xx. Returns the delivery record for the test event.

post/v1/webhooks/{uuid}/test

Path parameters

uuidstring uuid required

UUID of the webhook endpoint to test.

Response

The test event was enqueued for delivery.

idstring uuid

You receive the UUID for this delivery attempt.

endpoint_idstring uuid

You receive the UUID of the endpoint this delivery targeted.

endpoint_labelstring

You receive the label of the endpoint this delivery targeted.

event_typestring

You receive the event type that was delivered.

event_idstring

You receive the unique event identifier carried in the payload.

request_urlstring uri

You receive the URL the delivery was POSTed to.

response_statusinteger nullable

You receive the HTTP status code returned by the endpoint, or null when the request never completed.

response_time_msinteger nullable

You receive the round-trip time in milliseconds, or null when the request never completed.

statusstring

You receive the delivery status (for example delivered, failed, or pending).

retriesinteger

You receive the number of retry attempts made for this delivery.

last_retry_atstring date-time nullable

You receive the timestamp of the most recent retry, or null when there was none.

created_atstring date-time

You receive the timestamp when the delivery was enqueued.

Example response

{
  "id": "c9a1b2c3-d4e5-6f70-8192-a3b4c5d6e7f8",
  "endpoint_id": "b8f0f4a2-2b1e-4b3a-9d0e-4a1c2d3e4f50",
  "endpoint_label": "Production events",
  "event_type": "credential.issued",
  "event_id": "evt_9f3c1a20b7",
  "request_url": "https://api.acme.example/webhooks/didit",
  "response_status": 200,
  "response_time_ms": 142,
  "status": "delivered",
  "created_at": "2026-07-02T23:51:58.746686+00:00"
}