Send a test event
POST/v1/webhook-endpoints/{endpointId}/test
Queues a ping event to this endpoint alone; it is sent within about 30 seconds. The response is the queued delivery — read its outcome with GET …/deliveries.
Permissions: any valid key · Kind: write · Cost: 1 unit
Cannot be undone.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
endpointId |
uuid | yes |
Body
None.
Response 201
| Field | Type | Required | Description |
|---|---|---|---|
object |
"webhook_delivery" | yes | |
id |
uuid | yes | |
endpointId |
uuid | yes | |
eventId |
uuid | yes | Also the webhook-id header the receiver got. |
eventType |
string | yes | |
status |
"pending" | "sending" | "succeeded" | "failed" | "skipped" | yes | |
attempts |
integer | yes | |
nextAttemptAt |
string | null | yes | When it is tried again; null unless pending. |
lastStatusCode |
integer | null | yes | |
lastError |
string | null | yes | |
lastDurationMs |
integer | null | yes | |
createdAt |
string | yes | |
updatedAt |
string | yes |
Errors
Errors are problem details. Besides the refusals described above, any call like this one can return:
invalid_request— Invalid requestunauthorized— Missing or invalid API keyinsufficient_scope— Missing permissionrate_limited— Rate limit reachednot_found— Not foundidempotency_key_reused— Idempotency-Key reusedrequest_in_progress— Request in progress