Configuring Notification Rules

Overview

Notification rules can be configured to use several methods: internal messages, emails, WeCom, DingTalk, Feishu, and generic webhooks. Internal messages and emails alert project members of relevant operations, while notifications via WeCom, DingTalk, Feishu, and generic webhooks are directed to their respective chat groups.

• Internal message/Email notification

  On the notification settings page, select the desired recipients and event types. Once set up, the chosen recipients will be alerted when specific events (for example, RR modification) take place.

• WeCom notifications

  On the notification settings page, configure the webhook address and event types. Once set up, WeCom will post notifications to the designated chat group when specific events (for example, RR modification) take place.

• DingTalk/Feishu

  On the DingTalk/Feishu notification settings page, configure the webhook URL and event types for the group chatbot. Once set up, DingTalk or Feishu will post notifications to the designated chat group when specific events (for example, RR modification) take place.

• Generic webhook

  On the webhook page, configure the third-party system's URL and subscribe to the desired event types. Once set up, a request will be sent to the configured URL via webhook when the subscribed events occur.

Prerequisites

• To configure internal message, email, and WeCom notifications, you must have the Config > Notifications permissions for IPD-system device projects. For details, see How Do I Check and Obtain Required Project Permissions?

  

• To configure DingTalk, Feishu, and generic webhook notifications, you must be a project administrator or project manager in an IPD-system device project. For details, see How Do I Check and Obtain Required Project Permissions?

Configuring Internal Message and Email Notifications

1. Access the CodeArts Req homepage.
2. Go to a project and choose Settings > Work > Notifications.
3. Select desired work items for notifications. Select or deselect notification recipients and events.
   After the setting is complete, the selected recipients will be notified when a corresponding event (for example, RR modification) occurs.

   

   After the setting is complete, to send a reminder, click on the right of the work item details page and select remind. The current owner of the work item will receive the reminder notification. An example of reminding an IR is as follows.

   

   • Direct Message: When a member logs in to the CodeArts Req homepage, they will see the number of internal messages displayed next to in the upper right corner. They can click the icon to view notification details.

     

   • Email: Project members who have an email address configured for their user and have enabled Notifications on the This Account Settings page will receive notification emails from the service.

     

Configuring WeCom Notifications

1. Access the CodeArts Req homepage.
2. Go to a project and choose Settings > Work > Notifications.
3. Enter a Webhook Address.

   To obtain the webhook address, perform the following steps:

   1. Open the WeCom group where you want to receive notifications, and click the ··· button in the upper right corner.
   2. Click Group Robot.
   3. Click the created group robot to copy the generated webhook URL.

4. Select event types.

   Event types include operations on raw requirements, system features, R&D requirements, tasks, bugs, reviews, and plans. Select operations as required.

5. Click OK.

   After the configuration is complete, WeCom will send notifications to the WeCom chat group when specified events occur.

   

Configuring DingTalk and Feishu Notifications

Notifications can be pushed via DingTalk and Feishu. Set parameters and configure the notification content as required.

1. Access the CodeArts Req homepage.
2. Go to a project and choose Settings > General > Notifications.
3. On the Notifications page, choose DingTalk or Feishu > CodeArtsReq. The DingTalk or Feishu setting page of IPD-system device projects is displayed.
4. Set parameters according to Table 1.

   Table 1 DingTalk/Feishu notification parameters

   Parameter	Description	Example
   URL	URL of a notification from the DingTalk or Feishu group chatbot.	DingTalk chatbot: https://oapi.dingtalk.com/robot/send?access_token=373fa3c1ff75e8e9ce71742f544081bd562a99c996eb7911a051c1b43538beca
   Event type	Type of the event to be notified of. Event types include operations on raw requirements, system features, R&D requirements, tasks, bugs, reviews, and plans. Select operations as required.	RR > Comment RR
   @User IDs	(Optional) User IDs of DingTalk or Feishu members who receive the notifications. @User IDs: Mentions specified members in the group. @all: Mentions all members in the group. Separate multiple user IDs with semicolons (;). Format: A user ID can only contain letters, digits, semicolons (;), and the following special characters: .-_@. Length: 1 to 64 characters.	testA;testB
   @Mobile Numbers	Phone numbers to receive messages. This parameter is available for DingTalk but not for Feishu. Format: Use semicolons (;) to separate multiple mobile numbers. The maximum length is 1,000 characters.	None
   Additional Signature	(Optional) Only available when DingTalk or Feishu notifications are configured. If signature-based encryption is enabled in the security settings of the DingTalk or Feishu robot, enter the signing secret.	None

5. Click Save and Enable Notification to save the settings and enable the notification.
   

   • You can also click Save to save the settings and then click on CodeArts Req to enable the notification.
   • If you do not need to send notifications, click on CodeArts Req to disable the notification.

   After the configuration is complete, when a notification event occurs, DingTalk sends the notification to the corresponding chat group, as shown in the following figure.

   

