Obtaining the Webhook List Under a Project

Function

This API is used to obtain the webhook list under a project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo::getProjectSetting	Read	-	codeartsrepo:ProjectId	-	-

URI

GET https://{hostURL}/v4/projects/{project_id}/hooks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition You can call the API used to query project list to query the project list to obtain the unique 32-character UUID of the project. Range A string that can contain 32 characters.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Definition Number of returned records. Value range: 1~100 Default value: 20

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token 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. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Total	String	Definition Total number of results of the current request.

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of WebhookDto objects	Definition Webhook data.

**Table 6** WebhookDto
Parameter	Type	Description
url	String	Definition Webhook URL. Range Mandatory. Max. 500 characters.
push_events	Boolean	Definition Whether to enable the push event.
push_events_branch_regex_filter	String	Definition Regular expression for push event branches filtering. Range Mandatory. Max. 500 characters.
note_plain_text_filter	Array of strings	Definition Filtering rules of event comment text. Range 0–50 characters for each string. Max. 10 strings.
tag_push_events	Boolean	Definition Whether to enable the tag push event.
merge_requests_events	Boolean	Definition Whether to enable the MR event.
note_events	Boolean	Definition Whether to enable the comment event.
token	String	Definition Token value. When it is used as the return value, the mask is used to replace the actual value. Range Mandatory. Max. 2,000 characters.
token_type	String	Definition Token type. The default value is X-Repo-Token. Range Mandatory. Max. 200 characters.
name	String	Definition Name. Range Mandatory. Max. 200 characters.
description	String	Definition Description. Range Mandatory. Max. 200 characters.
event_cfgs	Array of WebHookEventCfgDto objects	Definition Reserved field for setting event triggering. This parameter can be left empty.
project_cfgs	Array of WebHookBranchCfgDto objects	Definition Reserved field for setting repository branch rules. This parameter can be left empty.
branch_cfgs	Array of WebHookBranchCfgDto objects	Definition Reserved field for setting repository branch rule. This parameter can be left empty. Constraints Reserved field, only valid for repository settings.
id	Integer	Definition Webhook ID. Value range: 1~2147483647
created_at	String	Definition Creation time. Definition yyyy-MM-dd'T'HH:mm:ss.SSSXXX
updated_at	String	Definition Update time. Definition yyyy-MM-dd'T'HH:mm:ss.SSSXXX
service	String	Definition Internal service name.

**Table 7** WebHookEventCfgDto
Parameter	Type	Description
event_type	String	Definition Event type. Range 1 to 255 bytes.
cfgs	String	Definition Configuration information. Range 1 to 255 bytes.

**Table 8** WebHookBranchCfgDto
Parameter	Type	Description
branch_type	Integer	Definition Branch type. Range 0: Text. 1: Wildcard. 2: Regular expression. Default value: 0 Enumeration values: 0 1 2
branch	String	Definition Branch name configuration. Range 1 to 255 bytes.
project_type	Integer	Definition Repository name type. Range 0: Text. 1: Wildcard. 2: Regular expression. Default value: 0 Enumeration values: 0 1 2
project	String	Definition Repository name configuration. Range 1 to 255 bytes.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

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

Example Responses

Status code: 200

[ {
  "id" : 1,
  "url" : "https://demo.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" : "Code check",
  "description" : "Code check",
  "created_at" : "2024-10-15T22:30:24.000+08:00",
  "updated_at" : "2024-10-15T22:30:24.000+08:00"
}, {
  "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" : "Code check",
  "description" : "Code check",
  "created_at" : "2024-10-15T22:30:24.000+08:00",
  "updated_at" : "2024-10-15T22:30:24.000+08:00"
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Bad Request

Error Codes

See Error Codes.

Parent topic: WebHook

Previous topic: Deleting a Webhook from a Repository Group

Next topic: Adding Webhooks to a Project

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot