Webhooks

Send a test webhook

A delivery of type webhook.test sent now, signed as every delivery is, and its attempt in the answer. It is tried once, never retried, and shows in the deliveries. A disabled endpoint can be tested. A team sends up to 10 tests a minute; more answer 429.

post/webhooks/{id}/test

Request

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

Path parameters

idstring required

The webhook endpoint's id (wh_).

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.