Skip to main content
POST
Send an event to an endpoint again

Authorizations

Authorization
string
header
required

An organization API key. Keys carry a role (read_write or read_only) and may be restricted to a namespace prefix such as acme/*, or to one namespace such as acme/prod/tenant_1. A prefix matches on a / boundary: acme/prod/tenant_1* covers acme/prod/tenant_1 and everything under acme/prod/tenant_1/, never acme/prod/tenant_12.

Headers

Idempotency-Key
string

One key per logical request, reused only on its retries. A key belongs to one request: within your organization, the same method, path, query and body. For 24 hours after a successful response, a request with the key and the same body gets that response back verbatim, with Idempotent-Replayed: true, and runs nothing. Only a successful response is kept, so the retry of a request that failed runs again. While the first request runs or its response is kept, the key with a different request is idempotency_key_reused (422). A request sent while one with its key is still running is rate_limited with Retry-After: 1, without running: retry it to get the first one's response. In the rare case the key can't be checked, the request runs as if it had none.

Required string length: 1 - 255

Path Parameters

id
string
required

Also the webhook-id header.

Pattern: ^evt_[0-9a-z]{26}$

Body

application/json
endpoint
string
required
Pattern: ^we_[0-9a-z]{26}$

Response

The delivery, queued.

One event sent to one endpoint, with its attempts so far and the last one's result.

id
string
required
Pattern: ^dlv_[0-9a-z]{26}$
event_id
string
required

Also the webhook-id header.

Pattern: ^evt_[0-9a-z]{26}$
event_type
enum<string>
required
Available options:
subscription.entered,
subscription.exited,
subscription.synced,
job.awaiting_confirm,
job.completed,
job.failed,
namespace.budget_paused,
namespace.budget_resumed,
judgment.limit_reached,
judgment.taxonomy_drift,
namespace.tenant_summary_failed,
webhook.test
endpoint
string
required
Pattern: ^we_[0-9a-z]{26}$
status
enum<string>
required

pending: waiting for its next attempt. succeeded: a 2xx. failed: every retry, over about 3 days, failed. skipped: the endpoint was disabled. Failed and skipped deliveries can be sent again with recover or redeliver.

Available options:
pending,
succeeded,
failed,
skipped
attempts
integer
required
Required range: x >= 0
next_attempt_at
string<date-time> | null
required

When it is next tried, while pending.

created_at
string<date-time>
required

RFC 3339, UTC.

last_attempt
object | null
required

Null before the first attempt.