Skip to main content
Webhook 是预置代码仓库连接器和企业定制集成常用的事件通知机制。平台向 PawSQL 或企业集成服务发送事件,由接收方解析仓库、提交、分支和变更信息。

目标

了解事件驱动集成中的签名、过滤、异步处理、重试和重复事件控制。

准备工作

无特殊前置条件。

适用事件

配置流程

1

创建集成配置

在 PawSQL 或企业集成服务中确定目标项目、工作空间、审核策略和允许的仓库。
2

生成地址和密钥

获取 Webhook 接收地址并生成独立密钥。不同仓库或环境不应共用无法追踪的凭据。
3

配置仓库事件

在代码平台中填写地址和密钥,选择 Push 或合并请求等需要的事件。
4

设置过滤条件

限定分支、目录、文件扩展名和事件动作,减少无效工单。
5

发送测试事件

确认请求被接收、签名验证成功,并能够创建对应 PawSQL 工单。
6

验证结果回传

检查提交状态、合并请求评论或流水线结果是否包含正确的工单链接和结论。

安全要求

  • 仅接受 HTTPS 请求;
  • 校验平台提供的签名或共享密钥;
  • 限制请求体大小并设置合理超时;
  • 记录事件 ID,但不在日志中保存凭据和完整敏感 SQL;
  • 对允许的仓库、组织和事件类型执行白名单检查;
  • 定期轮换密钥,并为轮换保留短暂的双密钥窗口。

重试与重复事件

Webhook 发送方可能因超时重复投递事件。接收方应以平台事件 ID 为首选幂等键;没有事件 ID 时,可组合平台、仓库、提交、事件动作和策略版本生成稳定标识。
Webhook 返回成功只表示事件已被接收,不代表 SQL 审核已经完成。长时间分析应异步执行,并通过工单查询或回调获取最终结果。

验证结果

成功接入后,应能从一次测试事件追踪到代码提交、PawSQL 工单、审核策略、门禁结论和结果回传记录。若任一关联缺失,请参阅CI/CD 集成故障排查