This article introduces how to use the Enterprise WeChat group, DingTalk regular group, Lark external group, and system API channels to set up Webhook subscription push notifications.

Users can subscribe to dashboards to receive scheduled dashboard updates pushed by the system, enabling close tracking of recent data trends. At the same time, the product provides a subscription management feature to help users manage their subscription records and supports modifying subscriptions under dashboards for which they have management permissions.
A Webhook is a mechanism by which one application sends an automatic notification (usually an HTTP request) to another application when a specific event occurs.
To push dashboard subscription messages to Enterprise WeChat groups, DingTalk regular groups, Lark external groups, or system APIs, you can select the Webhook push method to receive messages in the enterprise IM group.

The Webhook configuration feature is available only to project administrator accounts. Please obtain project management permissions first. For details about permissions, refer to Permission Overview.

1. Preliminary steps: Depending on the interface type, complete operations such as creating a new group bot as needed to obtain the Webhook address or API information.

2. Create a new Webhook configuration. Go to the Project Center – Webhook Configuration page, click the New Configuration button, enter the relevant parameters, and complete the configuration.
   

   Parameters	Description
   Name	Supports user-defined Webhook names; it is recommended not to exceed 30 characters.
   URL	The URL corresponding to this Webhook, that is, the actual destination for Webhook message delivery. For group bots, this URL is provided by the group bot information of the corresponding platform (such as DingTalk, Lark, or WeCom). For self-built systems, this is the API address of your server for receiving messages.
   Secret	The key used for signature encryption or request source verification. Not all platforms require this. For example, if a general IM interface requires a key, enter it here. If the API requires authentication, you can also enter the token or other information here. Select static token or dynamic token: Static token: When selecting a static token, you must enter the token. Dynamic token: When selecting a dynamic token, you must enter the interface for obtaining the token and the token parameter name.
   Remarks	Optional. Additional information for this Webhook configuration, such as its purpose, responsible person, and more.
   Interface type	Select the platform or protocol type that this Webhook configuration connects to. The system will adapt the message format based on your selection. API interface: Suitable for connecting to Lark bots or third-party self-built systems. General IM bot: Suitable for internal company or third-party customized IM platforms. DingTalk group bot: Used exclusively for connecting to DingTalk group custom bots. WeCom group bot: Used exclusively for connecting to WeCom group bots.
   Subscription events	Select the subscription event types. Multiple selections are supported. Subscription: Scheduled dashboard push tasks triggered at specified times. For example, automatically push the sales daily report to the group chat at 9:00 a.m. every day. For details, see Data Subscription. Monitoring alert: When the data monitoring rules you set are triggered (such as metric anomalies or threshold breaches), the system will immediately send an alert message. For details, see Monitoring and Alerting. Insight report: The system automatically analyzes data based on attribution decision features (such as attribution analysis and anomaly detection). The generated insight report will be pushed through this event. For details, see Attribution Subscription. Dataset synchronization monitoring: Sends a notification when a dataset synchronization task succeeds, fails, or takes an abnormal amount of time. For details, refer to Synchronization Settings. Add chart comment: Monitors and pushes notifications for chart comment operations in this project. The push content includes the comment, commenter, related users, the chart being commented on (chart name), and more. Visual modeling synchronization monitoring: Sends a notification when a visual modeling task succeeds, fails, or takes an abnormal amount of time. warning The insight report feature is only supported in self-hosted V2.64.0 and later versions. The add chart comment feature is only supported in V2.87.0 and later versions. The visual modeling synchronization monitoring feature is only supported in V2.91.0 and later versions.
   Scope of availability	Optional: available only to the creator or to all project members. Available only to the creator: Only the configuration creator can see and select it when subscribing to it. Available to all project members: All users within the project who have permission to create subscriptions can select this configuration.

3. Create a subscription. In the dashboard's new subscription section, complete the subscription configuration. For detailed steps, refer to the specific push scenario and Data Subscription.
   

Enterprise WeChat group push #

Step 1: Create a group bot #

Before configuring subscription push, complete the creation and configuration of a group bot in Enterprise WeChat. With your custom group bot, you can obtain the Webhook URL and then configure it in this product's subscription push method. For details, see How to set up a group bot in Enterprise WeChat.

1. Enter the Enterprise WeChat group, click the "···" icon in the upper right corner, select "Add group bot," and create a group bot.
2. The creator of the group robot can view the robot information to obtain the group robot's Webhook address. You will use this address in subsequent steps.

Step 2: Create a WeCom group Webhook #

1. Create a new configuration in "Project Center" - "Webhook Configuration".
   
2. In "Create Webhook Configuration", enter a custom name and URL (the Webhook address corresponding to the robot), select your interface type as WeCom group robot, then select the subscription events you need and set the available scope.
   

Step 3: Create a subscription #

1. You can click the upper right corner of the dashboard to create a subscription.
   
2. In the Create Subscription - Subscription Notification dialog, select the notification method as "WeCom group", and select the recipient as the Webhook name you created.
3. After configuration is complete, you can click "Send Test" to verify whether the subscription message appears in the group. If the test is successful, you can click "Confirm".

DingTalk standard group notifications #

Step 1: Create a group robot #

