文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ WebHook/ 添加项目下Webhook
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

添加项目下Webhook

功能介绍

添加项目下Webhook

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v4/projects/{project_id}/hooks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

取值范围：

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

url

否

String

参数解释：

webhook地址。

取值范围：

字符串长度不少于0，不超过500。

push_events

否

Boolean

参数解释：

是否启用推送事件。

push_events_branch_regex_filter

否

String

参数解释：

推送事件分支过滤正则规则。

取值范围：

字符串长度不少于0，不超过500。

tag_push_events

否

Boolean

参数解释：

是否启用Tag推送事件。

merge_requests_events

否

Boolean

参数解释：

是否启用合并请求事件。

note_events

否

Boolean

参数解释：

是否启用评论事件。

token

否

String

参数解释：

token值，作为返回值时会使用掩码代替实际值。

取值范围：

字符串长度不少于0，不超过2000。

token_type

否

String

参数解释：

token类型，默认为X-Repo-Token。

取值范围：

字符串长度不少于0，不超过200。

name

否

String

参数解释：

名称。

取值范围：

字符串长度不少于0，不超过200。

description

否

String

参数解释：

描述。

取值范围：

字符串长度不少于0，不超过200。

响应参数

状态码：201

表4 响应Body参数

参数

参数类型

描述

url

String

参数解释：

webhook地址。

取值范围：

字符串长度不少于0，不超过500。

push_events

Boolean

参数解释：

是否启用推送事件。

push_events_branch_regex_filter

String

参数解释：

推送事件分支过滤正则规则。

取值范围：

字符串长度不少于0，不超过500。

tag_push_events

Boolean

参数解释：

是否启用Tag推送事件。

merge_requests_events

Boolean

参数解释：

是否启用合并请求事件。

note_events

Boolean

参数解释：

是否启用评论事件。

token

String

参数解释：

token值，作为返回值时会使用掩码代替实际值。

取值范围：

字符串长度不少于0，不超过2000。

token_type

String

参数解释：

token类型，默认为X-Repo-Token。

取值范围：

字符串长度不少于0，不超过200。

name

String

参数解释：

名称。

取值范围：

字符串长度不少于0，不超过200。

description

String

参数解释：

描述。

取值范围：

字符串长度不少于0，不超过200。

id

Integer

参数解释：

Webhook id。

取值范围：

1-2147483647

created_at

String

参数解释：

创建时间。

参数解释：

yyyy-MM-dd'T'HH:mm:ss.SSSXXX

updated_at

String

参数解释：

更新时间。

参数解释：

yyyy-MM-dd'T'HH:mm:ss.SSSXXX

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

POST https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/hooks

{
  "url" : "https://demo1.com",
  "push_events" : true,
  "push_events_branch_regex_filter" : ".*",
  "tag_push_events" : true,
  "merge_requests_events" : false,
  "note_events" : false,
  "token" : "exampletoken",
  "token_type" : "X-Repo-Token",
  "name" : "代码检查",
  "description" : "代码检查"
}

响应示例

状态码：201

OK

{
  "id" : 2,
  "url" : "https://demo1.com",
  "push_events" : true,
  "push_events_branch_regex_filter" : ".*",
  "tag_push_events" : true,
  "merge_requests_events" : false,
  "note_events" : false,
  "token" : "************",
  "token_type" : "X-Repo-Token",
  "name" : "代码检查",
  "description" : "代码检查",
  "created_at" : "2024-10-15T22:30:24.000+08:00",
  "updated_at" : "2024-10-15T22:30:24.000+08:00"
}

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

201

OK

401

Unauthorized

错误码

请参见错误码。

父主题： WebHook

相关文档