Alert channels API: create, update, and delete channels

Alert channels define where Overwatch sends notifications when a monitor’s status changes. You can configure channels for Slack, Discord, Microsoft Teams, email, and generic webhooks. Once a channel exists, you bind it to one or more monitors by passing alertChannelIds when creating or updating a monitor.

List alert channels

GET /api/v1/alerts

Returns all alert channels in your organization, including which monitors each channel is bound to.

Response

{
  "data": [
    {
      "id": "alc_01j...",
      "name": "Ops Slack",
      "type": "SLACK",
      "config": { "webhookUrl": "https://hooks.slack.com/services/..." },
      "enabled": true,
      "bindings": [
        { "monitorId": "mon_01j...", "alertChannelId": "alc_01j..." }
      ],
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-04-15T10:00:00.000Z"
    }
  ]
}

Example

curl https://overwatchapp.dev/api/v1/alerts \
  -H "Authorization: Bearer $API_KEY"

Create an alert channel

POST /api/v1/alerts

Creates a new alert channel. Requires admin or owner role. Returns 402 if your organization has no active subscription, and 422 with "upgrade": true if you have reached your alert channel limit.

Request body

string

required

Display name for the channel.

string

required

Channel type. One of SLACK, DISCORD, TEAMS, EMAIL, WEBHOOK.

object

required

Type-specific configuration. See Config by channel type below.

boolean

Whether the channel should fire alerts. Defaults to true.

Config by channel type

{
  "webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
}

{
  "webhookUrl": "https://discord.com/api/webhooks/1234567890/XXXXXXXXXXXXXXXX"
}

{
  "webhookUrl": "https://your-org.webhook.office.com/webhookb2/..."
}

{
  "to": "oncall@example.com"
}

{
  "url": "https://api.example.com/overwatch-events",
  "secret": "optional-hmac-secret"
}

For WEBHOOK channels, the optional secret is used to sign outgoing payloads with an HMAC signature so your endpoint can verify requests came from Overwatch.

Response

Returns 201 Created with the new channel object.

{
  "data": {
    "id": "alc_01j...",
    "name": "Ops Slack",
    "type": "SLACK",
    "config": { "webhookUrl": "https://hooks.slack.com/services/..." },
    "enabled": true,
    "createdAt": "2025-04-15T10:00:00.000Z",
    "updatedAt": "2025-04-15T10:00:00.000Z"
  }
}

Example

curl -X POST https://overwatchapp.dev/api/v1/alerts \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ops Slack",
    "type": "SLACK",
    "config": { "webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX" }
  }'

Get an alert channel

GET /api/v1/alerts/:id

Returns a single alert channel by ID, including its monitor bindings.

Path parameters

string

required

The alert channel ID.

Response

{
  "data": {
    "id": "alc_01j...",
    "name": "Ops Slack",
    "type": "SLACK",
    "config": { "webhookUrl": "https://hooks.slack.com/services/..." },
    "enabled": true,
    "bindings": [],
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-04-15T10:00:00.000Z"
  }
}

Example

curl https://overwatchapp.dev/api/v1/alerts/$CHANNEL_ID \
  -H "Authorization: Bearer $API_KEY"

Update an alert channel

PATCH /api/v1/alerts/:id

Updates one or more fields on an alert channel. All body fields are optional. Requires admin or owner role.

Path parameters

string

required

The alert channel ID.

Request body

string

New display name.

object

Updated type-specific configuration. Must match the channel’s existing type.

boolean

Set to false to silence alerts from this channel without deleting it.

Response

Returns the updated channel object with 200 OK.

Example

curl -X PATCH https://overwatchapp.dev/api/v1/alerts/$CHANNEL_ID \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false }'

Delete an alert channel

DELETE /api/v1/alerts/:id

Permanently deletes an alert channel. Any monitor bindings to this channel are also removed. Requires admin or owner role.

Path parameters

string

required

The alert channel ID.

Response

{
  "data": { "id": "alc_01j..." }
}

Example

curl -X DELETE https://overwatchapp.dev/api/v1/alerts/$CHANNEL_ID \
  -H "Authorization: Bearer $API_KEY"

Binding channels to monitors

Alert channels do not fire on their own — you must bind them to at least one monitor. You do this by passing alertChannelIds when creating or updating a monitor:

# Bind a channel when creating a monitor
curl -X POST https://overwatchapp.dev/api/v1/monitors \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "API health",
    "type": "HTTP",
    "config": { "url": "https://api.example.com/health", "interval": 60 },
    "alertChannelIds": ["alc_01j..."]
  }'

# Update bindings on an existing monitor
curl -X PATCH https://overwatchapp.dev/api/v1/monitors/$MONITOR_ID \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "alertChannelIds": ["alc_01j...", "alc_02j..."] }'

Passing alertChannelIds in a PATCH replaces the full set of bindings. To remove all bindings, pass an empty array.

Overview

Endpoints

Alert channels API: create, update, and delete channels

List alert channels

Response

Example

Create an alert channel

Request body

Config by channel type

Response

Example

Get an alert channel

Path parameters

Response

Example

Update an alert channel

Path parameters

Request body

Response

Example

Delete an alert channel

Path parameters

Response

Example

Binding channels to monitors

​List alert channels

​Response

​Example

​Create an alert channel

​Request body

​Config by channel type

​Response

​Example

​Get an alert channel

​Path parameters

​Response

​Example

​Update an alert channel

​Path parameters

​Request body

​Response

​Example

​Delete an alert channel

​Path parameters

​Response

​Example

​Binding channels to monitors

List alert channels

Response

Example

Create an alert channel

Request body

Config by channel type

Response

Example

Get an alert channel

Path parameters

Response

Example

Update an alert channel

Path parameters

Request body

Response

Example

Delete an alert channel

Path parameters

Response

Example

Binding channels to monitors