Modifying the Instance-Level Notification Configuration of a Pipeline

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

type

No

Integer

Definition:

Pipeline notification type.

Constraints:

N/A

Range:

• 1: System messages.

• 2: Email notifications.

• 3: WeCom.

• 4: DingTalk.

• 5: Feishu.

• 6: Webhooks.

Default value:

N/A

event

No

EventStatusDTO object

Definition:

Configuration of notification events from third parties.

Constraints:

N/A

Range:

N/A

Default value:

N/A

webhook_config

No

ThirdPartEventDTO object

Definition:

Configuration of notification events from third parties.

Constraints:

N/A

Range:

N/A

Default value:

N/A

id

No

String

Definition:

Event type.

Constraints:

N/A

Value range:

• pipeline.updated: The pipeline configuration is updated.

• pipeline.deleted: The pipeline is deleted.

• pipelineRun.succeed: The pipeline is executed successfully.

• pipelineRun.failed: The pipeline fails to be executed.

Default value:

N/A

selected

No

Boolean

Definition:

Whether to enable event notifications.

Constraints:

N/A

Value range:

• true: enable notifications.

• false: disable notifications.

Default value:

N/A

notice_roles

No

Array of strings

Definition:

Recipient list.

Constraints:

N/A

Range:

N/A

Default value:

N/A

notice_id

No

String

Definition:

Third-party notification configuration ID, the unique identifier of the third-party notification.

Constraints:

N/A

Range:

N/A

Default value:

N/A

url

No

String

Definition:

URL of the third-party notification. It can be obtained from the corresponding third-party platform.

Constraints:

The URL must start with http:// or https://.

Range:

N/A

Default value:

N/A

events

No

Array of strings

Definition:

Pipeline event type.

Constraints:

N/A

Range:

• pipelineRun.succeed: completed.

• pipelineRun.failed: failed.

• pipelineRun.pause: paused.

• pipelineRun.suspend: suspended.

• pipelineRun.ignored: ignored.

Default value:

N/A

options

No

Array of strings

Definition:

Notification content list.

Constraints:

N/A

Range:

N/A

Default value:

N/A

mentioned_list

No

Array of strings

Definition:

Third-party user ID list. User IDs are separated by commas (,).

Constraints:

N/A

Range:

N/A

Default value:

N/A

mentioned_mobile_list

No

Array of strings

Definition:

Mobile number list.

Constraints:

N/A

Range:

N/A

Default value:

N/A

secret_info

No

String

Definition:

Signature key.

Constraints:

(Optional) Enter this parameter only when you have enabled security settings for the DingTalk, Feishu custom robots.

Value range:

N/A

Default value:

N/A

error

ErrorInfo object

Definition:

Error information. If no error is reported, the error field is not returned.

Range:

N/A

result

Object

Definition:

Returned result.

Range:

N/A

status

String

Definition:

Status value.

Value range:

N/A

code

String

Definition:

Error code.

Value range:

N/A

message

String

Definition:

Error message.

Value range:

N/A

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found