Apidog Docs
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. 管理项目
  • Apidog 学习中心
  • 入门
    • Apidog 简介
    • Apidog 中的基本概念
    • 导航 Apidog
    • 快速开始
      • 概述
      • 创建端点
      • 发送请求
      • 添加断言
      • 创建测试场景
      • 共享 API 文档
      • 探索更多
    • 迁移到 Apidog
      • 概述
      • 手动导入
      • 定时导入(绑定数据源)
      • 导入选项
      • 导出数据
      • 导入自
        • 从 Postman 导入
        • 导入 OpenAPI 规范
        • 导入 cURL
        • 导入 Markdown
        • 从 Insomnia 导入
        • 从 apiDoc 导入
        • 导入 .har 文件
        • 导入 WSDL
  • Mock API 数据
    • 概述
    • Smart Mock
    • 自定义模拟
    • 模拟优先级顺序
    • 模拟脚本
    • 云端模拟
    • 自托管 Runner 模拟
    • 模拟语言(区域设置)
  • 账号与偏好设置
    • 账户设置
    • 生成 OpenAPI 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理配置
    • 备份数据
    • 更新 Apidog
    • 删除账户
    • 实验性功能
  • 发送请求
    • 概述
    • SSE 调试
    • MCP 客户端
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用请求代理 Agent 进行调试
    • 创建请求
      • 请求历史
      • 请求基础
      • 参数和主体
      • 请求头部
      • 请求设置
      • 调试请求
      • 将请求保存为端点
      • HTTP/2
    • 身份验证与授权
      • 概述
      • CA 和客户端证书
      • 授权类型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 身份验证
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 响应和 Cookie
      • 查看 API 响应
      • 管理 Cookie
      • 概述
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 调试用例
    • 测试用例
    • 动态值
    • 验证响应
    • Design-First vs Request-First
    • 生成代码
    • 环境与变量
      • 概览
      • 使用变量
      • 环境管理
    • Vault 密钥
      • 概述
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 动态值模块
      • Airline
      • 动物
      • 颜色
      • 商务
      • Company
      • 数据库
      • 数据类型
      • 日期
      • Finance
      • 食物
      • Git
      • Hacker
      • Helpers
      • 图像
      • Internet
      • 位置
      • Lorem
      • 音乐
      • 数字
      • Person
      • 电话
      • 科学
      • String
      • System
      • Vehicle
      • Word
    • 前置和后置处理器
      • 概述
      • 断言
      • 提取变量
      • 等待
      • 安全
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle 客户端
      • 使用脚本
        • 概述
        • 预处理器脚本
        • 后处理器脚本
        • 公共脚本
        • Postman 脚本参考
        • 调用其他编程语言
        • 使用 JS 库
        • 可视化响应
        • 脚本示例
          • 断言脚本
          • 使用变量
          • 修改请求
          • 其他示例
    • API 调试
      • AI Agent Debugger
      • A2A 调试器
  • 设计 API
    • 概述
    • 创建新的 API 项目
    • 端点基础
    • API 设计指南
    • 模块
    • 配置多个请求主体示例
    • 组件
    • 通用字段
    • 全局参数
    • 端点变更历史
    • 评论
    • 批量端点管理
    • 自定义协议 API
    • Spec-first 模式(Beta)
    • 安全方案
      • 概述
      • 创建安全方案
      • 使用安全方案
      • 在线文档中的安全方案
    • 高级功能
      • 自定义端点字段
      • 关联的测试场景
      • 端点状态
      • 参数列表的外观
      • 端点唯一标识
    • Schemas
      • 概述
      • 创建新 Schema
      • 构建 Schema
      • 从 JSON 等生成 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • Apidog Europe
    • Apidog Europe
  • API 测试
    • 概述
    • 测试场景
      • 创建测试场景
      • 在请求之间传递数据
      • 流程控制条件
      • 从端点和端点用例同步数据
      • 从其他项目导入端点和端点用例
      • 导出测试场景
    • 测试报告
      • 测试报告
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 共享测试数据
      • 定时任务
      • 管理来自其他项目的 API 运行环境
    • 测试套件
      • 概述
      • 创建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • 通过 CLI 运行测试套件
      • 定时任务
    • 测试 API
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
      • 契约测试
    • Apidog CLI
      • 概述
      • 安装和运行 Apidog CLI
      • Apidog CLI 选项
    • CI/CD
      • 概述
      • 与 Github Actions 集成
      • 与 Gitlab 集成
      • 与 Jenkins 集成
      • 通过 Git Commit 触发测试
  • 发布 API 文档
    • 概述
    • 支持的 API 技术
    • 快速分享
    • 查看 API 文档
    • Markdown 文档
    • 发布文档站点
    • 自定义登录页面
    • 自定义布局
    • 自定义 CSS、JavaScript、HTML
    • 自定义域名
    • AI 功能
    • SEO 设置
    • 高级设置
      • 文档搜索
      • CORS 代理
      • 集成 Google Analytics
      • 文件夹树设置
      • 可见性设置
      • 在文档 URL 中嵌入值
    • API 版本
      • 概述
      • 创建 API 版本
      • 发布 API 版本
      • 共享带有 API 版本的端点
  • 分支
    • 概述
    • 创建 Sprint 分支
    • 在分支中测试 API
    • 在分支中设计 API
    • 合并 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch(Beta)
  • AI 功能
    • 概述
    • 启用 AI 功能
    • 生成测试用例
    • 使用 AI 修改 Schema
    • 端点合规性检查
    • API 文档完整性检查
    • AI 驱动的字段命名
    • 常见问题
  • Apidog MCP 服务器
    • 概述
    • 将 Apidog 项目连接到 AI
    • 将已发布的文档连接到 AI
    • 将 OpenAPI 文件连接到 AI
  • 最佳实践
    • 处理 API 签名
    • 访问受 OAuth 2.0 保护的 API
    • 协作工作流
    • 管理身份验证状态
  • 离线空间
    • 概述
  • 管理
    • 管理项目
      • 管理项目
      • 通知设置
      • 管理项目成员
      • 项目资源
        • 数据库连接
        • Git 连接
    • 管理团队
      • 管理团队
      • 管理团队成员
      • 团队活动
      • 团队角色与权限
      • 团队资源
        • General Runner
        • 团队变量
        • 请求代理 Agent
      • 实时协作
        • 团队协作
    • 入门检查清单
      • 基本概念
      • 入门指南
    • 管理组织
      • 管理组织
      • 组织角色与权限
      • 套餐管理
        • 组织中的账单管理员
      • 单点登录 (SSO)
        • SSO 概述
        • 配置 Microsoft Entra ID
        • 配置 Okta
        • 为组织配置 SSO
        • 管理用户账户
        • 将组映射到团队
      • SCIM 配置
        • SCIM 预配简介
        • Microsoft Entra ID
        • Okta
      • 组织资源
        • 自托管 Runner
  • 计费
    • 概述
    • 积分
    • 升级您的套餐
    • 替代支付方式
    • 管理订阅
    • 将付费团队移入组织
  • 附加组件
    • API Hub
    • Apidog Intellij IDEA 插件
    • 浏览器扩展
      • Chrome
      • Microsoft Edge
    • 请求代理
      • Web 中的请求代理
      • 共享文档中的请求代理
      • 客户端中的请求代理
  • 数据与安全
    • 数据存储和安全
    • 用户数据隐私与安全
    • 请求路由与数据安全
  • 参考
    • API 设计优先方法
    • Apidog OpenAPI 规范扩展
    • JSONPath
    • XPath
    • 正则表达式
    • JSON Schema
    • CSV 文件格式
    • 安装 Java 环境
    • Runner 部署环境
    • Apidog Markdown 语法
    • Apidog Swagger 扩展
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 扩展
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支持中心
  1. 管理项目

