Webhook
Send project events and monitoring alerts as JSON to any HTTPS endpoint you own, to connect a tool Octri has no card for.
Project events
Send spec uploads, docs publishes, SDK builds and the project's other events to Webhook.
- Open the webhooks
Open Integrations in the project sidebar, choose Webhook under Notifications and paging, then Add a webhook (Manage webhooks once the project has one).
- Add a Generic webhook
Press New webhook, choose Generic, and paste your endpoint's
https://URL. - Pick the events
Forward only what you need, or use Select all. Then press Send test to check a message arrives.
Octri shows a signing secret once, when you create the webhook. Each delivery carries an X-DocsPlatform-Signature header, the HMAC-SHA256 of the body with that secret, so your endpoint can check it came from Octri. Failed deliveries are retried. For every event and the delivery log, see webhooks.
Monitoring alerts
Send error spikes, new issues and regressions from your API's monitoring to Webhook.
- Open the alert rules
Open Monitoring, then the Alerts tab, and create a rule or edit one. The Webhook card on the Integrations page links there too, and lists the rules already using it.
- Choose Webhook as the channel
Pick Webhook and paste your endpoint's URL. Alert channel addresses must be public
https://URLs: Octri refuses a private or internal address.
Each rule has one channel. To reach several places, make a rule for each. See alerts for the rule kinds, windows and cooldowns.
Only project-event webhooks carry a signature. An alert webhook arrives as plain JSON, so give it an address that's hard to guess, and treat what it says as a prompt to look rather than as proof.
The alert body is described in where alerts go.