Obtain a webhook URL

This topic describes how to obtain the webhook URLs of chatbots for DingTalk, Lark, and Telegram groups.

DingTalk bot

1. Open DingTalk on your desktop, and open the target group chat that you want to send the alert notifications to.

2. Click the settings icon in the upper-right corner, then click Bot > Add Robot.

3. Select Custom.

   

4. Complete the settings for the bot. For Security Setting, select Custom Keywords and enter OB, OceanBase, OBCloud, and test to receive notifications from OceanBase Cloud.

   

5. Click Finished.

6. Save the bot's webhook URL for the alert contact configuration.

   Notice

   Please keep your webhook URL in a secure place. Do not disclose it on websites that can be publicly accessed to avoid malicious invocation of the URL.

   

Lark bot

1. Open Lark on your desktop, and open the target group chat that you want to send the alert notifications to.

2. Select ... > Settings in the upper-right corner, then click Bots.

   

3. Click Add Bot, and then select Custom Bot.

   

4. Complete the basic information of the bot, and click Add.

5. For Security settings, select Set keywords and enter OB and OceanBase to receive notifications from OceanBase Cloud.

   

6. Save the bot's webhook URL for the alert contact configuration, and click Finish.

   Notice

   Please keep your webhook URL in a secure place. Do not disclose it on websites that can be publicly accessed to avoid malicious invocation of the URL.

Telegram bot

1. Create a Telegram alert bot.

   1. In the Telegram search bar, search for @BotFather and open a chat with it.

      

   2. Enter /newbot to create a new bot, then follow the prompts to enter the bot's display name and username.

      

   3. Save the bot's username and the API token displayed in orange after the bot is created.

2. Obtain the chat ID.

   1. After creating the group chat, add the bot to the group by using its username.

   2. Since Telegram does not allow you to retrieve the group chat ID directly through the client, you will need to use a specific request via a browser for security reasons.

      1. After adding the bot to the group, enter the following URL in your browser’s address bar to view the latest information received by the bot:

         Use this URL format: https://api.telegram.org/bot<token>/getUpdates, replacing <token> with the API token obtained when creating the bot.

         Example URL: https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/getUpdates.

         Note

         If the group only includes the group owner and the bot, you may not receive any information. We recommend having at least three members in the group, or you can adjust the group's administrator settings to ensure the bot receives updates.

      2. In the JSON response, search for the "chat" field to locate the chat ID.

         

         As shown above, the "id" field contains the required chat ID.

         Note

         If the group chat undergoes changes, such as being upgraded to a supergroup, the chat ID may change. Ensure you retrieve the latest chat ID when needed.

3. Construct the webhook URL.

   Use the following URL format, replacing <token> with the bot’s API token and <chat id> with the group chat ID.

   https://api.telegram.org/bot<token>/sendMessage?chat_id=<chat id>
   

   Example:

   https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/sendMessage?chat_id=-45********