Skip to main content
POST
Replay a webhook event

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Body

application/json

Provide at least one identifier. If event_id is provided, that exact event is replayed. Otherwise, the replay target is resolved by charge_id or reference.

event_id
string
required

Webhook event ID to replay directly.

charge_id
string

Charge ID used to resolve the latest webhook event for that charge.

reference
string

Checkout reference used to resolve charge and replay latest webhook event.

Response

Success - replay request accepted and a new delivery attempt was created.

event_id
string
required

The event that was replayed. It keeps its original ID, so a replay is a fresh delivery of the same event rather than a new event.

Example:

"evt_3ab4e0d5d27445cf8a52ab3d8cb8f0b1"

attempt_id
string
required

The delivery attempt this replay created. Look it up to see whether the delivery succeeded.

Example:

"wha_6f1e40f6bdf84c1980e1e1f6407f3f8a"

attempt_no
integer
required

Which attempt this is for the event, counting every earlier automatic retry.

Example:

3

event_type
string
required

The type of the event that was replayed, the same value your endpoint receives in the payload.

Example:

"collection.failed"