Webhooks

Replay an endpoint's deliveries

Sends again, once each and now, the endpoint's deliveries made between since and until (within the last 30 days): the failed ones, or every one with status all. Each keeps its webhook-id and goes to the endpoint's url as it is now. Deliveries the endpoint no longer takes are skipped, and those still waiting for a retry are not replayed. Up to 1,000 a call, in the order they were made, and within the team's 5,000 replays an hour (429 once none are left); more says the range holds more, and nextCursor continues after the last one this call looked at. One range at a time: a call while the endpoint's last replay is still being sent answers 409. The endpoint must be enabled.

post/webhooks/{id}/replay

Request

  • Base URL
    https://api.rizamo.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The webhook endpoint's id (wh_).

Headers

Idempotency-Keystring

1 to 255 printable characters, new for each request (a UUID); the body up to 1 MB. For 24 hours a repeat with the same key, path and body gets the first answer, with Idempotent-Replayed: true, instead of running again; 5xx, 409 and 429 answers are not kept. Errors, Retries, has the rest.

Request body

sincestring date-time required

From this moment, included.

untilstring date-time

To this moment, excluded. Now when left out.

status'failed' | 'all'

failed (the default): only deliveries that did not arrive. all: delivered ones too.

cursorstring

nextCursor from the call before, with the same range: continues after the last delivery it looked at.

Response

OK

queuedinteger required

Deliveries sent again now, one attempt each.

skippedinteger required

Deliveries this call looked at that the endpoint no longer takes (its types or profiles changed since): not sent again. Deliveries still waiting for a retry are never in a replay.

moreboolean required

True when the range holds more than this call sent: past its 1,000, or past the team's replays left this hour.

nextCursorstring nullable required

With more: pass it as cursor, with the same range, to continue after the last delivery this call looked at, once this replay is done. Null otherwise.

Changes

No recorded changes to this operation across all 1 revision of this API.