Send one signed test delivery now, and return the outcome

post

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

Sends a test delivery to the registration's URL immediately and answers with what happened. The response is 200 rather than 202, because the attempt has already been made.

Signature and delivery history

The test is a real delivery in every respect but its type. It carries the webhook.test event type and is signed under the registration's own scheme with the same headers as any delivery, so verification proven against it holds for real events. It appears in delivery history, can be read by id, and can be replayed.

Retries and suspension

A failed test is not discarded. It joins the ordinary retry ladder and counts toward endpoint suspension.

Registration status

An INACTIVE registration returns 409 Conflict. SUSPENDED is allowed, and a successful test resets the consecutive-failure count.

Automatic test delivery

A test delivery is also queued automatically when a registration is created.

Recipes

Receive and verify an HMAC webhook

Open Recipe

Path Params

uuid

required

The registration's identifier.

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 attempt's outcome, as delivery history will show it. status distinguishes success from failure; failureClass distinguishes an unreachable endpoint from one that answered and rejected.

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.

409The registration is INACTIVE, or an earlier request with the same Idempotency-Key is still running.

500An unexpected error occurred while handling the request.