Notification Channels

List channel types available to your account

The same catalogue as the project-level types endpoint, without needing a project — useful before your first project exists. Only types with available: true can deliver today; hide entries marked deprecated.

{
    "data": [
      { "type": "email", "label": "Email", "available": true, "deprecated": false, "secret_fields": [] },
      { "type": "webhook", "label": "Webhook", "available": true, "deprecated": false, "secret_fields": ["secret"] },
      { "type": "whatsapp", "label": "WhatsApp", "available": true, "deprecated": false, "secret_fields": [] },
      { "type": "telegram_official", "label": "Telegram (EndlessAI bot)", "available": true, "deprecated": false, "secret_fields": [] },
      { "type": "slack_app", "label": "Slack App", "available": true, "deprecated": false, "secret_fields": ["bot_token", "signing_secret"] }
    ],
    "capabilities": { "slack_official": true, "telegram_official": true }
  }

The list is abbreviated here.

List channel types for a project

Same shape as /notifications/capabilities, scoped to a project you can access.

List channels

Returns every channel that delivers for this project, including personal channels shared across your projects. Secrets are masked.

{
    "data": [
      {
        "id": "CHANNEL_ID",
        "project_id": "PROJECT_ID",
        "type": "email",
        "name": "Night shift",
        "config": { "to": ["security@company.com"] },
        "min_severity": "medium",
        "events": ["alert.created", "alert.confirmed"],
        "broadcast_mode": "all",
        "enabled": true,
        "scope": "project",
        "created_at": "2026-10-01T09:12:00.000Z"
      }
    ]
  }

Create a channel

{
    "type": "email",
    "name": "Night shift",
    "config": { "to": ["security@company.com"] },
    "min_severity": "medium",
    "events": ["alert.created", "alert.confirmed"],
    "broadcast_mode": "all",
    "connect_existing_alerts": true
  }

curl -X POST https://platform.endlessai.com/api/v1/projects/PROJECT_ID/notifications/channels \
    -H "X-Api-Key: YOUR_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "type": "email",
      "name": "Night shift",
      "config": { "to": ["security@company.com"] },
      "min_severity": "medium"
    }'

import requests

  resp = requests.post(
      f"{BASE}/projects/{PROJECT_ID}/notifications/channels",
      headers={"X-Api-Key": API_KEY, "Content-Type": "application/json"},
      json={
          "type": "email",
          "name": "Night shift",
          "config": {"to": ["security@company.com"]},
          "min_severity": "medium"
      },
  )
  channel = resp.json()["data"]
  print(channel["id"])

const res = await fetch(
    `${BASE}/projects/${PROJECT_ID}/notifications/channels`,
    {
      method: "POST",
      headers: { "X-Api-Key": API_KEY, "Content-Type": "application/json" },
      body: JSON.stringify({
        type: "email",
        name: "Night shift",
        config: { to: ["security@company.com"] },
        min_severity: "medium"
      })
    }
  );
  const { data: channel } = await res.json();

{
    "data": { "id": "CHANNEL_ID", "type": "email", "name": "Night shift", "enabled": true },
    "connected_alert_rules": 2,
    "attached_jobs": 0
  }

Update a channel

Send only the fields to change: name, config, min_severity, events, broadcast_mode, enabled. A masked secret sent back unchanged keeps the stored value. A personal channel can be changed only by the person who connected it.

{ "min_severity": "high", "enabled": true }

Delete a channel

Also unlinks any chat bound to the channel.

{ "id": "CHANNEL_ID", "deleted": true }

Get the linked chat

For a chat channel (WhatsApp, Telegram, Slack): whether a chat is linked, and which one.

{
    "data": {
      "configured": true,
      "connected": true,
      "platform": "telegram_official",
      "chat_title": "Warehouse team",
      "bound_at": "2026-10-02T08:30:00.000Z",
      "enabled": true
    }
  }

Unlink the chat

Unlinks the chat but keeps the channel and its settings, ready to link again.

Override a shared channel for this project

A personal channel reaches several projects; its own settings are the defaults. Use this to change how it behaves for this project only. Set a field to null to go back to the default.

{
    "min_severity": "high",
    "events": ["alert.confirmed"],
    "scan_summaries": "short",
    "muted": false
  }

scan_summaries: full, short or off. muted: true stops this project's alerts reaching the channel.

Remove this project's override

{ "data": { "cleared": true } }

Count projects with their own override

{ "data": { "count": 2 } }

Apply the channel defaults everywhere

Removes every project's override so the defaults apply.

{ "data": { "removed": 2 } }

List recent deliveries

Newest first. Query param: limit (1-100, default 20). The examples show selected response fields.

{
    "data": [
      {
        "id": "DELIVERY_ID",
        "channel_id": "CHANNEL_ID",
        "alert_id": "ALERT_ID",
        "event": "alert.created",
        "status": "sent",
        "attempts": 1,
        "sent_at": "2026-10-03T22:14:05.000Z",
        "created_at": "2026-10-03T22:14:02.000Z"
      }
    ]
  }