Channels
A channel is a destination an alert can be sent to: an email address, or a messaging integration. Channels are registered once here and then chosen by name when an alert is defined, so the same destination can serve many alerts.
This page is Settings > Channels. It is distinct from Settings > Notification Channels, which belongs to alerting and is described in Notification channels.
Before you begin
- The details of the destination: the address for an email channel, or the connection details the messaging integration requires. The fields Engage asks for depend on the channel type and are supplied by the server, so they are not listed here.
Open the channels page
Select Settings > Channels. The table lists each channel's Name, Description, and Type, with an action menu offering Edit and Delete. The search box filters by name, description, or type. An organisation with none shows No channels.
Create a channel
- Select Create Channel. The Create Channel drawer opens, headed Channel details. The drawer notes that the channel is created for the current tenant.
- Enter a Name.
- In Select channel type, choose the type. The available types are defined by the Engage server; email and a messaging integration are the ones the interface is built around.
- Optionally enter a Description.
- Complete the fields that appear below for the chosen type. A required field is marked as such, and a field that must match a pattern says so if the value does not.
- Select Create.
Engage confirms with Channel created successfully.
Edit or delete a channel
- To edit, open the row's action menu and select Edit. The Edit Channel drawer opens with the current values. Select Update. Engage confirms with Channel updated successfully.
- To delete, select Delete from the same menu. The Delete Channel dialog asks Are you sure you want to delete this channel?. Select Delete. Engage confirms with Channel deleted successfully.
Deleting a channel that an alert definition still uses leaves that alert with nowhere to deliver. Check Alert definitions before deleting.
How you know it worked
The channel appears in the table with its Type, and is offered by name when choosing where an alert is sent.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| Name is required or Please select a channel type | A required field is empty | Complete it |
| This field is required on a type-specific field | The chosen type needs that value | Complete it |
| Failed to submit channel | The channel could not be saved | Check the type-specific values and try again |
| Failed to delete channel | The delete request did not complete | Try again |
Next steps
Use the channel in an alert: Alert definitions.