Configuring Pipeline Notifications

Pipeline Notification

Pipeline notifications inform users or systems about pipeline activities. Subscribing to specific events helps you stay updated on pipeline statuses and execution results. You can configure event notifications (pop-ups, emails, Feishu, WeCom, and DingTalk notifications) for a pipeline.

Constraints

• By default, only pop-up notifications will be sent.
• WeCom, DingTalk, and Feishu notifications are available only in the AP-Singapore region.

Prerequisites

• You have enabled and authorized CodeArts Pipeline.
• Your role is a project administrator or pipeline creator. For details about how to configure permissions, see Authorizing CodeArts Pipeline.

Configuring Notifications from CodeArts Pipeline

You can configure pop-ups to inform creators, executors, and users who have favorited pipelines of pipeline events (deletion, failure, success, and updates).

1. Access the CodeArts Pipeline homepage.
2. On the pipeline list page, search for the target pipeline, click in the Operation column, and select Edit.
3. Switch to the Notifications page.
4. Enable From CodeArts Pipeline, and enable or disable notifications as needed.
   • You can click in the upper right corner of the CodeArts Pipeline homepage and check the notification messages in the Messages window.
   Figure 1 Configuring notifications from CodeArts Pipeline
   

5. After the configuration, click Save. A message is displayed, indicating that the pipeline is saved successfully.

Configuring Email Notifications

You can configure email notifications to inform creators, executors, and users who favorite pipelines of pipeline activities (deletion, failure, success, and updates).

1. Access the CodeArts Pipeline homepage.
2. On the pipeline list page, search for the target pipeline, click in the Operation column, and select Edit.
3. Switch to the Notifications page.
4. Enable Email, and enable or disable notifications as needed.
   Figure 2 Configuring email notifications
   

5. After the configuration, click Save. A message is displayed, indicating that the pipeline is saved successfully.

Configuring WeCom Notifications

Push pipeline activities to WeCom.

1. Access the CodeArts Pipeline homepage.
2. On the pipeline list page, search for the target pipeline, click in the Operation column, and select Edit.
3. Switch to the Notifications page.
4. Enable WeCom and set parameters.
   Figure 3 Configuring WeCom notifications
   

   Table 1 Parameters of WeCom notifications

   Parameter	Description
   URL	Enter the URL of the WeCom robot notifications. The URL must start with http:// or https://, for example, https://xxxxx.
   Notify When	Select the pipeline status to be notified: completed, failed, paused, suspended, and ignored.
   Content	Select the content to be notified: Pipeline name, Execution description, Executor, Triggering information, Project name, Execution time, and Status.
   @user_id	Enter the user IDs receiving notifications. Use commas (,) to separate multiple user IDs.

5. After the configuration, click Save. A message is displayed, indicating that the pipeline is saved successfully.

Configuring DingTalk Notifications

Push pipeline activities to DingTalk.

1. Access the CodeArts Pipeline homepage.
2. On the pipeline list page, search for the target pipeline, click in the Operation column, and select Edit.
3. Switch to the Notifications page.
4. Enable DingTalk and set parameters.
   Figure 4 Configuring DingTalk notifications
   

   Table 2 Parameters of DingTalk notifications

   Parameter	Description
   URL	Enter the URL of the DingTalk robot notifications. The URL must start with http:// or https://, for example, https://xxxxx.
   Notify When	Select the pipeline status to be notified: completed, failed, paused, suspended, and ignored.
   Content	Select the content to be notified: Pipeline name, Execution description, Executor, Triggering information, Project name, Execution time, and Status.
   @user_id	Enter the user IDs receiving notifications. Use commas (,) to separate multiple user IDs.
   @Mobile Number	Enter the mobile numbers receiving notifications. Use commas (,) to separate multiple numbers.
   Additional Signature	(Optional) Enter this parameter only when you have enabled security settings for the DingTalk custom robot.

5. After the configuration, click Save. A message is displayed, indicating that the pipeline is saved successfully.

Configuring Feishu Notifications

Push pipeline activities to Feishu.

1. Access the CodeArts Pipeline homepage.
2. On the pipeline list page, search for the target pipeline, click in the Operation column, and select Edit.
3. Switch to the Notifications page.
4. Enable Feishu and set parameters.
   Figure 5 Configuring Feishu notifications
   

   Table 3 Parameters of Feishu notifications

   Parameter	Description
   URL	Enter the URL of the Feishu robot notifications. The URL must start with http:// or https://, for example, https://xxxxx.
   Notify When	Select the pipeline status to be notified: completed, failed, paused, suspended, and ignored.
   Content	Select the content to be notified: Pipeline name, Execution description, Executor, Triggering information, Project name, Execution time, and Status.
   @user_id	Enter the user IDs receiving notifications. Use commas (,) to separate multiple user IDs.
   Additional Signature	(Optional) Enter this parameter only when you have enabled security settings for the Feishu custom robot.

5. After the configuration, click Save. A message is displayed, indicating that the pipeline is saved successfully.