Replay a stored event to your webhooks

POST/events/{eventId}/replay

Re-enqueues one event from your feed to every active subscription that accepts its mode, with the STORED envelope verbatim — same id, so a receiver that dedupes on X-PS-Event-Id sees the same logical event again rather than a new one. This is the push half of the catch-up loop GET /v1/events is the pull half of: after an outage, read what you missed, then replay what your endpoint needs to process. Visibility follows the feed exactly — an event on the other side of your key's test/live line is a 404, and account-level events replay to both sides. enqueued: 0 is an honest answer meaning no active subscription accepts this event's mode; the fix is a webhook, not a retry.

Credential: An API key in x-api-key
Scopes: webhooks:manage

Parameters

eventIdpath · stringrequired
The event_id from GET /v1/events — the envelope's id, the X-PS-Event-Id value.
Idempotency-Keyheader · string (uuid)
Unique key for idempotent requests. If you retry a request with the same key within 24 hours, you receive the original response. The key is bound to the request payload: reusing it for a different payload returns 422 idempotency_key_reuse rather than the original response, so a changed request is never silently dropped. The binding is over the JSON's content, not its bytes — keys in another order or other whitespace are the same request. Generate a new key for each new request. On an operation that moves money (an order, a batch, an item, a shipping or address change, a cancellation's refund), a key that cannot be checked because the idempotency ledger is unreachable is answered 503 idempotency_unavailable with Retry-After, and nothing runs or is charged: retry with the same key.

Request

Try it

POST /api/v1/events/{eventId}/replay

curl -X POST "https://portal.printedsimply.com/api/v1/events/evt_F5S_u7olBRx4IBTVZNXoH-8d/replay" \
  -H "x-api-key: ps_test_YOUR_KEY" \
  -H "Idempotency-Key: replay-event-$(date +%s)"

Response `200`

Replay result: the event name, its event_id, and how many queue rows were enqueued.

data

replayedboolean
eventstring
One of order.created order.paid order.in_production order.shipped order.delivered order.cancelled order.failed order.updated order.rerouted order.quality_check order.issue order.approval_requested order.approval_approved order.approval_declined order.approval_expired campaign.opened campaign.order_added campaign.closed campaign.batch_in_production campaign.completed design.proof_sent design.changes_requested design.approved return.requested return.approved return.remake_created return.resolved return.rejected drop.opened drop.sale drop.closed drop.sold_out checkout_link.sale gift.claimed gift.expired product.updated catalog.synced webhook.disabled autopilot.run.created autopilot.run.awaiting_approval autopilot.run.completed autopilot.run.failed autopilot.run.cancelled design_run.item_ready design_run.completed guarantee.issued guarantee.honored guarantee.breached guarantee.remedied test.ping
event_idstring | null
enqueuedinteger
How many subscriptions the replay was queued to. Zero is an honest answer: no active subscription accepts this event’s mode, and the fix is a webhook rather than a retry.

meta

pageinteger
totalinteger
limitinteger
The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.
pagesinteger
total over limit, rounded up.
next_cursorstring | null
On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.
has_moreboolean
On a list operation whose meta is ListMeta: whether another page follows this one.

Example response

{
  "status": "success",
  "data": {
    "replayed": true,
    "event": "order.cancelled",
    "event_id": "evt_F5S_u7olBRx4IBTVZNXoH-8d",
    "enqueued": 1
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

401invalid_api_key missing_api_key key_expired
Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).
404
Resource not found
429rate_limit_exceeded daily_quota_exceeded
Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

Every Webhooks operation

Parameters

eventIdpath · stringrequired

The event_id from GET /v1/events — the envelope's id, the X-PS-Event-Id value.

Idempotency-Keyheader · string (uuid)

Unique key for idempotent requests. If you retry a request with the same key within 24 hours, you receive the original response. The key is bound to the request payload: reusing it for a different payload returns 422 idempotency_key_reuse rather than the original response, so a changed request is never silently dropped. The binding is over the JSON's content, not its bytes — keys in another order or other whitespace are the same request. Generate a new key for each new request. On an operation that moves money (an order, a batch, an item, a shipping or address change, a cancellation's refund), a key that cannot be checked because the idempotency ledger is unreachable is answered 503 idempotency_unavailable with Retry-After, and nothing runs or is charged: retry with the same key.

Response 200

Replay result: the event name, its event_id, and how many queue rows were enqueued.

data

replayedboolean
eventstring
One of order.created order.paid order.in_production order.shipped order.delivered order.cancelled order.failed order.updated order.rerouted order.quality_check order.issue order.approval_requested order.approval_approved order.approval_declined order.approval_expired campaign.opened campaign.order_added campaign.closed campaign.batch_in_production campaign.completed design.proof_sent design.changes_requested design.approved return.requested return.approved return.remake_created return.resolved return.rejected drop.opened drop.sale drop.closed drop.sold_out checkout_link.sale gift.claimed gift.expired product.updated catalog.synced webhook.disabled autopilot.run.created autopilot.run.awaiting_approval autopilot.run.completed autopilot.run.failed autopilot.run.cancelled design_run.item_ready design_run.completed guarantee.issued guarantee.honored guarantee.breached guarantee.remedied test.ping
event_idstring | null
enqueuedinteger
How many subscriptions the replay was queued to. Zero is an honest answer: no active subscription accepts this event’s mode, and the fix is a webhook rather than a retry.

meta

pageinteger
totalinteger
limitinteger
The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.
pagesinteger
total over limit, rounded up.
next_cursorstring | null
On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.
has_moreboolean
On a list operation whose meta is ListMeta: whether another page follows this one.

Example response

{
  "status": "success",
  "data": {
    "replayed": true,
    "event": "order.cancelled",
    "event_id": "evt_F5S_u7olBRx4IBTVZNXoH-8d",
    "enqueued": 1
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

401invalid_api_key missing_api_key key_expired

Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).

404

Resource not found

429rate_limit_exceeded daily_quota_exceeded

Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

Replay a stored event to your webhooks

Parameters

Request

Response 200

Errors

Replay a stored event to your webhooks

Parameters

Request

Response 200

Errors

Response `200`

Response `200`