Before configuring subscription notifications, complete the creation and configuration of the group robot in DingTalk. Through your custom group robot, you can obtain the Webhook URL, and then configure it in the subscription notification method of this product. For details, see How to set up a group robot in DingTalk.

1. Enter the DingTalk group chat, click "Group Settings" > "Smart Group Assistant" to create a group robot, select "Custom Robot" on the robot management page, enter the robot name, and select the group to send messages to.
2. Obtain the group robot's Webhook address. You will use this address in subsequent steps.

Step 2: Create a DingTalk standard group Webhook #

1. Create a new configuration in "Project Center" - "Webhook Configuration".
   
2. In "Create Webhook Configuration", enter a custom name and URL (the Webhook address) corresponding to the robot), select your interface type as DingTalk group robot, then select the subscription events you need and set the available scope.
   

Step 3: Create a subscription #

1. You can click the upper right corner of the dashboard to create a subscription.
   
2. In the New Subscription - Subscription Notification section, select the push method as "DingTalk Standard Group" and select the recipient as the Webhook name you created.
3. After completing the configuration, you can click "Send Test" to verify whether the subscription message pops up in the group. If the test is successful, you can click "OK".

Lark external group push #

Step 1: Create a group bot #

Before configuring subscription push, please complete the creation and configuration of a group bot in Lark. With your custom group bot, you can obtain the Webhook URL and then configure it in the subscription push method of this product. For detailed steps, see How to set up a group bot in Lark.

1. Enter the Lark external group, click the "···" icon in the upper right corner, select Settings > Group Bots > Add Bot > Add Custom Bot.
2. Obtain the Webhook address of the group bot. You will use this address in subsequent steps.

Step 2: Create a Lark external group Webhook #

1. Create a new configuration in "Project Center" - "Webhook Configuration".
   
2. In "Create Webhook Configuration", enter a custom name and URL (the Webhook address corresponding to the bot), select your interface type as API interface, then select the subscription events you need and set the available scope.
   

Step 3: Create a subscription #

1. Click "Create Subscription" in the upper right corner of the dashboard.
   
2. In the New Subscription - Subscription Notification section, select the push method as "Webhook".
3. After completing the configuration, you can click "Send Test" to verify whether the subscription message pops up in the group. If the test is successful, you can click "OK".

API push #

Step 1: Obtain the API #

Prepare the API address for your users to receive subscription messages.

Step 2: Confirm the subscription push structure #

The following provides the specification for the output script for your reference.

{
   "context":{
       "screenshots":[//Screenshot information
           {
             "img_key": "img_v3_0290_e3cbb4e4-9ad2-4e94-88330-05f6da41d3bg",//Screenshot key
             "title":"页面1",
             "url": "https://el68-2-8abi.datarangers-onpremise.volces.com/minio.datawind/82f366da-0bf1-4i7c0-a9a2-
522174a39824.jpeg",//Image download URL
              "height":770,//Height
              "width":1160,//Width
              "time":"2024-03-15 12:32:07 UTC+08:00",//Screenshot time
              "sheetUrl": "https://e168-2-8abi.datarangers-
              onpremise.volces.com/"//Sheet access URL
                 }
             ],
             "subscription":{//Subscription information
             "dashboard_link_visible": true,
             "language": "zh_CN",
              "title":"【Datawind订阅】test",
              "manage_url": "https://el68-2-8abi.datarangers- 
onpremise.volces.com/bi#/dashboard/subscripticon/35905?appId=1"
              "push_type": "webhook",
               "dashboard_id":35905,//Dashboard ID
               "owner": "admin",
               "dashboard_content_visible": true,
               "id": 40
              }
          },
                "card":{},//card is a Lark protocol structure; ignore here
                "msg_type": "interactive"
     }

Step 3: Select Webhook as the subscription push method #

1. Click "Create Subscription" in the upper right corner of the dashboard.
   
2. In the New Subscription - Subscription Notification section, select the push method as "Webhook"; for the recipient, select "1) Quickly create webhook".
3. In "Create Webhook configuration", enter a custom name and URL (the bot's corresponding Webhook address), select the interface type as API interface, then select the events you want to subscribe to and set the available scope.
4. Select the Webhook name you just created as the recipient. After completing the configuration, you can click "Send test" to verify whether the subscription message appears in the group. If the test is successful, click "OK".

General IM #

For scenarios such as integrating with in-house IM collaboration tools, OA systems, or other third-party applications for subscription, monitoring, dataset task monitoring, and other message notifications, "General IM" capability is provided. Essentially, it leverages WebHook functionality to transmit information, and by mapping users with third-party systems in advance, messages can be targeted to specific users during transmission.
The General IM capability is at the project level, meaning each project can independently configure one or more General IMs.

Step 1: Create an IM-WebHook configuration #

1. The administrator enters the project center, clicks WebHook configuration, and creates a new WebHook configuration on the right.
2. After obtaining the API address and key for receiving subscription messages from IM, select General IM bot as the interface type, then select the events to subscribe to and the available scope.
   

Step 2: Create a subscription #

1. Click "Create subscription" in the upper right corner of the dashboard.
   
2. Select General IM, as the push method, and select the IM bot you just configured as the recipient. After completing the configuration, you can click "Send test" to verify whether the subscription message appears. If the test is successful, click "OK".