Channel groups Management API reference
Complete reference documentation for the Channel groups resource.
Channel groups
#Channel groups are a way to group channels together to use as a single destination, or to conditionally apply rules to determine which channel(s) should be used.
Endpoints
List channel groups
#Returns a paginated list of channel groups. Note: the list of channel groups is across the entire account, not scoped to an environment.
Endpoint
Query parameters
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of entries to fetch per-page.
Returns
A paginated list of ChannelGroup. Contains a list of entries and page information.
A list of entries.
Rules for determining which channels should be used.
For conditional rules, the value to compare against.
A configured channel, which is a way to route messages to a provider.
The timestamp of when the channel was deleted.
The timestamp of when the channel was created.
Optional URL to a custom icon for the channel. Only used for display purposes in the dashboard.
Optional description of the channel's purpose or usage.
The unique identifier for the channel.
Unique identifier for the channel within a project (immutable once created).
The human-readable name of the channel.
The ID of the provider that this channel uses to deliver messages. Learn more about the providers available in our documentation.
The type of channel, determining what kind of messages it can send.
The timestamp of when the channel was last updated.
The timestamp of when the rule was created.
The order index of this rule within the channel group.
For conditional rules, the operator to apply.
The type of rule (if = conditional, unless = negative conditional, always = always apply).
The timestamp of when the rule was last updated.
For conditional rules, the variable to evaluate.
The type of channels contained in this group.
The timestamp of when the channel group was created.
Unique identifier for the channel group within a project.
The human-readable name of the channel group.
Determines how the channel rules are applied ('any' means any rule can match, 'all' means all rules must match).
Whether this channel group was created by the system or a user. Only user created channel groups can be modified.
The timestamp of when the channel group was last updated.
The information about a paginated result.
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
ChannelGroup
#A group of channels with rules for when they are applicable.
Attributes
Rules for determining which channels should be used.
For conditional rules, the value to compare against.
A configured channel, which is a way to route messages to a provider.
The timestamp of when the channel was deleted.
The timestamp of when the channel was created.
Optional URL to a custom icon for the channel. Only used for display purposes in the dashboard.
Optional description of the channel's purpose or usage.
The unique identifier for the channel.
Unique identifier for the channel within a project (immutable once created).
The human-readable name of the channel.
The ID of the provider that this channel uses to deliver messages. Learn more about the providers available in our documentation.
The type of channel, determining what kind of messages it can send.
The timestamp of when the channel was last updated.
The timestamp of when the rule was created.
The order index of this rule within the channel group.
For conditional rules, the operator to apply.
The type of rule (if = conditional, unless = negative conditional, always = always apply).
The timestamp of when the rule was last updated.
For conditional rules, the variable to evaluate.
The type of channels contained in this group.
The timestamp of when the channel group was created.
Unique identifier for the channel group within a project.
The human-readable name of the channel group.
Determines how the channel rules are applied ('any' means any rule can match, 'all' means all rules must match).
Whether this channel group was created by the system or a user. Only user created channel groups can be modified.
The timestamp of when the channel group was last updated.
ChannelGroupRule
#A rule that determines if a channel should be executed as part of a channel group.
Attributes
For conditional rules, the value to compare against.
A configured channel, which is a way to route messages to a provider.
The timestamp of when the channel was deleted.
The timestamp of when the channel was created.
Optional URL to a custom icon for the channel. Only used for display purposes in the dashboard.
Optional description of the channel's purpose or usage.
The unique identifier for the channel.
Unique identifier for the channel within a project (immutable once created).
The human-readable name of the channel.
The ID of the provider that this channel uses to deliver messages. Learn more about the providers available in our documentation.
The type of channel, determining what kind of messages it can send.
The timestamp of when the channel was last updated.
The timestamp of when the rule was created.
The order index of this rule within the channel group.
For conditional rules, the operator to apply.
The type of rule (if = conditional, unless = negative conditional, always = always apply).
The timestamp of when the rule was last updated.
For conditional rules, the variable to evaluate.