Webhooks

Create a webhook endpoint

Events from now on go to it, of the profiles the person it sends for reaches (onBehalfOf: the caller, or the person behind the API key or agent), and it is deleted when they leave the team. Each event goes as one POST of JSON (the event as List events gives it), signed with Standard Webhooks' headers (webhook-id, the event's id; webhook-timestamp; webhook-signature). A 2xx answer within 15 seconds is delivered; anything else is tried again 6 times over about 18 hours, and a 410 Gone disables the endpoint. After 10 failures in a row an endpoint's deliveries wait while one at a time tries it, and one that keeps failing like that with nothing delivered for 5 days is disabled; Rizamo emails the team's owners and the person it sends for. Never sent to rizamo.com or workers.dev addresses, nor to private ones. Deliveries are not in order: order one resource's events by at. Its signing secret is in the answer, and only there. A team has up to 20 endpoints.

post/webhooks

Request

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

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.

Request body

urlstring required

Where Rizamo sends events: an https address on the public internet.

descriptionstring

What it is for, for the people of the team.

eventsWebhookEventType[] nullable

The event types it receives. Null: every type, those Rizamo adds later included. A key or agent lists the inbox's types (comment.received, message.received, message.sent) only with inbox:read, and comment_automation.* only with automations:read; with null, the endpoint gets none of those it cannot read.

profileIdsstring[] nullable

Only events of these profiles. Null: every profile's, and the events of no profile. Someone limited to some profiles gives some of theirs.

Response

OK

secretstring required

The signing secret (whsec_ and base64), shown only now: keep it where your receiver reads it. Each delivery's webhook-signature is v1, and the base64 HMAC-SHA256, keyed with the base64 after whsec_, of <webhook-id>.<webhook-timestamp>.<body>.

Changes

No recorded changes to this operation across all 1 revision of this API.