通知设置

通知概览#

Apidog 支持你与第三方应用集成,以便在特定事件发生时向指定接收者发送通知。当某个特定事件被触发时,通知会实时发送到 Slack 等平台。目前支持的通知渠道包括:
Slack
Teams
Webhook
Jenkins
Email
只有项目管理员可以配置通知设置。目前,邮件通知仅适用于以下事件:
自动化测试完成/失败
持续集成完成/失败
定时任务完成/失败

通知目标#

通知目标是指在特定事件发生时,通过某个特定渠道接收消息的接收者。
要设置通知,首先需要通过指定名称、选择渠道并配置其设置来创建通知目标。每个渠道都有独特的设置流程。以下各节将逐步引导你完成配置。
通知设置.png

Slack#

Apidog 支持通过集成 Slack 应用 —— 指定 Channel 中的 Incoming WebHooks,并配置 Incoming WebHooks 的 Webhook URL,将通知事件发送到 Slack 中的特定 Channel,从而把事件消息发送到 Slack Channel。
配置字段说明:
配置字段必填描述
通知名称否为第三方集成通知命名,以记录其用途。
触发事件是支持的事件:API 变更、schema 变更、文档变更、导入数据、自动化测试
服务 URL是“Incoming WebHooks - Integration Settings” 中的 Webhook URL

