为指定仓库添加Webhook
功能介绍
添加仓库Webhook
URI
POST /v1/repositories/{group_name}/{repository_name}/hooks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_name |
是 |
String |
组名(克隆地址中域名后面仓库名前的一段 示例:git@repo.alpha.devcloud.intest.com:Demo00228/testword.git 组名:Demo00228 ) |
|
repository_name |
是 |
String |
仓库名 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
hook_url |
是 |
String |
触发url |
|
service |
是 |
String |
事件来源 |
|
token |
否 |
String |
安全令牌 |
|
hook_events |
是 |
Array of strings |
触发事件 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
build_events |
Boolean |
是否触发build_events事件 |
|
created_at |
String |
仓库统计创建的时间 |
|
enable_ssl_verification |
Boolean |
是否使用ssl验证 |
|
id |
Integer |
hook id |
|
issues_events |
Boolean |
是否触发issues_events事件 |
|
merge_requests_events |
Boolean |
是否触发merge_requests_events事件 |
|
note_events |
Boolean |
是否触发note_events事件 |
|
pipeline_events |
Boolean |
是否触发pipeline_events事件 |
|
project_id |
Integer |
仓库id |
|
push_events |
Boolean |
是否触发push_events事件 |
|
repository_update_events |
Boolean |
是否触发repository_update_events事件 |
|
tag_push_events |
Boolean |
是否触发tag_push_events事件 |
|
wiki_page_events |
Boolean |
是否触发wiki_page_events事件 |
请求示例
POST https://{endpoint}/v1/repositories/{group_name}/{repository_name}/hooks
{
"service" : 11,
"token" : "test",
"hook_url" : "https://alpha.devcloud.intest.com/",
"hook_events" : [ "push_events" ]
}
响应示例
状态码: 200
OK
{
"result" : {
"id" : 5609,
"project_id" : 453489,
"created_at" : "2019-10-23 17:29:56",
"enable_ssl_verification" : false,
"push_events" : true,
"tag_push_events" : false,
"repository_update_events" : false,
"merge_requests_events" : false,
"issues_events" : false,
"note_events" : false,
"pipeline_events" : false,
"wiki_page_events" : false,
"build_events" : null
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。