Help Center/ CodeArts Repo/ API Reference (Ally Region)/ APIs/ Webhook/ Adding a Hook to a Specified Repository

Updated on 2026-01-08 GMT+08:00

View PDF

Adding a Hook to a Specified Repository

Description

A code commit automatically triggers building and addition of a repository hook.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Repository group name (Segment following the domain name and before the repository name in the clone address. Example: git@repo.alpha.devcloud.test.com:Demo00228/testword.git. Repository group name: Demo00228.)
repository_name	Yes	String	Repository name

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
hook_url	Yes	String	Trigger URL
service	Yes	String	Event source
token	No	String	Security token
hook_events	Yes	Array of strings	Trigger events

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error
result	RepoHook object	Response result
status	String	Response status

**Table 5** Error
Parameter	Type	Description
code	String	Error codes
message	String	Error message

**Table 6** RepoHook
Parameter	Type	Description
build_events	Boolean	Whether to trigger build_events
created_at	String	Repository statistics creation time
enable_ssl_verification	Boolean	Whether to use SSL authentication
id	Integer	hook id
issues_events	Boolean	Whether to trigger issues_events
merge_requests_events	Boolean	Whether to trigger merge_requests_events
note_events	Boolean	Whether to trigger note_events
pipeline_events	Boolean	Whether to trigger pipeline_events
project_id	Integer	Repository ID
push_events	Boolean	Whether to trigger push_events
repository_update_events	Boolean	Whether to trigger repository_update_events
tag_push_events	Boolean	Whether to trigger tag_push_events
wiki_page_events	Boolean	Whether to trigger wiki_page_events

Request Examples

POST https://{endpoint}/v1/repositories/{group_name}/{repository_name}/hooks

{
  "service" : 11,
  "token" : "test",
  "hook_url" : "https://alpha.devcloud.test.com/",
  "hook_events" : [ "push_events" ]
}

Response Examples

Status code: 200

Request succeeded

{
  "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"
}