更新时间:2024-11-19 GMT+08:00

Webhook设置

配置Webhook设置

开发人员可在Webhook界面配置第三方系统的URL,并根据项目需求订阅代码托管仓库的分支推送(push)、标签推送(tag push)等事件。当订阅事件发生时,可通过Webhook向第三方系统的URL发送 POST请求,用以触发自己系统(第三方系统)的相关操作,例如:触发自己系统(第三方系统)界面的通知弹窗;或触发自己系统(第三方系统)的构建、更新镜像、部署等操作。

Webhook设置位于仓库详情中的 设置 > 服务集成 > Webhook设置

此设置只针对被设置的仓库生效。仓库内的仓库成员可以查看该页面。

表1 新建Webhook字段说明

字段

说明

名称

可自定义名称。

描述

用于描述该WebHook。

URL

必填项。WebHook URL需第三方CI/CD系统提供。

Token类型

用于第三方服务WebHook接口鉴权,分为以下三项:

  • X-Repo-Token
  • X-Gitlab-Token
  • X-Auth-Token

Token

用于第三方CI/CD系统鉴权, 鉴权信息放在http请求header。

事件类型

系统可订阅以下事件:

  • 推送事件
    • 如果勾选推送事件,则出现分支过滤正则规则
      说明:

      分支过滤正则规则,默认为.*,代表全部分支,长度上限不超过500字符。

      分支过滤正则规则需符合正则表达式。

    • 在代码托管仓库进行代码更新,如LFS文件代码更新、子模块中代码更新、在线或本地Git客户端中推送代码更新均会触发该事件。
  • Tag推送事件

    在代码托管仓库新建或删除Tag会触发该事件。

  • 合并请求事件
    • 在代码托管仓库新建合并请求会触发该事件。
    • 在代码托管仓库更新合并请求会触发该事件。如更新代码内容/更新合并请求状态(关闭、重开)/更新合并请求标题或描述/更新合并人/更新工作项/删除源分支/更新Squash合并。
    • 在代码托管仓库合入合并请求会触发该事件。
  • 评论事件
    • 在代码托管仓库添加检视意见会触发该事件。如在代码文件中添加检视意见、在提交详情文件变更下添加检视意见、在合并请求文件变更中添加检视意见。
    • 在代码托管仓库提交详情和在合并请求详情中添加评论会触发事件。
  • 每个仓库最多只能设置20个Webhook。
  • 您在配置Webhook的时候,还可以选择设置您的Token,该Token会与您的Webhook URL关联,系统会将该Token放在请求头的X-Repo-Token字段发送给您。