Channels mAPI reference
Complete reference documentation for the Channels resource.
Channels
#Channels are the delivery mechanisms for your notifications.
List channels
#Returns a paginated list of channels. Note: the list of channels is across the entire account, not scoped to an environment.
Endpoint
Query parameters
A channel id to filter the results by.
Associated resources to include in the response. Accepts environment_settings to include per-environment channel configuration.
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 Channel. Contains a list of entries and page information.
A list of entries.
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.
Per-environment settings for this channel, keyed by environment slug (e.g., 'development', 'production'). Only included when requested via the include parameter or when retrieving a single channel.
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 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.
Get a channel
#Returns a channel with all environment-specific settings. Secret values in provider settings are obfuscated unless they are Liquid templates (e.g., {{ vars.api_key }}).
Endpoint
Path parameters
The key of the channel to retrieve.
Returns
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.
Per-environment settings for this channel, keyed by environment slug (e.g., 'development', 'production'). Only included when requested via the include parameter or when retrieving a single channel.
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.
Channel
#A configured channel, which is a way to route messages to a provider.
Attributes
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.
Per-environment settings for this channel, keyed by environment slug (e.g., 'development', 'production'). Only included when requested via the include parameter or when retrieving a single channel.
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.
ChannelEnvironmentSettings
#Environment-specific settings for a channel.
Attributes
Channel-type-specific settings (e.g., from_address for email). Structure varies by channel type.
The unique identifier for these environment settings.
Whether the channel is in sandbox mode for this environment. Sandbox mode may prevent actual message delivery.
Whether the channel configuration is valid and ready to send messages in this environment.
Provider-specific settings (e.g., API keys, credentials). Structure varies by provider. Secret values are obfuscated unless they are Liquid templates.
ChatChannelSettings
#Chat channel settings. Only used as configuration as part of a workflow channel step.
Attributes
Whether to resolve chat provider user IDs using a Knock user's email address. Only relevant for Slack channels for the time being.
Whether to track link clicks on chat notifications.
EmailChannelSettings
#Email channel settings. Only used as configuration as part of a workflow channel step.
Attributes
The BCC address on email notifications. Supports liquid.
The CC address on email notifications. Supports liquid.
The email address from which this channel will send. Supports liquid.
The name from which this channel will send. Supports liquid.
A JSON template for any custom overrides to merge into the API payload that is sent to the email provider. Supports liquid.
Whether to track link clicks on email notifications.
Whether to track opens on email notifications.
The Reply-to address on email notifications. Supports liquid.
The email address to which this channel will send. Defaults to recipient.email. Supports liquid.
PushChannelSettings
#Push channel settings. Only used as configuration as part of a workflow channel step.
Attributes
Whether to deregister a push-token when a push send hard bounces. This is to prevent the same token from being used for future pushes.
SmsChannelSettings
#SMS channel settings. Only used as configuration as part of a workflow channel step.
Attributes
Whether to track link clicks on SMS notifications.
InAppFeedChannelSettings
#In-app feed channel settings. Only used as configuration as part of a workflow channel step.
Attributes
Whether to track link clicks on in-app feed notifications.