Configuring Generic Webhook Notifications

Notifications can be pushed via generic webhook.

1. Access the CodeArts Req homepage.
2. Go to a project and choose Settings > General > Notifications.
3. On the Notifications page, choose Generic webhook > CodeArtsReq. The webhook setting page of IPD-system device projects is displayed.
4. Click New Webhook Subscription.
5. Set parameters according to Table 2.

   Table 2 Webhook notification parameters

   Parameter	Description	Example
   Subscription Event Name	(Mandatory) Name of the subscription event. The name is user-defined and can contain a maximum of 200 characters.	req-Webhook_test
   URL	URL of a webhook notification. The value must start with https:// or http://.	Feishu chatbot: https://open.feishu.cn/open-apis/bot/v2/hook/ffd39b45-d8c6-4771-9bb2-0a3b28c86fd7
   Event type	Type of the event to be notified of. Event types include operations on raw requirements, system features, R&D requirements, tasks, bugs, reviews, and plans. Select operations as required.	Comment RR Commit Review Update IR
   HTTP Request Headers	(Optional) Request headers required for sending messages. HTTP request header, which is a JSON array. The maximum length of a single request header is 100 characters, and a maximum of 20 request headers can be entered. The format of a request header is key:value.	Content-Type:application/json
   Custom Templates	Custom templates of generic webhook notifications. Obtain the corresponding values of configurable variables through the ${} method. For details about the configurable variables, see Table 3. The maximum length of the character string is 1,000.	DingTalk parameters: {"msgtype":"text","text":{"content":"{\"Product name\":\"Requirement name\",\"reviewId\":\"${review.id}\",\"reviewStatus\":\"${review.status}\",\"reviewStatusName\":\"${review.status.name}\",\"operation\":\"${operation}\",\" ID \":\"${issue.number}\",\"Submitter ID\":\"${issue.submitted_by.id}\",\"Creator ID\":\"${issue.created_by.id}\",\"Owner \":\"${issue.assignee.name}\",\"project_id\":\"${project.id}\",\"issue_title\":\"${issue.title}\",\"Operator\":\"${operator.username}\",\"Operator ID\":\"${operator.id}\",\"Review\":\"${review.title}\",\"Review URL\":\"${review.url}\",\"Work item ID\":\"${issue.id}\",\"Work item type \":\"${issue.type}\",\"priority_change\":\"${issue.modified_fields.priority}\",\"issue_create\":${issue.create_fields._all},\"assignee_change\":${issue.modified_fields.assignee},\"Modify custom fields\":${issue.modified_fields.c7442403074245795840},\"all_fields_change\":${issue.modified_fields._all}}"}} Feishu parameters: {"msg_type":"text","content":{"text":"CodeArts Req - Generic webhook test\nProject ID: ${project.id}\nProject URL: ${project.url}\nWork item ID: ${issue.id}\nWork item name: ${issue.title}\nWork item URL: ${issue.url}\nOperator: ${operator.username}\nOperator ID: ${operator.id}\nReview ID: ${review.id}\nReview: ${review.title}\nReview URL: ${review.url}\nEvent name: ${operation}"}}

   Table 3 Configurable variables in generic webhook custom templates

   Variable	Description
   project.id	Project ID.
   project.url	Project URL.
   issue.id	Work item ID.
   issue.url	Work item URL.
   issue.type	Work item type.
   issue.title	Work item title.
   operator.username	Operator username.
   operator.id	Operator ID.
   review.id	Review ID.
   review.title	Review title.
   review.url	Review URL.
   review.status	Review status.
   review.status.name	Review status display name.
   operation	Event name.
   issue.number	Work item ID.
   issue.created_by.id	Creator user ID.
   issue.created_by.name	Creator display name.
   issue.submitted_by.id	Submitter user ID.
   issue.submitted_by.name	Submitter display name.
   issue.assignee.id	User ID of the owner.
   issue.assignee.name	Owner display name.
   issue.modified_fields._all	A list of all modified fields. The value is in the form of a JSON array.
   issue.modified_fields.{field_code}	Fields to be included in notifications when editing a work item. {field_code} indicates the specific field. For example, issue.modified_fields.priority indicates that the priority field is included in the notification when a work item is edited. The value is in the form of JSON objects.
   issue.create_fields._all	Content of the notification sent when a work item is created, including the title, ID, status, project, feature set (only for SFs), current owner, priority, and severity (only for bugs).

6. Click OK to save the settings.

   After the configuration is complete, when a subscription event occurs, the system sends a request to the URL of the third-party system (Feishu) via webhook, as shown in the following figure.

   

   If you do not need to send notifications, click in the row that contains the corresponding event name in the subscription event list of CodeArts Req to disable notifications.