Change a registration's status or subscribed event types

patch

https://api.qfp.quantnetwork.net/api/webhooks/{id}

Changes a registration's status, its subscribed event types, or both. An omitted field is left alone, so sending only status does not touch the subscriptions.

Subscriptions

An empty eventTypes array is not the same as omitting it. [] subscribes the registration to nothing while leaving it in place, which is distinct from deleting it.
Subscriptions are replaced wholesale, never merged, and take effect from that moment on. Past events are not backfilled.

Changing the destination

The URL is not updatable. Changing where events go is a delete and a fresh registration, which yields a new identifier and a new secret.

Status and suspension

SUSPENDED cannot be requested; the platform sets it after repeated delivery failures. Setting ACTIVE clears both the suspension timestamp and the failure count, whatever the previous status was.

Path Params

uuid

required

The registration's identifier.

Body Params

A change to an existing registration. Every field is optional, and an omitted field is left alone. The URL is not updatable.

status

string

enum

The status to move to. SUSPENDED is rejected; the platform sets it. Accepted case-insensitively.

Allowed:

eventTypes

array of objects

length ≤ 100

Replaces the subscribed set wholesale. Omit to leave subscriptions untouched; send [] to subscribe to nothing.

eventTypes

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

200The updated registration.

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 registration exists with that identifier, or it has been deleted.

409An earlier request with the same Idempotency-Key is still running. Retry once it has finished.

500An unexpected error occurred while handling the request.