Alert Channels
Configure external notification channels for deployment events, backup status, and other platform events.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/v1/settings/alerts | List alert channels |
POST | /api/v1/settings/alerts | Create alert channel |
GET | /api/v1/settings/alerts/:id | Get channel by ID |
PUT | /api/v1/settings/alerts/:id | Update channel |
DELETE | /api/v1/settings/alerts/:id | Delete channel |
POST | /api/v1/settings/alerts/:id/test | Send test notification |
POST /api/v1/settings/alerts
{
"name": "Slack Deploys",
"type": "slack",
"config": {
"webhook_url": "https://hooks.slack.com/services/T00/B00/xxx"
},
"events": [
"deployment.success",
"deployment.failure",
"backup.success",
"backup.failure"
]
}Channel Types
| Type | Config Fields |
|---|---|
slack | webhook_url |
discord | webhook_url |
email | recipients (array of emails) |
telegram | bot_token, chat_id |
webhook | url, secret (optional) |
push | No config required (uses registered devices) |
Event Types
| Event | Description |
|---|---|
deployment.success | Deployment completed successfully |
deployment.failure | Deployment failed |
backup.success | Backup completed successfully |
backup.failure | Backup failed |
Last updated on