This topic describes how to obtain the Webhook URL for a chatbot on DingTalk, Lark, or WeCom.
Get the Webhook URL for a DingTalk group chatbot
To get the Webhook URL for a DingTalk group chatbot, perform the following steps:
Note
For more information about chatbots on DingTalk, see Webhook Chatbot.
Open the DingTalk client and go to the group where you want to send alerts.
Click Group Settings > Chatbot > Add Chatbot.
Select Custom Chatbot.
On the Chatbot Details page, click Add.
On the Add Chatbot page, specify the parameters.
ParameterDescriptionChatbot Name The name displayed for the chatbot in the group. Add to Group The current group by default. Security Settings The current version only supports security settings via custom keywords. Note
We recommend setting the custom keywords to OceanBase, OB, OBCloud, and test to receive OceanBase alerts.
Read the "Custom Chatbot Service and Disclaimer". If you agree, select the checkbox and click OK.
On the information page after the chatbot is added, copy its Webhook URL.
Note
Save the Webhook URL carefully. Do not post it on publicly accessible websites such as GitLab or blogs to prevent malicious use and spam messages if the URL is leaked.
Get the Webhook URL for a Lark group chatbot
To get the Webhook URL for a Lark group chatbot, perform the following steps:
Note
For more information about chatbots on Lark, see Use custom chatbots.
Open the Lark client and go to the target group.
In the upper-right corner of the group, click More and choose Settings > Group Chatbot > Add Chatbot.
Select Custom chatbot.
Set the custom chatbot's Avatar, Name, and Description, then click Add.
On the chatbot details page, you can obtain the Webhook URL and configure security settings.
Note
Save this Webhook URL carefully. Do not publish it on publicly accessible websites such as GitLab or blogs to prevent malicious use and spam messages after the URL is leaked.
ParameterDescriptionWebhook URL Copy the chatbot's Webhook URL. Security Settings The current version only supports security settings via custom keywords. Note
We recommend setting OceanBase and OB with custom keywords to ensure normal receipt of OceanBase alerts.
Settings Configure chatbot management permissions.
Obtain WeCom chatbot Webhook URL
To obtain a WeCom group chatbot, follow these steps:
Note
For more detailed usage instructions on WeCom chatbots, see Configure a group chatbot.
Open the WeCom client and enter the group for which you want to send alert notifications.
In the upper-right corner of the group, click Settings > Add Group Chatbot > Create a new chatbot.
Enter the chatbot name. The chatbot is now added.
On the chatbot details page, you can obtain the Webhook URL.
Note
Save this Webhook URL carefully. Do not publish it on publicly accessible websites such as GitLab or blogs to prevent malicious use and spam messages after the URL is leaked.