Skip to main content
POST
Replay an event

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

Idempotency-Key
string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255
X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

event_id
string
required

Event id.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

Which endpoints to replay to.

webhook_ids
string[]

Endpoints (same mode, enabled). Omit to replay to every enabled endpoint subscribed to the event type.

Required array length: 1 - 20 elements
Pattern: ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Response

Deliveries queued.

Deliveries queued by a replay.

object
string
required

Always event_replay.

Allowed value: "event_replay"
event_id
string
required

Event.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
deliveries
object[]
required

New deliveries, status pending.