update Telegram Cloud notification docs to include new topic ID field (#17873)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Konstantinos Papazacharopoulos committed
Jun 13, 2024 at 19:05 UTC
87682c5e8f904ba03c72981eba8edf515bba3f6f
1 file changed
+4
-3
integrations/cloud-notifications/metadata.yaml
+4
-3
@@ -432,7 +432,7 @@
432
- A Netdata Cloud account
433
- Access to the space as an **Admin**
434
- The Space needs to be on a paid plan
435
- - The Telegram bot token and chat ID
435
+ - The Telegram bot token, chat ID and _optionally_ the topic ID
436
437
### Steps
438
@@ -448,14 +448,15 @@
448
- **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
449
- Bot Token - the token of your bot
450
- Chat ID - the chat id where your bot will deliver messages to
451
+ - Topic ID - the identifier of the chat topic to which your bot will send messages. If omitted or 0, messages will be sent to the General topic. If topics are not supported, messages will be sent to the chat.
452
452
- ### Getting the Telegram bot token and chat ID
453
+ ### Getting the Telegram bot token, chat ID and topic ID
454
455
- Bot token: To create one bot, contact the [@BotFather](https://t.me/BotFather) bot and send the command `/newbot` and follow the instructions. **Start a conversation with your bot or invite it into the group where you want it to send notifications**.
456
- To get the chat ID you have two options:
457
- Contact the [@myidbot](https://t.me/myidbot) bot and send the `/getid` command to get your personal chat ID, or invite it into a group and use the `/getgroupid` command to get the group chat ID.
458
- Alternatively, you can get the chat ID directly from the bot API. Send your bot a command in the chat you want to use, then check `https://api.telegram.org/bot{YourBotToken}/getUpdates`, eg. `https://api.telegram.org/bot111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5/getUpdates`
458
-
459
+ - To get the topic ID, the easiest way is this: Post a message to that topic, then right-click on it and select `Copy Message Link`. Paste it on a scratchpad and notice that it has the following structure `https://t.me/c/XXXXXXXXXX/YY/ZZ`. The topic ID is `YY` (integer).
460
- id: 'notify-cloud-splunk'
461
meta:
462
name: 'Splunk'