Skip to main content
POST
← Webhooks Send a signed webhook.test event to the endpoint now and get the result in the response: one attempt, no retries. It works on disabled endpoints too, so you can check your fix before re-enabling. The delivery shows up in the delivery log.
Beta. Part of the webhooks API, currently in beta. The contract may still change before general availability.

Request

Headers

string
required
API key of an organization admin.Example: sk_live_1234567890abcdef
string
required
The organization that owns the endpoints.Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

uuid
required
The endpoint id.Example: 5c9e2f14-8b7a-4d3e-9f60-1a2b3c4d5e6f

Response

The delivery (200 OK), whether your server accepted it or not. Check status and last_status_code:
uuid
Delivery id.
uuid
The payload id, the same on every retry and for every endpoint that got the event.
string
ingest_job.finished or webhook.test.
string
Available values: pending (being sent or waiting for a retry), succeeded (got a 2xx), failed (retries exhausted, or the endpoint was disabled).
integer
Attempts so far (at most 7).
datetime | null
When the next retry is due (UTC), while pending.
datetime | null
UTC.
integer | null
HTTP status your server answered; null on a timeout or network error.
string | null
Why the last attempt failed, e.g. HTTP 503 or a connection error.
integer | null
How long the last attempt took.
datetime | null
When your server answered 2xx (UTC).
datetime
When the event was recorded (UTC).
object
The exact JSON body sent. See Events.

Common Errors

401 Unauthorized

Missing or invalid API key.

403 Forbidden

ORG_ADMIN_REQUIRED: only organization admins can manage webhook endpoints. LOGGED_USER_NOT_MEMBER: the API key’s user is not a member of the organization.

404 Not Found

The endpoint does not exist or belongs to another organization. Both cases return the same response.

List Webhook Deliveries

Every delivery

Webhooks

Verify the signature