This document describes how to configure alarm notification channels in a workspace. All Ops messages sent to the workspace, including workflow alarms, task alarms, data quality rule alarms, and compute resource alarms, are sent through the channels configured here.
Overview
DataBuddy supports four notification channels, which can be added as needed in Workspace Settings.
Channel type | Scenario |
Email | Receive text alarms via email, suitable for individual and team email groups. |
Webhook | Push JSON messages to a self-built HTTP service for easy integration with an internal alarm platform. |
Slack | Send to Slack channels, suitable for IM collaboration among overseas teams. |
Teams | Send to Microsoft Teams channels. |
Notification channels are workspace-level configurations. After a one-time configuration, all objects in the workspace that support alarms (workflows, tasks, compute resources, data quality rules, and so on) can reference these channels.
Prerequisites
You have joined the target workspace and have the Workspace Administrator role, or a custom role with the Notification Management permission.
To configure a Slack / Teams channel, create an Incoming Webhook URL in the corresponding platform's channel and copy it for later use.
To configure a Webhook channel, prepare a URL that can receive HTTP POST requests. If necessary, also prepare the Basic Auth username and password.
Operation Steps
Adding a Notification Channel
1. Enter the target workspace, and choose Workspace Settings > Notification Management in the left sidebar.
2. Click Add Channel.
3. Select a channel type and fill in the configuration items.
Email Channel
Parameter | Description | Required | Default Value |
Channel type | Email | Yes | - |
Channel name | Channel display name, used for selection when alarms are configured. | Yes | - |
Email address | Email address for receiving alarms. Multiple email addresses are supported, separated by half-width commas. | Yes | - |
Webhook Channel
Parameter | Description | Required | Default Value |
Channel type | Webhook | Yes | - |
Channel name | Channel display name | Yes | - |
Webhook URL | Webhook receiving address, using HTTPS | Yes | - |
Username. | Basic Auth username | No | - |
Password | Basic Auth password | No | - |
Slack Channel
Parameter | Description | Required | Default Value |
Channel type | Slack | Yes | - |
Channel name | Channel display name | Yes | - |
Slack Webhook URL | Incoming Webhook URL created in a Slack channel | Yes | - |
Teams Channel
Parameter | Description | Required | Default Value |
Channel type | Teams | Yes | - |
Channel name | Channel display name | Yes | - |
Webhook URL | Incoming Webhook URL created in a Teams channel | Yes | - |
1. Click Add to save. The new channel will appear in the Notification Management list and can be immediately referenced by alarm configurations. Email cannot be referenced by task and workflow alarms.
Editing a Notification Channel
1. In the Notification Management list, click Edit in the operation column.
2. In the pop-up edit window, modify the name, address, URL, or Basic Auth information.
Note:
For security reasons, the URLs and Basic Auth passwords for Webhook / Slack / Teams in the edit window are displayed as ciphertext.
1. Click Edit to save the changes.
Deleting a Notification Channel
1. In the Notification Management list, click Delete in the operation column of the target channel.
2. In the confirmation window, click OK.
Warning
Before deletion, confirm that the channel is not referenced by any alarm rules. After deletion, notifications for alarms that reference this channel cannot be sent.
Querying Notification Channels
Enter a channel name keyword in the search box of the Notification Management list to quickly filter the list.
Referencing a Notification Channel in an Alarm Rule
After completing the notification channel configuration, you can reference it in the following scenarios:
Workflow Alarm: On the Alarm tab of the workflow configuration, select a configured channel. For details, see Workflow and Task Alarms. Data Quality Rule Alarm: Select a channel in the quality rule configuration. For details, see Quality Rule Alarm Configuration.
Use Limits
Notification channels are workspace-level configurations and are not shared across workspaces. To use the same channel in multiple workspaces, configure it separately in each workspace.
The Slack / Teams channel depends on the long-term validity of the external platform's Webhook URL. Ensure that the URL is not deleted or reset.
When a single alarm fails to be sent, DataBuddy retries it separately for each channel. The same alarm is independent across multiple channels, and other channels are not blocked by the failure of one channel.
FAQs
Q1: What should I do if I do not receive the email?
Check the following in order: 1) whether the email address is spelled correctly; 2) whether the email is blocked by the recipient's anti-spam policy (search for emails whose sender contains "DataBuddy"); 3) whether the alarm rule is actually triggered (check the status in the run history of the alarm entity).
Q2: No message is received when testing the Slack channel after configuration?
Confirm that the Slack Webhook URL is still valid (it can be regenerated in the Slack platform). Also check whether the Slack channel has sending restrictions configured for this App.
Q3: What is the format of the request received by the Webhook?
DataBuddy pushes the JSON-format message body via HTTPS POST.
References