Skip to main content

channelsList

Returns every notification channel (email address, API URL, Slack channel, or Zapier) set up for one site, optionally filtered by type, sorted by destination ascending by default and without pagination. Pass a channel's id as channelId to notificationCreate or notificationEdit. Requires notifications navigation access.

channelsList(
  siteId: Int!
  type: ChannelType
  order: ChannelListOrder
): [Channel!]!

Arguments​

channelsList.siteId ● Int! non-null scalar​

Site id from sites.

channelsList.type ● ChannelType enum​

Optional delivery channel type filter; omit to include every type.

channelsList.order ● ChannelListOrder input​

Sort descriptor; defaults to destination ascending.

Type​

Channel object​

Site-scoped notification delivery destination returned by channelsList and a notification's channel.