Queue one event to be delivered again

post

https://api.qfp.quantnetwork.net/api/webhook-events/{id}/redeliver

Queues one event for redelivery, either to every destination that received it or to the single destination named in the body.

Replay history

A replay creates a new delivery at the next generation, PENDING, with attempts back to zero. The existing delivery is never modified, so the record of the first attempt survives.

Eligible deliveries

Only a delivery whose latest generation has settled may be replayed. DELIVERED, PARKED and CANCELLED are settled; PENDING and RETRY_PENDING mean one is already on its way, and asking for another returns 409 Conflict.

Failure handling

This form is strict: anything that cannot be replayed fails the whole call. Use the filtered form for a lenient replay.

Destination status

A deleted destination returns 404 Not Found; an INACTIVE one returns 409 Conflict. SUSPENDED is allowed, and the delivery flows when the destination returns to service.

Optional body

The body is optional. Omit it, or send {}, to replay to every destination that received the event.

Path Params

uuid

required

The event's identifier, as the delivery carried it and as history returns it.

Body Params

Which destination to replay to. The whole body is optional; omitting it, or sending {}, replays to every destination that received the event.

webhookId

uuid

One of the organisation's destinations that received this event. Omit to replay to all of them. A destination that never received the event returns 404.

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Idempotency-Key

string

required

Caller-supplied key making the write at-most-once. Required on every POST and PATCH; DELETE does not take one. A missing or blank header returns 400.
Replaying a key whose first request has finished returns that first response unchanged, with Idempotency-Replayed: true and the original Location where there was one. Sending a different body under the same key also returns the first response; the new body is ignored.
While the first request is still running, the same key returns 409 Conflict.
A key is only held once the request has succeeded. A write that fails releases it, so the same key can be used again for a retry.
A key is scoped to the caller and the operation: the organisation, the user, the HTTP method and the request path. The same value sent to a different endpoint, or by a different user in the same organisation, is a new request rather than a replay. There is no length limit.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Queued. The deliveries are written and waiting to be sent, which is why this is a 202 and not a 200.

400The request failed validation. message names the offending field rather than the specific constraint.

401Returned once authentication is enforced, when the request carries no Authorization header or an unresolvable token. (planned — not returned today, see the API description.)

404No such event, no delivery of it to the named destination, or a destination that has been deleted.

409The event exists but cannot be replayed in its current state, or the same Idempotency-Key is still in flight. Each case is expected to change: a queued delivery settles, an inactive destination can be reactivated, and a racing replay finishes.

429The organisation has queued its allowance of replays for the current window. Nothing was queued by the refused call.

500An unexpected error occurred while handling the request.