Skip to main content

Manage notification subscriptions

Use subscription management to control who receives NineData notifications and which channels are used for different workflow events.

Overview

  • Subscription types include SQL tasks, permission requests, and data exports.
  • Each subscription type contains process nodes. For example, SQL tasks can have nodes such as "to be submitted" and "to be approved".
  • Notification channels include in-console messages, SMS, email, phone calls, and Webhook.
  • Configure recipients and channels separately for each process node.

Each subscription type has default recipients and the default notification channel Inbox. Default settings cannot be removed, but additional recipients and channels can be added.

Before you begin

Procedure

  1. Sign in to the NineData Console.

  2. Go to Notification and then click Subscription.

  3. On the Subscription tab, configure the Receiver and notification methods for the target Type.

    Configure Recipients

    1. Click Edit in the Actions column for the target Type.

    2. On the Edit Subscription page, select Custom Receiver below Receiver.

    3. Click the text box below Custom Receiver, select the recipient, and click Save.

      tip

      Use Webhook to send notifications to a group chat. Configure the Webhook before selecting it here. For more information, see Appendix.

    Configure Notification Methods

    Select Message, Email, or Phone for the target subscription type. All recipients under this subscription type receive notifications through the selected channels.

Appendix: Configuring Webhook

  1. Sign in to the NineData Console.

  2. Go to Notification > Subscription.

  3. Click the Webhook tab and then click Create Webhook on the page.

  4. On the Create Webhook page, configure the settings using the table.

    Parameter
    Description
    NameEnter a name for the webhook. For ease of future retrieval and management, use a meaningful name with up to 24 characters.
    Feishu/DingTalk/WeCom WebhookEnter the webhook address of the group robot. If the webhook address has signature verification enabled, enter the signature key in the Signature Key box below (leave blank if signature verification is not enabled).
    Refer to the following official documents to obtain the webhook address:
    Signature KeyEnter the signature key corresponding to the webhook address. Leave this field blank if the webhook address does not have signature verification enabled.
    Related Envir. (optional)Binds the webhook to an environment. Only subscription management information related to the bound environment will be sent to this webhook.
    Related Datasource (optional)Binds the webhook to a data source. Only subscription management information related to the bound data source will be sent to this webhook.
  5. Click Create Webhook. NineData validates the webhook address and signature key, if configured. If validation fails, update the configuration based on the error message and try again.

    tip

    When creating a Webhook in a third-party tool, enable the security settings required by your organization to improve message-source reliability. These settings may include a signature key, IP allowlist, or keywords. Keep these points in mind:

    • Using a Signature Key as a Security Measure: Due to the variety of subscription message types sent by NineData, it's challenging to set a uniform set of keywords. To prevent missing important messages, we recommend using a signature key as the security measure for your Webhook.
    • Keyword Considerations: If you must use keywords, note that Webhook keywords are case-sensitive. For example, when NineData sends a welcome message containing the keyword "NineData," if you use "ninedata" instead in your keyword selection, you won't successfully receive the message. If you're configuring the Webhook in the NineData console, you'll also receive errors like "Keyword not found."

Result

Subscription settings and webhook channels are saved for the selected subscription types and process nodes. NineData sends notifications through the configured recipients and channels when the corresponding event occurs.