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

Returns the original response verbatim while the node still caches it. Correctness never depends on it.

Minimum string length: 1

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,
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.