Notification Channels
A notification channel is a delivery route. It holds the server, provider, or endpoint details and the credentials to use them, plus the recipients and the message template. Alert definitions refer to channels by name, so one channel can carry any number of alerts.
Before you begin
- You are signed in as an organisation member. Channels are organisation-wide settings.
- You have the connection details for the channel type: an SMTP host, port, and login for email; a provider, account SID, and auth token for SMS; an endpoint URL for a webhook.
Open the channels list
- In the Engage sidebar, select Settings, then Notification Channels.
The table lists every channel with Name, Channel Type, Status, Scope, Created At, and Actions. Channel Type can be filtered by the types in use, and Search Notification Channels matches on name or type.
Create a channel
- Select Add Notification Channel. The Add Notification drawer opens.
- Complete the common fields, then select a Channel Type. The fields for that type appear below it.
- Complete the type's fields, then Recipient List and Message Template.
- Select Create.
Common fields
| Field | Required | What to enter |
|---|---|---|
| Name | Yes | A unique name. Engage stores it in upper case. |
| Description | No | Free text. |
| Active | No | On by default. An inactive channel stays in the list but is not used. |
| Secure | No | On by default. Marks the channel as secure. |
| Channel Type | Yes | Email, SMS, or Webhook. |
| Recipient List | Yes | Who receives the notification: email addresses, phone numbers, or a webhook URL, as the type requires. Separate several with commas. |
| Message Template | Yes | The text of the notification. |
Email
| Field | Required | What to enter |
|---|---|---|
| SMTP Server | Yes | The SMTP host, for example smtp.example.com. |
| Port | Yes | The SMTP port. The placeholder suggests 587. |
| From | Yes | The sender address. |
| Username | Yes | The SMTP login. |
| Password | Yes | The SMTP password. It is stored with the channel and shown when the channel is edited. |
SMS
| Field | Required | What to enter |
|---|---|---|
| Provider | Yes | The SMS service provider. |
| Account SID | Yes | The provider account identifier. |
| Auth Token | Yes | The provider authentication token. |
| From | Yes | The sender number or address. |
Webhook
| Field | Required | What to enter |
|---|---|---|
| URL | Yes | The endpoint Engage calls. |
| Method | Yes | POST, PUT, or PATCH. Defaults to POST. |
| Timeout | Yes | Request timeout in milliseconds. Defaults to 5000. |
A webhook channel carries no authentication fields in this release. If the endpoint needs a credential, it has to be part of the URL or handled on the receiving side.
Enable, disable, edit, or delete a channel
- Status is a switch on the row. Changing it asks Status Update Confirmation; select Enable or Disable to confirm. Engage reports Status updated successfully.
- The edit control in Actions opens the Edit Notification drawer with the saved values. Select Update to save.
- The delete control in Actions asks for confirmation; select Delete. Engage reports Notification deleted successfully.
How you know it worked
Engage reports Notification channel created successfully and the channel appears in the table with its type and Status on. In Settings > Alert Definitions, the channel is now offered in Channel Configuration IDs.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| A message naming a field, such as SMTP server is required or Recipient list is required | A required field for the selected type is empty | Complete the field named and select Create again |
| Failed to create notification or Failed to update notification | Engage could not save the channel | Try again; if it persists, ask an administrator |
| Failed to delete notification | Engage could not delete the channel | Check whether an alert definition still uses it, then try again |
Next steps
Alert definitions, which choose when this channel is used.