You need to enable JavaScript to run this app.
导航
智能数据洞察（私有化）
  • 文档首页
    • /智能数据洞察（私有化）/用户指南/仪表盘构建与查看/分享协同/订阅推送方式配置——Webhook
订阅推送方式配置——Webhook
最近更新时间：2025.09.18 14:20:53首次发布时间：2024.05.27 11:09:51
复制全文
我的收藏
有用
有用
无用
无用

本文将为您介绍如何通过 企业微信群、钉钉普通群、飞书外部群以及系统API 渠道进行 Webhook 订阅推送。

功能概述

用户可通过订阅仪表盘，定时查收系统推送的仪表盘信息，密切跟进数据近况。同时产品提供的订阅管理功能，可以协助用户管理自己的订阅记录，并支持对有管理权限的仪表盘下的订阅进行修改。
Webhook 是一种在特定事件发生时，由一个应用程序向另一个应用程序发送自动通知（通常是 HTTP 请求）的机制。
当您需要在企业微信群、钉钉普通群、飞书外部群 或 系统API进行仪表盘订阅消息推送时，可以选择Webhook推送方式，​实现在企业的 IM 群中接收消息的效果。
Image

前提条件

Webhook 配置功能仅项目管理员账号可以使用，请您先获取项目管理权限，权限相关内容可参考权限概述。

快速入门

  1. 前置步骤：根据接口类型不同，按需完成新建群机器人等操作，获取 Webhook 地址或 API 等信息。

  2. 新建 Webhook 配置。进入「项目中心」-「Webhook配置」页面，点击「新建配置」，输入相关参数，完成配置。
    Image

    参数

    说明

    名称

    支持用户自定义 Webhook 名称，建议不超过 30 个字。

    URL

    该 Webhook 对应的 URL，即 Webhook 推送消息的实际目的地。

    • 对于群机器人，此 URL 由对应平台（如钉钉、飞书、企业微信）的群机器人信息提供。
    • 对于自建系统，此为您的服务端用于接收消息的 API 地址。

    Secret

    用于签名加密或验证请求来源的密钥。并非所有平台都需要，如通用 IM 接口需要密钥时在此处填写；如 API 有鉴权要求，也可在此填写 Token 等信息。

    备注信息

    可选，对此Webhook配置的辅助说明，如用途、负责人员等。

    接口类型

    选择此Webhook配置所对接的平台或协议类型，系统会根据选择适配不同的消息格式。

    • API 接口：适用于对接飞书机器人或第三方自建的系统。
    • 通用 IM 机器人：适用于公司内部或第三方定制化的 IM 平台。
    • 钉钉群机器人：专用于对接钉钉群自定义机器人。
    • 企微群机器人：专用于对接企业微信群机器人。

    订阅事件

    • 订阅：指定时触发的仪表盘推送任务。例如，每天上午9点自动将销售日报推送到群聊，具体请查看数据订阅。
    • 监控报警：当您设定的数据监控规则被触发时（如指标异常、阈值突破），系统会即时发送报警消息，具体请查看监控报警。
    • 洞察报告：系统基于归因决策功能（如归因分析、异常检测）对数据进行自动分析，生成的洞察报告会通过此事件推送，具体可查看归因订阅。
    • 数据集同步监控：当数据集同步任务成功、失败或耗时异常时发送通知，具体请参考同步设置。
    • 添加图表评论：针对该项目里的图表评论操作进行监控和推送，推送内容包含评论内容、评论人、评论关联人、评论对象（图表名称）等信息。

      注意

      • 「洞察报告」功能仅 私有化 V2.64.0 及以上版本支持。
      • 「添加图表评论」功能仅 V2.87.0 及以上版本支持。

    可用范围

    可选仅创建者可用或项目下全部人员可用。

    • 仅创建者可用：只有配置创建者能在订阅时看到并选择它。
    • 项目下全部人员可用：该项目内所有有权限创建订阅的用户均可选择此配置。

  3. 创建订阅。在仪表盘新建订阅中，完成订阅配置，具体步骤请参考具体推送场景以及数据订阅。
    Image

推送场景

企业微信群推送

第一步：新建群机器人

在配置订阅推送之前，请您先完成企业微信中的群机器人创建与配置。通过您的自定义群机器人，可以获取 Webhook URL，进而在本产品的订阅推送方式中进行配置。具体请参见 企业微信如何设置群机器人。

  1. 进入企业微信群，点击右上角“···”，选择“添加群机器人”，创建群机器人。
  2. 群机器人的创建者可通过查看机器人信息，获取群机器人的 Webhook 地址。您将在后续的操作步骤中使用这个地址。

第二步：创建企业微信群Webhook

  1. 在“项目中心”-“Webhook配置”中新建配置。
    Image
  2. 在“新建Webhook配置”中输入自定义名称和URL（机器人对应的 Webhook 地址），选择您的接口类型为企微群机器人，然后选择您需要的订阅事件并设置可用范围。
    Image

第三步：创建订阅

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

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

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

钉钉普通群推送

第一步：新建群机器人

在配置订阅推送之前，请您先完成钉钉中的群机器人创建与配置。通过您的自定义群机器人，可以获取Webhook URL，进而在本产品的订阅推送方式中进行配置。具体请参见钉钉如何设置群机器人。

  1. 进入钉钉群聊，单击“群设置” > “智能群助手”创建群机器人，在机器人管理页面选择“自定义机器人”，输入机器人名字并选择要发送消息的群。
  2. 获取群机器人的 Webhook 地址，您将在后续的操作步骤中使用这个地址。

第二步：创建钉钉普通群Webhook

  1. 在“项目中心“-“Webhook配置”中新建配置。
    Image
  2. 在“新建Webhook配置”中输入自定义名称和 URL (机器人对应的 Webhook 地址），选择您的接口类型为钉钉群机器人，然后选择您需要的订阅事件并设置可用范围。
    Image

第三步：创建订阅

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

  2. 在新建订阅-订阅通知中，选择推送方式为“钉钉普通群”，选择接收人为您创建的Webhook名。
    Image

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

飞书外部群推送

第一步：新建群机器人

在配置订阅推送之前，请您先完成飞书中的群机器人创建与配置。通过您的自定义群机器人，可以获取Webhook URL，进而在本产品的订阅推送方式中进行配置。具体步骤请参见飞书如何设置群机器人。

  1. 进入飞书外部群，点击右上角“···”，选择设置>群机器人>添加机器人>添加自定义机器人。
  2. 获取群机器人的Webhook地址。您将在后续的操作步骤中使用这个地址。

第二步：创建飞书外部群Webhook

  1. 在“项目中心”-“Webhook配置”中新建配置。
    Image
  2. 在“新建Webhook配置”中输入自定义名称和URL（机器人对应的 Webhook 地址），选择您的接口类型为 API 接口，然后选择您需要的订阅事件并设置可用范围。
    Image

第三步：创建订阅

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

  2. 在新建订阅-订阅通知中，选择推送方式为“Webhook”。
    Image

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

API 推送

第一步：获取API

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

第二步：确认订阅推送结构

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

{
   "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"
     }

第三步：订阅推送方式选择Webhook

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

  2. 在新建订阅-订阅通知中，选择推送方式为“Webhook”；接收人处选择“1)快速新建webhook”

  3. 在“新建Webhook配置”中输入自定义名称和URL(机器人对应的 Webhook 地址），选择接口类型为API接口，然后选择您需要的订阅事件并设置可用范围。

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

通用 IM

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

第一步：新建IM-WebHook配置

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

第二步：创建订阅

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

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