Subscribe via Webhook

TiDB Cloud provides you with an easy way to subscribe to alert notifications via a Generic Webhook, email, Slack, Zoom, Flashduty, and PagerDuty. This document describes how to subscribe to alert notifications via a generic webhook.

Prerequisites

• The subscribing via webhook feature is only available for organizations that subscribe to the Enterprise or Premium support plan.

• You need a webhook URL from the platform where you want to receive alert notifications on (for example, Telegram, Microsoft Teams, or your own on-call system that accepts HTTP POST requests with a JSON payload). Currently, TiDB Cloud does not support customizing the request headers or the payload format.

• To subscribe to alert notifications of TiDB Cloud, you must have the Organization Owner access to your organization or Project Owner access to the target project in TiDB Cloud.

Subscribe to alert notifications

Alert notification subscriptions vary by your TiDB Cloud plan.

To subscribe to alert notifications of TiDB Cloud Dedicated clusters, take the following steps:

1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the Project view tab.

2. In the project view, locate your target project, and then click for the project.

3. In the left navigation pane, click Alert Subscription under Project Settings.

4. On the Alert Subscription page, click Add Subscriber in the upper-right corner.

5. Select Webhook from the Subscriber Type drop-down list.

6. Enter a name in the Name field and your webhook URL in the Webhook URL field.

7. Click Save. The backend will test connection and save for you.

   If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection.

Alternatively, you can also click Subscribe in the upper-right corner of the Alert page of the target TiDB Cloud Dedicated cluster. You will be directed to the Alert Subscription page.

If an alert condition remains unchanged, the alert sends notifications every three hours.

Unsubscribe from alert notifications

If you no longer want to receive alert notifications, take the following steps. The steps vary by your TiDB Cloud plan.

1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the Project view tab.
2. In the project view, locate your target project, and then click for the project.
3. In the left navigation pane, click Alert Subscription under Project Settings.
4. On the Alert Subscription page, locate the row of your target subscriber to be deleted, and then click ... > Unsubscribe.
5. Click Unsubscribe to confirm the unsubscription.