SPspectate
Channels

Get a channel

Returns the channel with its delivery health. Secrets in its settings are never returned.

get/channels/{channel}

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

channelstring uuid required

Channel ID.

Response

The channel.

idstring uuid required

Channel ID

namestring required

Name shown in escalation paths

type'email' | 'slack' | 'discord' | 'microsoft_teams' | 'telegram' | 'webhook' | 'pushover' | 'sms' | 'voice' required
enabledboolean required

Whether the channel delivers. false when a member turned it off or Spectate did after repeated failures (auto_disabled)

auto_disabledboolean required

Whether Spectate turned the channel off because deliveries kept failing. Fix the cause, then enable it or send a test with enable

disabled_atstring date-time nullable required

When the channel was turned off automatically

disabled_reasonstring nullable required

Why it was turned off automatically

consecutive_failuresinteger required

Failed deliveries since the last successful one

failing_sincestring date-time nullable required

Since when deliveries fail

last_failure_atstring date-time nullable required

When a delivery last failed

last_failure_reasonstring nullable required

Why the last delivery failed

last_delivered_atstring date-time nullable required

When a delivery last succeeded

created_atstring date-time required

When the channel was created

Example response

{
  "name": "On-call email",
  "email": {
    "address": "oncall@example.com"
  },
  "slack": {
    "channel": "C0123456789",
    "channel_name": "#alerts"
  },
  "telegram": {
    "chat_id": "-1001234567890",
    "chat_title": "Ops alerts"
  },
  "webhook": {
    "host": "hooks.example.com"
  },
  "pushover": {
    "user_key": "uQiRzpo4DXghDmr9QzzfQu27cmVRsG",
    "priority": 1
  },
  "sms": {
    "phone_number": "+31612345678"
  },
  "voice": {
    "phone_number": "+31612345678"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.