更新时间:2023-07-25 GMT+08:00

Webhook设置

Webhook简介

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

若您需要用发送邮件作为仓库变化的通知方式,可通过配置“基本设置”中的通知设置实现。

Webhook设置

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。

事件类型

系统可订阅以下事件:

  • 推送事件
  • Tag推送事件
  • 合并请求事件
  • 评论事件
  • 每个仓库最多只能设置20个Webhook。
  • 您在配置Webhook的时候,还可以选择设置您的Token,该Token会与您的Webhook URL关联,系统会将该Token放在请求头的X-Repo-Token字段发送给您。