Channels

List notification channels

GET/v1/channels

Channel secrets (bot tokens, webhook URLs and secrets) are never returned; target is masked.

Authentication
API key (Authorization: Bearer)
Required scope
read

Query parameters#

  • limitinteger
    Default 50
    1 to 100
  • cursorstring

    Opaque next_cursor of the previous page.

Responses#

200One page of channels.
Object fields
  • dataarray of objectrequired
    Fields of each item
    • idstring · uuid
    • kindstring
      Values webhook discord slack email telegram hellome
    • namestringnullable
    • statestring
      Values active disabled
    • rolestring
      Values alerts escalation
    • targetstringnullable

      Masked destination, e.g. https://hooks.example.com/aicscan, a***@example.com.

    • created_atstring · date-time
    • disabled_atstring · date-timenullable
    • disabled_reasonstringnullable
    • last_success_atstring · date-timenullable
    • linked_atstring · date-timenullable
  • has_morebooleanrequired
  • next_cursorstringrequirednullable
4xx · 5xxError.

Standard error format: see Errors.