通知对象

通过创建通知对象，来让某些特定操作触发时，以指定的渠道和设置来进行通知。通知对象中包含对象名称、通知渠道以及渠道内的具体配置。因为通知渠道之间的配置差异较大，以下分渠道来介绍具体的配置方法。

企业微信

支持发送通知事件到企业微信群聊机器人，通过在企业微信中开启群聊机器人，配置群聊机器人的 Webhook URL，可以将事件消息发送到企业微信群聊。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
服务 URL	是	企业微信群聊机器人中的 Webhook URL

绑定企业微信群聊机器人

项目管理员可使用第三方集成功能，将企业微信群聊机器人与 Apifox 中的项目通知事件关联，以实现在企业微信群聊中推送相关的接口变更、文档变更、自动化测试完成等通知。

在「电脑端 -> 企业微信」应用的群聊的聊天信息设置中，点击添加群机器人。

复制 Webhook 地址：

将 Webhook 粘贴到通知对象中点击保存后，即完成绑定。

当选择的事件被触发时，将在企业微信群聊中收到通知。

钉钉

支持发送通知事件到钉钉群聊机器人，通过在钉钉中开启群聊机器人，配置群聊机器人的 Webhook URL，可以将事件消息发送到钉钉群聊。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
服务 URL	是	钉钉群聊机器人中的 Webhook URL
加签密钥	否	创建钉钉群聊机器人时，可自动生成机器人的签名，若开启签名，请输入签名内容

绑定钉钉群聊机器人

项目管理员可使用第三方集成功能，将钉钉群聊机器人与 Apifox 中的项目通知事件关联，以实现在钉钉群聊中推送相关的接口变更、文档变更、自动化测试完成等通知。

在「电脑端 -> 钉钉应用」的群设置中，点击智能群助手，并添加自定义机器人。

在弹出的界面中，选择“自定义”机器人。

配置安全设置，如加签：

完成后，设置 Webhook：

将 Webhook 、密钥粘贴到通知对象中点击保存后，即完成绑定。

当选择的事件被触发时，将在钉钉群聊中收到通知：

飞书

支持发送通知事件到飞书群聊机器人，通过在飞书中开启群聊机器人，配置群聊机器人的 Webhook URL，可以将事件消息发送到飞书群聊。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
服务 URL	是	飞书群聊机器人中的 Webhook URL
加签密钥	否	创建飞书群聊机器人时，可自动生成机器人的签名，若开启签名，请输入签名内容

绑定飞书群聊机器人

项目管理员可使用第三方集成功能，将飞书群聊机器人与 Apifox 中的项目通知事件关联，以实现在飞书群聊中推送相关的接口变更、文档变更、自动化测试完成等通知。

在「电脑端 -> 飞书应用」的群聊设置中，点击群机器人，并点击添加机器人。

选择自定义机器人并添加。

复制 Webhook 地址：

若启用了签名校验，复制签名：

将 Webhook 、密钥粘贴到通知对象中点击保存后，即完成绑定。

点击保存后，即完成绑定。当选择的事件被触发时，将在飞书群聊中收到通知：

Webhook

你的 HTTP 服务器可以作为一个 Webhook 接收器，接收来自 Apifox 的事件通知。

具体来说，你可以配置一个 HTTP 服务器的 URL 地址，当 Apifox 中指定的某些通知事件（如接口变更、文档变更或自动化测试完成等）被触发时，Apifox 会向这个 URL 发送 POST 请求，携带事件消息。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
服务 URL	是	HTTP 服务器接收请求的 URL 地址
签名令牌	否	使用 HMAC SHA1 加密算法，以令牌作为密钥对发送内容加密，并以十六进制显示结果（配置令牌时生效），消息将包含前缀 `sha1=`

举个例子，假如你的服务端有一个名为 POST http://127.0.0.1:8080/webhook 的 API 可接收入参，你可以将这个路径配置到 Apifox 中，如果有加密密钥，也一并填入，配置完毕后保存即可。

现在，你可以在 Apifox 项目中做一些操作，以测试是否成功。当事件被触发时，Apifox 将发送类似以下的信息到指定的服务端 URL ：

{
  "event": "API_UPDATED",
  "title": "接口修改提醒",
  "content": "所在团队：A 项目团队  \n所在项目：宠物商店  \n迭代分支名称：main  \n接口名称：获取顾客信息  \n接口路径：GET /user/208010884  \n状态：开发中  \n责任人：--  \n  \n修改者：Ring  \n修改时间：2024-05-13 23:40:36"
}

服务端拿到这些信息后，可以将其美化展示。

Jenkins

支持发送通知事件到 Jenkins 服务，通过配置 Jenkins 的 Webhook URL，可以将事件消息发送到 Jenkins。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
服务 URL	是	Jenkins Generic Webhook Trigger 插件中配置的URL
签名令牌	否	将通过请求头 Authorization Bearer 方式发送给 Generic Webhook Trigger 插件

在插件市场搜索“Generic Webhook Trigger”插件，安装即可，安装完毕重启 Jenkins 服务。

在 Jenkins-Dashboard 中新建一个视图：

点击进入上一步创建的视图，进入「Configure -> Build Triggers」，选择 Generic Webhook Trigger。Webhook URL 即 http://{{您的服务器地址}}/generic-webhook-trigger/invoke。

支持自定义 Token：

将 Webhook URL、Token 粘贴到通知对象中点击保存后，即完成绑定。

点击保存后，即完成绑定。当选择的事件被触发时，将自动触发 Jenkins 发起一次构建行为，并在构建历史记录中查看消息：

Email

支持通过邮件方式发送通知邮件到指定邮箱中。目前通知对象中为邮件渠道的，仅支持自动化测试运行完成、持续集成运行完成、定时任务运行完成这三种类型的操作使用。

配置字段说明

配置字段	是否必填	说明
名称	是	标明该通知对象的特点
通知邮箱地址	是	点击即可输入希望接受通知的邮箱地址。可以快速选择项目成员的邮箱地址，也可以手动输入一个邮箱地址。能够输入多个邮箱地址。

输入邮箱完成并点击保存后，即完成设置。当选择的事件被触发时，将在邮箱中收到通知：

企业微信#

钉钉#

飞书#

Webhook#

Jenkins#

Email#

企业微信

钉钉

飞书

Webhook

Jenkins

Email