跳到主要内容

通知设置

WebHooks​

支持第三方 Webhook 能力，可基于事件（Event）将消息通知推送到第三方平台，实现业务流程中的事件驱动协同。

当前支持渠道：

  • 飞书
  • 企业微信
  • 钉钉
  • Webhook

后续将持续扩展更多通知渠道。

image.png

使用场景​

通过事件驱动，将项目中的关键操作、自动化测试结果等消息推送到第三方协作平台，例如：

  • 自动化测试执行结果通知
  • 自动化测试报告推送
  • 场景执行异常提醒
  • 项目协作通知
  • CI/CD 流程通知

支持推送至飞书群机器人、企业微信群机器人、钉钉群机器人等。

配置权限说明

仅 项目管理员及以上 可新建和管理通知配置。

通知类型​

当前支持两种通知触发方式：

类型说明
自动触发当事件发生时自动推送通知
手动触发在自动化测试场景中手动选择通知配置后触发报告推送

自动化测试报告通知​

新增支持「自动化测试执行报告通知」。

与原有基于事件自动推送的通知方式不同，执行报告通知采用 手动触发 模式：

  • 用户需先完成通知配置
  • 在自动化测试场景中手动选择对应通知配置
  • 执行完成后，即可将测试报告推送到对应群聊

适用于：

  • 指定场景报告推送
  • 临时执行通知
  • 不同测试场景推送到不同群组
  • 阶段性测试结果同步

如何配置​

在对应第三方平台创建群机器人后，将机器人提供的 Webhook URL 配置到 Apipost 中，并选择对应通知事件即可。

飞书​

支持将事件通知发送到飞书群机器人。

通过在飞书中创建 群聊机器人 获取 Webhook URL，并配置到通知设置中即可。

如开启了签名校验，还需配置 Secret 以提升安全性。

配置参数​

配置字段是否必填说明
通知名称是用于标识当前通知配置
触发方式是自动触发 / 手动触发
触发事件自动触发时必填选择需要监听的事件
Webhook URL是飞书机器人 Webhook 地址
Secret否开启签名校验时必填

绑定流程​

1. 创建飞书群机器人​

打开飞书 PC 客户端：

群聊设置 → 群机器人 → 添加机器人

image.png

点击 添加机器人

image.png

选择 自定义机器人

image.png

完成机器人配置后点击 添加

image.png

复制并保存：

  • Webhook URL
  • Secret（如开启签名校验）

image.png

2. 在 Apipost 中创建通知配置​

进入：

项目设置 → 对外能力 → 通知设置 → 新建通知

配置：

  1. 填写通知名称
  2. 选择触发方式
  3. 渠道选择 飞书
  4. 填写 Webhook URL
  5. 如开启签名校验，填写 Secret
  6. 保存配置
  7. 打开【启用】开关

image.png

image.png

3. 自动化测试中使用通知配置（手动触发）​

在自动化测试场景中：

  1. 打开场景配置
  2. 选择 执行报告通知
  3. 选择已创建的通知配置
  4. 执行场景后，即可自动推送测试报告

image.png

4. 消息效果​

事件触发或测试执行完成后，将收到机器人推送消息。

image.png

企业微信​

支持将通知发送到企业微信群机器人。

配置参数​

配置字段是否必填说明
通知名称是用于标识当前通知配置
触发方式是自动触发 / 手动触发
触发事件自动触发时必填选择需要监听的事件
Webhook URL是企业微信群机器人 Webhook 地址

绑定流程​

1. 创建企业微信群机器人​

打开企业微信 PC 客户端：

群聊 → 设置 → 添加群机器人

image.png

点击 新创建一个机器人

image.png

填写机器人名称并创建

image.png

复制并保存 Webhook URL

image.png

2. 在 Apipost 中创建通知配置​

进入：

项目设置 → 对外能力 → 通知设置 → 新建通知

配置：

  1. 填写通知名称
  2. 选择触发方式
  3. 渠道选择 企业微信
  4. 填写 Webhook URL
  5. 保存配置
  6. 打开【启用】开关

image.png

image.png

3. 自动化测试中使用通知配置（手动触发）​

在自动化测试场景中选择对应通知配置后，执行完成即可收到测试报告通知。

4. 消息效果​

image.png

钉钉​

支持将通知发送到钉钉群机器人。

配置参数​

配置字段是否必填说明
通知名称是用于标识当前通知配置
触发方式是自动触发 / 手动触发
触发事件自动触发时必填选择需要监听的事件
Webhook URL是钉钉群机器人 Webhook 地址
Secret是钉钉机器人加签秘钥

绑定流程​

1. 创建钉钉群机器人​

打开钉钉：

群聊 → 设置 → 机器人

image.png

点击 添加机器人

image.png

选择 自定义机器人

image.png

完成机器人配置

image.png

安全设置请选择 加签，并保存 Secret

image.png

复制保存 Webhook URL

image.png

2. 在 Apipost 中创建通知配置​

进入：

项目设置 → 对外能力 → 通知设置 → 新建通知

配置：

  1. 填写通知名称
  2. 选择触发方式
  3. 渠道选择 钉钉
  4. 填写 Webhook URL
  5. 填写加签 Secret
  6. 保存配置
  7. 打开【启用】开关

image.png

image.png

3. 自动化测试中使用通知配置（手动触发）​

在自动化测试场景中选择通知配置后，执行完成即可收到测试报告通知。

4. 消息效果​

image.png