You need to enable JavaScript to run this app.
导航
订阅推送方式配置——Webhook
最近更新时间:2025.02.20 11:08:59首次发布时间:2024.05.27 11:09:51
我的收藏
有用
有用
无用
无用

1.概述

用户可通过订阅仪表盘,定时查收系统推送的仪表盘信息,密切跟进数据近况。同时产品提供的订阅管理功能,可以协助用户管理自己的订阅记录,并支持对有管理权限的仪表盘下的订阅进行修改。
当您需要在企业微信群、钉钉普通群、飞书外部群 或 系统API进行仪表盘订阅消息推送时,可以选择Webhook推送方式,实现在企业的IM群中接受消息的效果。本文将为您介绍如何通过这些渠道进行Webhook推送。

Webhook 是一种在特定事件发生时,由一个应用程序向另一个应用程序发送自动通知(通常是 HTTP 请求)的机制。

2.推送场景

2.1 企业微信群推送

2.1.1 新建群机器人

在配置订阅推送之前,请您先完成企业微信中的群机器人创建与配置。通过您的自定义群机器人,可以获取Webhook URL,进而在本产品的订阅推送方式中进行配置。
第一步,进入企业微信群,点击右上角“···”,选择“添加群机器人”,创建群机器人。
第二步,群机器人的创建者可通过查看机器人信息,获取群机器人的Webhook地址。您将在后续的操作步骤中使用这个地址。
具体请参见企业微信如何设置群机器人

2.1.2 创建企业微信群Webhook

在“项目中心”-“Webhook配置”中新建配置。
在“新建Webhook配置”中输入自定义名称和URL(机器人对应的 Webhook 地址),选择您的接口类型为企微群机器人,然后选择您需要的订阅事件。

Image

2.1.3 创建订阅

您可以点击仪表盘右上角创建订阅。

第一步,在新建订阅-订阅通知中,选择推送方式为“企业微信群”,选择接收人为您创建的Webhook名。

第二步,配置完成后,您可以点击“发送测试”,验证群内是否弹出订阅消息。若测试成功,则可点击“确定”。

2.2 钉钉普通群推送

2.2.1 新建群机器人

在配置订阅推送之前,请您先完成钉钉中的群机器人创建与配置。通过您的自定义群机器人,可以获取Webhook URL,进而在本产品的订阅推送方式中进行配置。
第一步,进入钉钉群聊,单击“群设置” > “智能群助手”创建群机器人,在机器人管理页面选择“自定义机器人”,输入机器人名字并选择要发送消息的群。
第二步,获取群机器人的Webhook地址,您将在后续的操作步骤中使用这个地址。
具体请参见钉钉如何设置群机器人

2.2.2 创建钉钉普通群Webhook

在“项目中心“-“Webhook配置”中新建配置。
在“新建Webhook配置”中输入自定义名称和URL(机器人对应的 Webhook 地址),选择您的接口类型为钉钉群机器人,然后选择您需要的订阅事件。
Image

2.2.3 创建订阅

您可以点击仪表盘右上角创建订阅。

第一步,在新建订阅-订阅通知中,选择推送方式为“钉钉普通群”,选择接收人为您创建的Webhook名。

第二步,配置完成后,您可以点击“发送测试”,验证群内是否弹出订阅消息。若测试成功,则可点击“确定”。

2.3 飞书外部群推送

2.3.1 获取API

在配置订阅推送之前,请您先完成飞书中的群机器人创建与配置。通过您的自定义群机器人,可以获取Webhook URL,进而在本产品的订阅推送方式中进行配置。
第一步,进入飞书外部群,点击右上角“···”,选择设置>群机器人>添加机器人>添加自定义机器人。
第二步,获取群机器人的Webhook地址。您将在后续的操作步骤中使用这个地址。
具体步骤请参见飞书如何设置群机器人

2.3.2 创建飞书外部群Webhook

在“项目中心”-“Webhook配置”中新建配置。
在“新建Webhook配置”中输入自定义名称和URL(机器人对应的 Webhook 地址),选择您的接口类型为API接口,然后选择您需要的订阅事件。
Image

Image

2.3.3 创建订阅

点击仪表盘右上角创建订阅。

第一步,在新建订阅-订阅通知中,选择推送方式为“Webhook”。

第二步,配置完成后,您可以点击“发送测试”,验证群内是否弹出订阅消息。若测试成功,则可点击“确定”。

2.4 API 推送

2.4.1 获取API

准备好您用户接收订阅消息的 API 地址。

2.4.2 订阅推送结构

以下为您提供输出脚本的规范,供您参考使用。

{
   "context":{
       "screenshots":[//截图信息
           {
             "img_key": "img_v3_0290_e3cbb4e4-9ad2-4e94-88330-05f6da41d3bg",//截图key
             "title":"页面1",
             "url": "https://el68-2-8abi.datarangers-onpremise.volces.com/minio.datawind/82f366da-0bf1-4i7c0-a9a2-
522174a39824.jpeg",//图片下载地址
              "height":770,//高度
              "width":1160,//宽度
              "time":"2024-03-15 12:32:07 UTC+08:00",//截图时间
              "sheetUrl": "https://e168-2-8abi.datarangers-
              onpremise.volces.com/"//sheet访问地址
                 }
             ],
             "subscription":{//订阅信息
             "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,//仪表盘id
               "owner": "admin",
               "dashboard_content_visible": true,
               "id": 40
              }
          },
                "card":{},//card是飞书协议结构,此处忽略
                "msg_type": "interactive"
     }

2.4.3 订阅推送方式选择Webhook

点击仪表盘右上角创建订阅。

第一步,在新建订阅-订阅通知中,选择推送方式为“Webhook”;接收人处选择“1)快速新建webhook”

第二步,在“新建Webhook配置”中输入自定义名称和URL(机器人对应的 Webhook 地址),选择接口类型为API接口,然后选择您需要的订阅事件。

第三步,选择接收人为您新建的Webhook名。配置完成后,您可以点击“发送测试”,验证群内是否弹出订阅消息。若测试成功,则可点击“确定”。

2.5 通用IM

针对公司自建IM协同工具或OA类系统等三方应用的对接,进行订阅、监控、数据集任务监控等消息通知的场景时,提供了“通用IM”的能力支持,其本质也是通过WebHook的能力,将信息传递出去,并通过提前与三方系统完成用户的映射,可在传递信息时聚焦到具体用户。
通用IM的能力是项目粒度,即每个项目可独立配置一个和多个通用IM。
Image

2.5.1 新建IM-WebHook配置

管理员进入项目中心,点击WebHook配置,在右侧新建WebHook配置.
Image
进入IM获取您用户接收订阅消息的 API 地址和密钥后,在获取接口类型选择通用IM机器人,选择需要订阅的事件和可用范围,并保持。
Image

2.5.2 创建订阅

点击仪表盘右上角创建订阅。

推送方式选择**通用IM,**在接收人中选择刚刚配置好的IM机器人。配置完成后,您可以点击“发送测试”,验证是否弹出订阅消息。若测试成功,则可点击“确定”。
Image