Webhooks

Replay a webhook delivery

Sends a delivery again, once and now, through the queue: the body it sent before (made from its event when it never went), signed anew, with the same webhook-id (the event's id), so a receiver that has it already can skip it. One more attempt, to the endpoint's url as it is now, never retried; it shows among the delivery's attempts. The endpoint must still take the event (its types and profiles now) and be enabled. A delivery still waiting for a retry is refused: it goes on its own. A team replays up to 5,000 deliveries an hour, one at a time and by range together; more answer 429.

post/webhooks/deliveries/{id}/replay

Request

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

Path parameters

idstring required

The webhook delivery's id (whd_).

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.

Response

OK

idstring required
endpointIdstring required
eventIdstring nullable required

The event it carries, as List events gives it and as webhook-id names it. Null for a test.

status'pending' | 'retrying' | 'delivered' | 'failed' required

pending: not tried yet. retrying: tried, and tried again at nextAttemptAt. delivered: an attempt got a 2xx. failed: Rizamo stopped trying (all retries used, a 410, an address it does not send to, the endpoint disabled or no longer taking the event, or a delivery it could not prepare).

nextAttemptAtstring date-time nullable required
heldboolean required

Waiting for its endpoint to answer again (breaker open), with no time set: it goes once an attempt to the endpoint is delivered, or as the breaker's next try.

deliveredAtstring date-time nullable required
createdAtstring date-time required
payloadstring nullable required

The body as sent, JSON: the event as List events gives it. Null until the first attempt.

Changes

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