将 Apidog 通知与 Slack 集成#

项目管理员可以使用第三方集成功能,将 Slack 中添加的 Slack 应用 —— Incoming WebHooks - Channels 与 Apidog 中的项目通知事件关联起来,以将相关 API 变更、文档变更、测试完成等推送到 Slack 中指定的 Channel。
步骤 1:打开频道详情
在 Slack 频道中,点击右上角的 “Open channel details” 选项。
CleanShot 2024-12-03 at 15.41.54@2x.png
步骤 2:安装 Incoming WebHook
在特定 Channel 的 Integrations - Apps 中,安装并添加 Incoming WebHook。
步骤 3:查看 Incoming WebHooks
安装完成后,点击 Incoming WebHooks 右侧的按钮 - View。
步骤 4:配置 Incoming WebHooks
这将打开 Incoming WebHooks 的说明页面,点击 Configuration 进行设置。
步骤 5:添加到 Slack
点击 Add to Slack。
步骤 6:选择 Channel 并添加集成
选择要推送 Apidog 通知事件消息的 Channel,然后点击 Add Incoming WebHooks integration。
步骤 7:获取 Webhook URL
获取并复制 Webhook URL。
步骤 8:在 Apidog 中创建通知目标
点击 “Settings” > “Notifications” > “Notification Targets” > 并创建一个新的通知目标。
创建新的 Slack 通知目标.png
填写通知目标名称。
选择 Slack 作为通知渠道。
将从 Incoming WebHooks 设置中获取的 Webhook URL 粘贴到 Service URL 中。
点击 Save 后,设置完成。现在你可以继续创建通知事件。
通知事件设置并触发后,你将在指定的 Slack 频道中收到消息。

Teams#

支持向 Microsoft Teams 发送通知,允许 Teams 中的 Workflows 使用这些消息作为后续操作的触发器——例如自动在群组或频道中发布消息——帮助团队及时了解来自 Apidog 的重要事件。
具体来说,你可以在 Workflow 中配置 Webhook Trigger。当 Apidog 中的某些通知事件被触发时(例如 API 变更、文档更新或自动化测试完成),Apidog 会向该触发器指定的 HTTP POST URL 发送 POST 请求,并携带事件 payload。
配置字段:
字段必填描述
Name是描述此通知目标用途的名称
HTTP POST URL是Workflow 中 Webhook Trigger 接收 POST 请求的 URL

将 Apidog 通知与 Teams 频道集成#

步骤 1:在 Teams 中创建 workflow
在 Microsoft Teams → Workflow 中,点击 Create,你可以通过选择模板 Post to a channel when a webhook request is received 快速开始。
image.png
步骤 2:设置流名称和账号
为流设置名称,选择合适的账号,然后点击 Next。
image.png
步骤 3:选择群组和频道
选择你希望接收通知的群组和频道,然后点击 Create flow。
image.png
步骤 4:获取 HTTP POST URL
流创建完成后,将显示触发步骤下的 HTTP POST URL。你可以直接复制它,或稍后在该流的触发步骤中找到它。
image.png
image.png
步骤 5:在 Apidog 中配置通知目标
将此 HTTP POST URL 粘贴到 Apidog 的通知目标配置中。
CleanShot 2025-06-10 at 11.55.15@2x.png
步骤 6:创建通知事件
在 Apidog 中创建通知事件,并将其与已配置的 Teams 通知目标关联。
CleanShot 2025-06-10 at 11.55.59@2x.png
步骤 7:验证 Teams 通知
当此通知事件被触发时,之前创建的 workflow 将自动向所选 Teams 频道发布消息。
image.png

Webhook#

支持向 HTTP Server 发送通知事件。你可以通过指定用于接收 POST 请求的 URL 地址,将事件消息发送到 HTTP Server。
配置字段说明:
配置字段必填描述
通知名称否为第三方集成通知命名,以记录通知用途。
触发事件是支持的事件:API 变更、数据模型变更、文档变更、导入数据、自动化测试
服务器 URL是用于接收请求的 HTTP Server 的 URL 地址
签名认证否发送的内容通过 HMAC SHA1 加密算法加密,使用 token 作为 KEY,以十六进制显示其值(需要配置 token),并包含前缀 sha1=

将 Apidog 通知与自托管 HTTP Server 集成#

