Adds config info for Telegram cloud notification (#16424)
* Adds config info for Telegram cloud notification * Update integrations/cloud-notifications/metadata.yaml Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com> * Update integrations/cloud-notifications/metadata.yaml Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com> --------- Co-authored-by: Tasos Katsoulas <12612986+tkatsoulas@users.noreply.github.com>
Juan Cañete committed
Nov 17, 2023 at 17:51 UTC
9cb90073728aacfc2a862bcac70374788f071f7f
1 file changed
+45
integrations/cloud-notifications/metadata.yaml
+45
@@ -327,6 +327,51 @@
327
- Finally, click on **Create topic** on the bottom of the page
328
3. Now, use the new **Topic ARN** while adding AWS SNS integration on your space.
329
330
+- id: 'notify-cloud-telegram'
331
+ meta:
332
+ name: 'Telegram'
333
+ link: 'https://telegram.org/'
334
+ categories:
335
+ - notify.cloud
336
+ icon_filename: 'telegram.svg'
337
+ keywords:
338
+ - Telegram
339
+ overview:
340
+ notification_description: "From the Cloud interface, you can manage your space's notification settings and from these you can add a specific configuration to get notifications delivered on Telegram."
341
+ notification_limitations: ''
342
+ setup:
343
+ description: |
344
+ ### Prerequisites
345
+
346
+ To add Telegram notification you need:
347
+
348
+ - A Netdata Cloud account
349
+ - Access to the space as an **administrator**
350
+ - Space needs to be on **Business** plan or higher
351
+ - The Telegram bot token and chat ID
352
+
353
+ ### Steps
354
+
355
+ 1. Click on the **Space settings** cog (located above your profile icon)
356
+ 2. Click on the **Notification** tab
357
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
358
+ 4. On the **Telegram** card click on **+ Add**
359
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
360
+ - **Notification settings** are Netdata specific settings
361
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
362
+ - Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration
363
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
364
+ - **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Telegram:
365
+ - Bot Token - the token of your bot
366
+ - Chat ID - the chat id where your bot will deliver messages to
367
+
368
+ ### Getting the Telegram bot token and chat ID
369
+
370
+ - 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**.
371
+ - To get the chat ID you have two options:
372
+ - 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.
373
+ - 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`
374
+
375
- id: 'notify-cloud-webhook'
376
meta:
377
name: 'Webhook'