Skip to main content
POST
Create a webhook
Register a public HTTPS endpoint to receive Comms events. Scope: comms_webhooks

Request

Body parameters

string
required
HTTPS URL that accepts POST requests.
string[]
Event names to subscribe to (for example comms.message.received, comms.message.edited, comms.message.sent). Omit to subscribe to every comms event.

Response

201 Created
secret is generated server-side and used to sign every delivery: each webhook POST carries X-Osis-Signature: sha256=<hex>, an HMAC-SHA256 of the raw request body keyed with this secret. Store it where your handler runs and verify each request — see Verify signatures. If you lose it, list webhooks returns it again.

See also