项目管理员可以使用第三方集成,将其自托管 HTTP Server 与 Apidog 中的项目通知事件关联起来,以便在其 HTTP Server 中接收相关 API 变更、文档变更和自动化测试完成的通知。
要将 Apidog 通知与自托管 HTTP server 集成,请点击 “Settings” > “Notifications” > “Notification Targets” > 并创建一个新的通知目标。
创建新的 Webhook 通知目标.png
1.
填写通知目标名称。
2.
选择 Webhook 作为渠道。
3.
将自托管 HTTP Server 的 URL 粘贴到 Service URL 字段中。
4.
如果启用了签名验证,请将密钥复制并粘贴到 Signature Key 字段中。
点击 Save 后,设置完成。现在你可以继续创建通知事件。

Jenkins#

它支持向 Jenkins 服务发送通知事件。通过配置 Jenkins Webhook URL,可以将事件消息发送到 Jenkins。
配置字段说明:
配置字段必填描述
通知名称否为第三方集成通知命名,以记录其用途。
触发事件是API 变更、数据模型变更、导入数据、自动化测试。当上述任一事件发生时,将触发实时通知。
服务 URL是该 URL 在 Generic Webhook Trigger 插件中配置。
签名认证否通过 Authorization Bearer 头部发送到 Generic Webhook Trigger 插件。

将 Apidog 通知与 Jenkins 服务集成#

项目管理员可以使用第三方集成功能,将 Jenkins Generic Webhook Trigger 插件中配置的 Webhook URL 与 Apidog 中的项目通知事件关联起来,以便在 API 变更、文档变更和自动化测试完成等事件被触发时,自动在 Jenkins 中触发构建操作,并在构建历史中查看消息。
步骤 1:在 Jenkins Generic Webhook Trigger 插件中配置 Webhook URL
在 Jenkins Dashboard 上创建一个新的视图:
点击上一步中的视图,进入 Configure>Build Triggers,并选择 Generic Webhook Trigger。Webhook URL 为 "http://"+"your service address"+"/generic-webhook-trigger/invoke"
支持自定义 token:
步骤 2:创建新的通知目标
点击 “Settings” > “Notifications” > “Notification Targets” > 并创建一个新的通知目标。
Jenkins 通知设置.png
填写通知目标名称。
选择 Jenkins 作为渠道
将 Generic Webhook Trigger 插件中配置的 Webhook URL 粘贴到 Service URL 字段中
如果使用了自定义 token,请将 Token 复制并粘贴到 Signature Token 字段中。
点击 Save 后,设置完成。现在你可以继续创建通知事件。
通知事件设置并触发后,Jenkins 将自动发起构建操作,你可以在构建历史中查看消息:

Email#

可以通过电子邮件向指定邮箱地址发送通知。目前,邮件通知仅适用于以下事件:
自动化测试完成/失败
持续集成完成/失败
定时任务完成/失败
配置字段说明:
字段必填详情
名称是一个描述性名称,用于突出通知目标的用途或特点。
通知邮箱地址是输入用于接收通知的邮箱地址。你可以选择项目成员的邮箱地址,也可以手动输入地址。支持多个邮箱地址。

将 Apidog 通知与 Email 集成#

Email 通知设置.png
1.
填写通知目标名称。
2.
选择 Email 作为渠道
3.
输入邮箱
点击 Save 后,设置完成。现在你可以继续创建通知事件。

通知事件#

你可以创建通知事件,以指定哪些事件会触发通知并发送给指定接收者(通知目标)。要设置通知事件,你需要配置:
通知事件名称
触发事件
通知目标
创建通知事件.png

触发事件#

你可以从以下通知事件中选择,用于触发通知:
触发事件详情
端点已变更端点已创建
端点已更新
端点已删除
Schema 已变更Schema 已创建
Schema 已更新
Schema 已删除
文档已变更文档已创建
文档已更新
文档已删除
数据导入导入(手动导入)
导入(自动同步)
响应组件已变更响应组件已创建
响应组件已更新
响应组件已删除
Sprint 分支已变更Sprint 分支已合并
Sprint 分支已创建
Sprint 分支已归档
Sprint 分支已删除
Sprint 分支已恢复
API 版本已变更API 版本已创建
API 版本已删除
安全方案已变更安全方案已创建
安全方案已更新
安全方案已删除
TIP
对于与自动化测试相关的通知(例如自动化测试完成、持续集成完成、定时任务完成),你需要分别为每个测试场景配置设置。这种方式更加灵活,也更适合真实使用场景。

通知目标#

选择当触发事件发生时,哪些通知目标将接收通知。你可以从项目中已设置的通知目标中选择,并可根据需要选择多个目标。
但是,邮件通知仅支持以下三个特定事件:
自动化测试完成/失败
持续集成完成/失败
定时任务完成/失败
创建通知事件设置目标.png
Modified at 2026-06-09 08:55:47
Previous
管理项目
Next
管理项目成员
Built with