Updated on 2025-08-01 GMT+08:00

Configuring Notifications

  • Notifications can be sent via system messages, emails, DingTalk, Feishu, or generic webhooks.
  • For system messages and emails, once notifications are set up for project members, they will receive reminders for relevant operations. For example, a member is informed of an assigned work item.
  • For DingTalk, Feishu, and generic webhooks, if a trigger event occurs, a notification will be sent to the corresponding chat group.

Prerequisites

An IPD-standalone software project is available, in which you have permission to configure notifications.

Configuring System Messages, Emails, and WeCom

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

    Figure 1 Notifications page

  3. Select a work item type to configure notifications.
  4. Select or deselect desired notification recipients and types.

    After the setting is complete, the selected recipients will be notified when a corresponding event (for example, RR modification) occurs.
    • Direct Message: When a member logs in to the homepage, they will see a number displayed next to in the upper right corner. They can click the icon to view notifications.
    • 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.
    • WeCom: Application updates will be pushed via WeCom. You need to enter a URL and other necessary information, and configure the notification content.

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-standalone software projects is displayed.
  4. Set parameters according to Table 1.

    Table 1 DingTalk/Feishu notification parameters

    Parameter

    Description

    URL

    (Mandatory) URL of a notification from the DingTalk or Feishu group chatbot.

    Event type

    (Mandatory) You can select more than one option. Type of the event to be notified of.

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

    Notification content

    (Optional) Content of the pushed message.

    It includes:

    • CodeArts Req name
    • Operator
    • Operation time
    • Notification content
    • Link

    @user_id

    (Optional) Members who receive the notifications.

    Format:

    Enter 1 to 64 characters using only letters, digits, periods (.), hyphens (-), underscores (_), and at signs (@). Start with a letter or digit.

    Use commas (,) to separate multiple user IDs. A maximum of 50 user IDs can be entered, and the maximum length is 1,000 characters.

    @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.

    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.

  5. Click OK to save the settings.

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-standalone software projects is displayed.
  4. Click New Webhook Subscription.
  5. Set parameters according to Table 2.

    Table 2 Webhook notification parameters

    Parameter

    Description

    Subscription Event Name

    (Mandatory) Name of the subscription event. The name is user-defined and can contain a maximum of 200 characters.

    URL

    (Mandatory) URL of a generic webhook notification. The value must start with https:// or http://.

    Event type

    (Mandatory) You can select more than one option. Type of the event to be notified of.

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

    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, for example, Content-Type:application/json.

    Custom Templates

    (Mandatory) 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.

    Example of DingTalk parameters:
    {
    "msgtype": "text" // The message type is text.
        "text" : {
    "content" : "xxx" // Message content.
        }
    }
    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.title

    Work item title.

    operator.username

    Operator username.

    operator.id

    Operator ID.

    review.title

    Review title.

    review.url

    Review URL.

    operation

    Event name.

  6. Click OK to save the settings.