1. 项目协同
  2. 代码仓库
  3. DevOps 实践之旅
  4. 一分钟开始持续集成之旅
  5. 持续部署
  6. 制品库

功能介绍

Service Hook 能够对服务、事件、过滤条件、发送行为等要素进行管理,具备多服务、多事件、条件过滤、发送配置等能力。它支持将您在 CODING 中操作所产生的事件,以标准 HTTP 协议发送给第三方平台,平台在接收到 HTTP 请求后进行响应以实现自定义功能需求。

服务类型

服务是指第三方应用服务,比如 HTTP Server、企业微信、钉钉、飞书、Jenkins 等。CODING 目前主要支持的服务类型有:Web Hook、企业微信、钉钉、飞书、Jenkins。点击阅读服务类型介绍了解更多详情。

事件

事件是指用户在某一个功能产生的操作,事件将包括基本的事件数据。目前 CODING 支持事件的功能模块有:

  • 迭代
  • 事项
  • 代码推送
  • 合并请求
  • 制品
  • 制品仓库
  • 持续集成
  • 文件网盘
  • Wiki
  • 项目成员

点击阅读事件介绍了解更多详情。

过滤条件

过滤条件是指操作触发时产生的事件,是否在指定条件满足的情况下再发送。点击阅读过滤器了解更多详情。

发送行为

发送行为是指第三方应用服务支持的发送方式,比如企业微信支持发送到群聊机器人。Service Hook 支持分页列表、筛选、新建、编辑、测试、事件开关、发送记录、复制等操作。

快速开始

查看列表

Service Hook 列表支持分页查看,支持搜索过滤,可通过如下条件过滤列表:

  • 服务
  • 事件
  • 状态
  • 事件开关

Service Hook 列表

Service Hook 列表过滤

新建

点击新建 Service Hook按钮,将会弹窗新建弹窗,按照提示进行操作。



编辑

选择需要编辑的 Service Hook 记录,点击右侧详情按钮,将会弹窗 Service Hook 编辑侧滑框。

Service Hook 详情侧滑框

测试

在新增和编辑 Service Hook 的时候,填写好必要信息之后,点击测试按钮,可以发送一条测试消息到第三方平台。

Service Hook 测试

事件开关

如某些场景下,暂时不需要开启 Service Hook,可以选择将某条 Service Hook 记录禁用,如下图操作即可。

发送记录

在事件被触发时,发送的消息记录将会被系统记录下来,可以通过查看发送记录了解发送的详情信息。选中某条记录,可以展开查看发送记录的详细信息。

Service Hook 发送记录按钮
Service Hook 发送记录详情

复制

支持通过复制一条 Service Hook 记录创建新的 Service Hook,只需要选中需要复制的记录,点击复制按钮,新建弹窗将自动填充被复制的记录内容,按需修改内容即可保存为新的记录。

Service Hook 复制按钮
Service Hook 复制弹窗

模板

Service Hook 支持使用模板自定义发送内容,主要支持文本、Markdown、自定义等三种方式,支持通过 JsonPath 的方式读取事件消息填充模板。

如下图,当用户选择文本或者 Markdown 时,输入自定义模板后,发送内容将以文本或者 Markdown 的格式发送,内容为填充模板后的内容。

示例模板:

这是项目成员操作的自定义模板,成员名为:${member.name}

Markdown 模板

发送消息结果:

这是项目成员操作的自定义模板,成员名为:张三

如下图,当用户选择自定义模板时,用户可以定义符合第三方平台标准的消息 Json 格式,发送除文本和 Markdown 之外的消息类型,图例中为企业微信中的图文消息类型。

示例模板:

{
    "msgtype": "news",
    "news": {
        "articles": [
            {
                "title": "欢迎使用 CODING",
                "description": "欢迎项目成员 ${member.name} 加入 CODING",
                "url": "www.qq.com",
                "picurl": "https://help-assets.codehub.cn/enterprise/20210416165040.png"
            }
        ]
    }
}

自定义模板

发送消息结果:

注意:自定义 Json 模板将无法支持 @ 某人、自定义签名等功能,如有需求,请在 Json 模板中补充相关字段。

上一篇绑定钉钉机器人
最近更新
感谢反馈有用
感谢反馈没用

在阅读中是否遇到以下问题?

您希望我们如何改进?