RocketChat cloud integration docs (#15205)
* feat: add RocketChat integration * fix: RocketChat docs - webhook endpoint
Joao Cardoso committed
Jun 16, 2023 at 11:40 UTC
221167141eaa04e67c1ad152abe4f4abbe082a80
1 file changed
+49
docs/cloud/alerts-notifications/add-rocketchat-notification-configuration.md
new
+49
@@ -0,0 +1,49 @@
1
+# Add RocketChat notification configuration
2
+
3
+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 RocketChat.
4
+
5
+## Prerequisites
6
+
7
+To add RocketChat notification configurations you need:
8
+
9
+- A Netdata Cloud account
10
+- Access to the space as an **administrator**
11
+- Space needs to be on **Business** plan or higher
12
+- Have a RocketChat app on your workspace to receive the webhooks, for more details check [how to configure this on RocketChat](#settings-on-rocketchat)
13
+
14
+## Steps
15
+
16
+1. Click on the **Space settings** cog (located above your profile icon)
17
+1. Click on the **Notification** tab
18
+1. Click on the **+ Add configuration** button (near the top-right corner of your screen)
19
+1. On the **RocketChat** card click on **+ Add**
20
+1. A modal will be presented to you to enter the required details to enable the configuration:
21
+ 1. **Notification settings** are Netdata specific settings
22
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
23
+ - 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
24
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
25
+ 1. **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
26
+ - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications. For more details check [how to configure this on RocketChat](#settings-on-rocketchat)
27
+
28
+## Settings on RocketChat
29
+
30
+To enable the webhook integrations on RocketChat you need:
31
+1. In RocketChat, Navigate to Administration > Workspace > Integrations.
32
+
33
+2. Click +New at the top right corner.
34
+
35
+
36
+
37
+3. For more details about each parameter, check [create-a-new-incoming-webhook](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations#create-a-new-incoming-webhook).
38
+
39
+4. After configuring integration, click Save.
40
+
41
+
42
+
43
+4. You will end up with a webhook endpoint that looks like so:
44
+```
45
+https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
46
+```
47
+ - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance.
48
+
49
+For more details please check RocketChat's article [Incoming webhooks for RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).