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

Updating the Webhook Switch for Triggering Checks

Function

This API is used to set the MR trigger and code commit trigger based on the task ID. This function allows you to automatically trigger a code check task when you create an MR or commit code in CodeArts Repo.

Calling Method

For details, see Calling APIs.

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
codeartscheck:task:update	Write	task *	-	-	-
codeartscheck:task:update	Write	-	codeartscheck:ProjectId	-	-

URI

PUT /v4/tasks/{task_id}/webhook

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Definition Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID. Constraints N/A Range 1 to 32 characters. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Encoding format. Constraints N/A Range N/A Default Value application/json: The return value is in JSON format for any input value.
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range The length is the value of [1-100000]. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
is_set_mr_webhook	No	Boolean	Definition: Whether to enable the function of triggering a code check task when a merge request is created. true: enabled; false: disabled. Constraints: N/A Range: true: enabled. false: disabled. Default value: N/A
is_set_push_webhook	No	Boolean	Definition: Whether to enable the function of triggering a code check task upon code commit. true: enabled; false: disabled. Constraints: N/A Range: true: enabled. false: disabled. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	String	Definition: If the setting is successful, the message "CodeArts Repo integration setting updated" is returned.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Modify the integration service configuration of the task whose ID is 8df8d58f832a408f88e4aebea0ff6fc5. Enable the merge request trigger and disable the code commit trigger.

PUT https://{endpoint}/v4/tasks/8df8d58f832a408f88e4aebea0ff6fc5/webhook

{
  "is_set_mr_webhook" : true,
  "is_set_push_webhook" : false
}

Example Responses

Status code: 200

Request succeeded.

{
  "result" : "CodeArts Repo integration setting updated."
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management