Unstatus API

Notification Channels

Manage notification channels for alerts.

Notification channels send alerts via Discord webhooks or email when events occur.

List Channels

GET/api/v1/notificationsAuthenticated
curl https://unstatus.app/api/v1/notifications \
  -H "Authorization: Bearer usk_your_key"
Response
{
  "data": [
    {
      "id": "nc_...",
      "name": "Engineering Discord",
      "type": "discord",
      "webhookUrl": "https://discord.com/api/webhooks/...",
      "enabled": true,
      "onMonitorDown": true,
      "onMonitorRecovered": true,
      "onIncidentCreated": true,
      "onIncidentResolved": true,
      "onIncidentUpdated": true,
      "onMaintenanceScheduled": true,
      "onMaintenanceStarted": true,
      "onMaintenanceCompleted": true
    }
  ],
  "pagination": { "total": 1, "limit": 20, "offset": 0, "hasMore": false }
}

Create Channel

POST/api/v1/notificationsAuthenticated
FieldTypeRequiredDescription
namestringYesChannel name
typestringYesdiscord or email
webhookUrlstringDiscordDiscord webhook URL
recipientEmailstringEmailComma-separated emails
onMonitorDownbooleanNoAlert on monitor down (default true)
onMonitorRecoveredbooleanNoAlert on recovery (default true)
onIncidentCreatedbooleanNoAlert on new incident (default true)
onIncidentResolvedbooleanNoAlert on resolution (default true)
onIncidentUpdatedbooleanNoAlert on updates (default true)
onMaintenanceScheduledbooleanNoAlert on scheduled maintenance (default true)
onMaintenanceStartedbooleanNoAlert on maintenance start (default true)
onMaintenanceCompletedbooleanNoAlert on completion (default true)
curl -X POST https://unstatus.app/api/v1/notifications \
  -H "Authorization: Bearer usk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Engineering Discord",
    "type": "discord",
    "webhookUrl": "https://discord.com/api/webhooks/..."
  }'

Update Channel

PATCH/api/v1/notifications/:idAuthenticated

Delete Channel

DELETE/api/v1/notifications/:idAuthenticated

On this page