API reference
Alerts API
Notifications to your team when something needs attention. Price a setting before saving it, verify a destination, connect Telegram, and send a test that looks exactly like a real alert.
Endpoints
9 operations, each with its parameters, schemas and an example request on its own page.
- get/api/alertsList channels — What is connected, what could be, and what each option costs.
- put/api/alertsSave channel — Creates or updates a channel's settings.
- post/api/alerts/estimateEstimate an alert's cost — What a setting would cost, before it is saved.
- post/api/alerts/telegram/connectConnect Telegram — Starts the Telegram flow by handing back a code and a link.
- post/api/alerts/telegram/pollCheck the Telegram connection — Looks for the code in the bot's recent messages.
- delete/api/alerts/{policy_id}Delete channel
- post/api/alerts/{policy_id}/testTest channel — Sends a sample notification, exactly as a real one would look.
- post/api/alerts/{policy_id}/verifyFinish verification — Confirms the code and marks the channel live.
- post/api/alerts/{policy_id}/verify/startStart verification — Sends a code to the destination itself.
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.