配置Webhook
配置Webhook概述
开发人员可在Webhook界面配置第三方系统的URL,并根据项目需求订阅代码托管仓库的分支推送(push)、标签推送(tag push)等事件。当订阅事件发生时,可通过Webhook向第三方系统的URL发送POST请求,用以触发第三方系统的相关操作,例如:触发自己系统(第三方系统)界面的通知弹窗;或触发自己系统(第三方系统)的构建、更新镜像、部署等操作。
在配置合并请求规则前,用户请先查看约束与限制,满足配置权限的用户请根据配置Webhook设置进行配置,示例配置效果请查看相关文档。
约束与限制
限制类别 |
具体限制 |
---|---|
权限设置 |
当用户角色为“项目经理”或者“项目管理员”,可以设置项目级Webhook,请参考配置项目级的Repo权限配置权限。 |
功能限制 |
每个仓库最多只能设置20个Webhook。 |
字段 |
说明 |
取值样例 |
---|---|---|
名称 |
可自定义名称,最多200个字符。 |
Webhook_Test |
描述 |
非必填项。用于描述该Webhook,最多200个字符。 |
Test |
URL |
URL及其响应中均不能有敏感数据,如果一定要包含,需用户自行加解密以保证安全性。WebHook URL需第三方CI/CD系统提供。 |
https://example.com |
Token类型 |
非必填项。当用户想要用于第三方服务Webhook接口鉴权,鉴权信息放在http请求header,作为Key,和下一个参数“Token”结合使用,包含以下三个选项可选:
除上述三种用户也可以自定义输入Token类型。 用户在配置Webhook的时候,可以选择设置用户的Token,该Token会与用户的Webhook URL关联,系统会将该Token放在请求头的“X-Repo-Token”字段发送给用户。 |
X-Repo-Token |
Token |
非必填项。当用户选择“Token类型”参数后,该参数作为Value,和上一个参数“Token类型”结合使用。 用户自定义输入,最多2000个字符。用于第三方CI/CD系统鉴权,鉴权信息放在http请求header |
Token_Test |
事件类型 |
系统可订阅以下事件:
|
|