代码托管 CODEARTS REPO-为指定项目添加Webhook:请求参数

时间:2024-10-26 11:09:47

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

url

String

参数解释:

Webhook Url

取值范围:

不涉及。

push_events

Boolean

参数解释:

是否触发推送事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

tag_push_events

Boolean

参数解释:

是否触发Tag推送事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

merge_requests_events

Boolean

参数解释:

是否触发合并请求事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

note_events

Boolean

参数解释:

是否触发评论事件

取值范围:

  • true:该事件触发
  • false:该事件不触发

token

String

参数解释:

Token(已加密)

取值范围:

不涉及。

name

String

参数解释:

Webhook 名称

取值范围:

必须为UTF-8字符

description

String

参数解释:

Webhook 描述

取值范围:

必须为UTF-8字符

token_type

String

参数解释:

Token 类型

取值范围:

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

push_events_branch_regex_filter

String

参数解释:

分支过滤正则规则,勾选推送事件需配置

取值范围:

必须为正则表达式

support.huaweicloud.com/api-codeartsrepo/zh-cn_topic_0000002043143121.html