Obtain a webhook URL

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

DingTalk bot

1. Log in to the DingTalk client and enter the target DingTalk group.

2. Choose Group Settings > Bot > Add Robot.

3. In the dialog box that appears, click Custom.

   

4. On the robot details page, click Add.

5. On the page that appears, specify the parameters.

   Parameter	Note
   Chatbot name	The name of the chatbot displayed in the group.
   Add to Group	By default, the current group is specified.
   Security Settings	The current version supports security settings only by specifying custom keywords. Note We recommend that you add OceanBase, OB, OBCloud, and test as keywords to receive OceanBase Cloud alerts.

   

6. Select I Acknowledge and Accept DingTalk Custom Robot Service Terms of Service after carefully reading the clauses, and then click Finished.

7. In the Add Robot dialog box, copy the webhook URL of the chatbot.

   Note

   We recommend that you keep the webhook URL confidential and do not disclose it to public websites such as GitLab and blogs. Otherwise, you may receive malicious spam messages.

   

Lark bot

1. Log in to the Lark client and enter the target chat group.

2. In the upper-right corner of the group chat window, choose More > Settings. In the dialog box that appears, choose Bots > Add bot.

   

3. In the dialog box that appears, click Custom Bot.

   

4. Specify the avatar, name, and description of the custom chatbot, and click Add.

5. On the chatbot details page, you can obtain the Webhook URL and configure security settings.

   Note

   We recommend that you keep the Webhook URL confidential and do not disclose it to public websites such as GitLab and blogs. Otherwise, you may receive malicious spam messages.

   Parameter	Note
   Webhook URL	You can copy the Webhook URL of the chatbot.
   Security settings	The current version supports security settings only by specifying custom keywords. Note We recommend that you add OceanBase and OB as keywords to receive OceanBase Cloud alerts.
   Settings	Set the chatbot management permissions.

   

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********