Querying a Webhook of a Specified Repository

Description

This API is used to obtain a webhook of a specified repository.

URI

GET /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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
hook_id	No	String	hook id

Request Parameters

**Table 3** 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.

Response Parameters

Status code: 200

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

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

**Table 6** RepoListHook
Parameter	Type	Description
hooks	Array of RepoHook objects	Hook list

**Table 7** 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

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

Response Examples

Status code: 200

Request succeeded

{
  "result" : {
    "hooks" : [ {
      "id" : 2111600786,
      "project_id" : 2111615967,
      "created_at" : "2021-11-09 16:35:15",
      "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
    } ]
  },
  "status" : "success"
}