1. 概述

Webhook是一个API概念,简单来说就是一种反向API机制,类似于触发器的一样,它可以将您订阅的事件(报告、预警、取数、异动指标分析等)按照设定的规则推送至第三方平台(钉钉、企业微信、飞书等),工作原理类似下图。

本文将介绍webhook的配置及管理操作,包括Webhook列表,新建Webhook等。详细文档请参考Webhook接口设计

2. Webhook列表

在[项目中心-资源管理-Webhook],如果您具备管理员权限,则可以管理该项目下所有Webhook,增加、删除和编辑对应的Webhook。

3. 新增Webhook

点击页面左上角的添加按钮,可创建一个新的Webhook。

  • 名称:填写对应的名称,项目内不允许重复
  • URL:数据接收地址,请保证该地址可用
  • secret:本产品认证key,如需使用请保证你们系统识别到这个参数
  • 订阅事件:报告、度量预警、取数、异动指标分析、决策引擎,不选择报告时将无法把报告发到对应的Webhook
  • 自定义参数:如图所示支持json数据格式,遵从标准的数据规范

    ```
    {"key1":"value","key2":"value"}
    ```