Queue every settled delivery a filter selects to be delivered again

Replays every settled delivery the filter selects, up to the per-request cap. This is the recovery path after an outage at the receiving end. At least one filter is required; an empty body returns 400. The five filters are the same ones the history endpoint accepts, so an organisation can review a page and then replay exactly what it saw.

This form is lenient, where the single-event form is strict. A delivery that cannot be replayed is reported in skipped with the reason, and the rest are still queued. A status or webhookId filter applies to each delivery's latest generation, so status=PARKED means the deliveries that are parked now.

A single call queues at most 500 events and examines at most 2000 looking for them. Only an event that yields something to queue counts against the cap. truncated: true means the call stopped with matches still unqueued, and calling again makes progress rather than repeating itself.

Separately, an organisation may queue at most 1000 replays per hour; exceeding that returns 429 Too Many Requests and queues nothing. status=PARKED is the usual filter after an outage. It selects the deliveries that exhausted their attempts while the destination was down, and leaves alone anything still working through the ladder.

Body Params

Which settled deliveries to replay. At least one field is required; an empty body returns 400. The fields are the history endpoint's filters, so a page can be reviewed and then replayed with the same values.

string
enum

A subscribable event type. An unrecognised value is rejected with a 400 naming every offender.

string

Inclusive lower bound on occurredAt, as an ISO-8601 instant. The old space-separated format is still accepted.

string

Exclusive upper bound on occurredAt. Same accepted formats as from.

string
enum

PENDING: queued, not yet attempted. RETRY_PENDING: attempted, failed, waiting for its next attempt. DELIVERED: accepted by the destination. PARKED: given up on after exhausting the attempt budget. CANCELLED: the destination was deleted before the delivery was sent.
The first two are queued, the last three settled, and only a settled latest generation may be replayed.

Allowed:
uuid

Only deliveries to this destination.

Headers
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.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json