文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Webhook/ 为指定仓库添加Webhook
更新时间：2024-10-26 GMT+08:00
查看PDF
分享

为指定仓库添加Webhook

功能介绍

添加仓库Webhook

调试

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

URI

POST /v1/repositories/{group_name}/{repository_name}/hooks

表1 路径参数

参数

是否必选

参数类型

描述

group_name

是

String

组名(克隆地址中域名后面仓库名前的一段 示例：git@repo.alpha.devcloud.intest.com:Demo00228/testword.git 组名：Demo00228 )

repository_name

是

String

仓库名

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

hook_url

是

String

触发url

service

是

String

事件来源

token

否

String

安全令牌

hook_events

是

Array of strings

触发事件

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

RepoHook object

响应结果

status

String

响应状态
表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表6 RepoHook

参数

参数类型

描述

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

错误码

请参见错误码。

父主题： Webhook

相关文档