| 1 | # yamllint disable rule:line-length |
| 2 | --- |
| 3 | - id: "notify-cloud-mobile-app" |
| 4 | meta: |
| 5 | name: "Netdata Mobile App" |
| 6 | link: "https://netdata.cloud" |
| 7 | categories: |
| 8 | - notify.cloud |
| 9 | icon_filename: "netdata.png" |
| 10 | keywords: |
| 11 | - mobile-app |
| 12 | - phone |
| 13 | - personal-notifications |
| 14 | setup: |
| 15 | description: | |
| 16 | ### Prerequisites |
| 17 | |
| 18 | - A Netdata Cloud account |
| 19 | - You need to have the Netdata Mobile App installed on your [Android](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or [iOS](https://apps.apple.com/in/app/netdata-mobile/id6474659622) phone. |
| 20 | |
| 21 | ### Netdata Mobile App Configuration and device linking |
| 22 | |
| 23 | In order to login to the Netdata Mobile App |
| 24 | |
| 25 | 1. Download the Netdata Mobile App from [Google Play Store](https://play.google.com/store/apps/details?id=cloud.netdata.android&pli=1) or the [iOS App Store](https://apps.apple.com/in/app/netdata-mobile/id6474659622) |
| 26 | 2. Open the App and Choose your Sign-in option |
| 27 | - Email Address: Enter the email address of your registered Netdata Cloud account and click on the verification link received by email on your mobile device. |
| 28 | - Sign-in with QR Code: Scan the QR code from the Netdata Cloud UI under **Profile Picture** --> **Settings** --> **Notifications** --> **Mobile App Notifications** --> **Show QR Code** |
| 29 | |
| 30 | ### Netdata Configuration |
| 31 | |
| 32 | After linking your device, enable the toggle for **Mobile App Notifications** under the same settings panel. |
| 33 | |
| 34 | - id: "notify-cloud-discord" |
| 35 | meta: |
| 36 | name: "Discord" |
| 37 | link: "https://discord.com/" |
| 38 | categories: |
| 39 | - notify.cloud |
| 40 | icon_filename: "discord.png" |
| 41 | keywords: |
| 42 | - discord |
| 43 | - community |
| 44 | setup: |
| 45 | description: | |
| 46 | ### Prerequisites |
| 47 | |
| 48 | - A Netdata Cloud account |
| 49 | - Access to the Space as an **Admin** |
| 50 | |
| 51 | ### Discord Server Configuration |
| 52 | |
| 53 | 1. Go to **Server Settings** --> **Integrations** |
| 54 | 2. **Create Webhook** or **View Webhooks** if you already have some defined |
| 55 | 3. Specify the **Name** and **Channel** on your new webhook |
| 56 | 4. Keep note of the **Webhook URL** as you will need it for the configuration of the integration on the Netdata Cloud UI |
| 57 | |
| 58 | ### Netdata Configuration |
| 59 | |
| 60 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 61 | 2. Click on the **Alerts & Notifications** tab |
| 62 | 3. Click on the **+ Add configuration** button |
| 63 | 4. Add the Discord Integration |
| 64 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 65 | - **Notification settings** |
| 66 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 67 | - Rooms: A list of Rooms for which you want to be notified |
| 68 | - Notifications: The notification types you want to receive |
| 69 | - **Integration configuration** |
| 70 | - Webhook URL: The URL you copied from the previous section |
| 71 | - Channel Parameters: Select the channel type which the notifications will be sent to, if it is a Forum channel, you need to specify a thread name |
| 72 | |
| 73 | - id: "notify-cloud-pagerduty" |
| 74 | meta: |
| 75 | name: "PagerDuty" |
| 76 | link: "https://www.pagerduty.com/" |
| 77 | categories: |
| 78 | - notify.cloud |
| 79 | icon_filename: "pagerduty.png" |
| 80 | keywords: |
| 81 | - pagerduty |
| 82 | setup: |
| 83 | description: | |
| 84 | ### Prerequisites |
| 85 | |
| 86 | - A Netdata Cloud account |
| 87 | - Access to the Space as an **Admin** |
| 88 | - The Space needs to be on a paid plan |
| 89 | - You need to have a PagerDuty service to receive events using webhooks. |
| 90 | |
| 91 | ### PagerDuty Server Configuration |
| 92 | |
| 93 | 1. Create a service to receive events from your services directory page on PagerDuty |
| 94 | 2. On the third step of the service creation, select `Events API V2` Integration |
| 95 | 3. Once the service is created, you will be redirected to its configuration page, where you can copy the **Integration Key** and **Integration URL (Alert Events)** in order to add them to your integration configuration in the Netdata Cloud UI |
| 96 | |
| 97 | ### Netdata Configuration |
| 98 | |
| 99 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 100 | 2. Click on the **Alerts & Notifications** tab |
| 101 | 3. Click on the **+ Add configuration** button |
| 102 | 4. Add the PagerDuty Integration |
| 103 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 104 | - **Notification settings** |
| 105 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 106 | - Rooms: A list of Rooms for which you want to be notified |
| 107 | - Notifications: The notification types you want to receive |
| 108 | - **Integration configuration** |
| 109 | - Integration Key: A 32 character key provided by PagerDuty to receive events on your service. |
| 110 | - Integration URL (Alert Events): The URL provided by PagerDuty where Netdata Cloud will send notifications. |
| 111 | |
| 112 | - id: "notify-cloud-slack" |
| 113 | meta: |
| 114 | name: "Slack" |
| 115 | link: "https://slack.com/" |
| 116 | categories: |
| 117 | - notify.cloud |
| 118 | icon_filename: "slack.png" |
| 119 | keywords: |
| 120 | - slack |
| 121 | setup: |
| 122 | description: | |
| 123 | ### Prerequisites |
| 124 | |
| 125 | - A Netdata Cloud account |
| 126 | - Access to the Space as an **Admin** |
| 127 | - The Space needs to be on a paid plan |
| 128 | - You need to have a Slack app on your workspace to receive the Webhooks. |
| 129 | |
| 130 | ### Slack Server Configuration |
| 131 | |
| 132 | 1. Create an app to receive webhook integrations. Check the [Slack documentation](https://api.slack.com/apps?new_app=1) for further details |
| 133 | 2. Install the app on your workspace |
| 134 | 3. Configure Webhook URLs for your workspace |
| 135 | - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks** |
| 136 | - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace** |
| 137 | - Specify the channel where you want your notifications to be delivered |
| 138 | - Once completed, copy the Webhook URL in order to add it to your integration configuration in the Netdata Cloud UI |
| 139 | |
| 140 | For more details please check [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack). |
| 141 | |
| 142 | ### Netdata Configuration |
| 143 | |
| 144 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 145 | 2. Click on the **Alerts & Notifications** tab |
| 146 | 3. Click on the **+ Add configuration** button |
| 147 | 4. Add the Slack Integration |
| 148 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 149 | - **Notification settings** |
| 150 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 151 | - Rooms: A list of Rooms for which you want to be notified |
| 152 | - Notifications: The notification types you want to receive |
| 153 | - **Integration configuration** |
| 154 | - Webhook URL: URL provided on Slack for the channel you want to receive your notifications |
| 155 | |
| 156 | - id: "notify-cloud-opsgenie" |
| 157 | meta: |
| 158 | name: "Opsgenie" |
| 159 | link: "https://www.atlassian.com/software/opsgenie" |
| 160 | categories: |
| 161 | - notify.cloud |
| 162 | icon_filename: "opsgenie.png" |
| 163 | keywords: |
| 164 | - opsgenie |
| 165 | - atlassian |
| 166 | setup: |
| 167 | description: | |
| 168 | ### Prerequisites |
| 169 | |
| 170 | - A Netdata Cloud account |
| 171 | - Access to the Space as an **Admin** |
| 172 | - The Space needs to be on a paid plan |
| 173 | - You need to have permissions on Opsgenie to add new integrations. |
| 174 | |
| 175 | ### Opsgenie Server Configuration |
| 176 | |
| 177 | 1. Go to the integrations tab of your team, click **Add integration** |
| 178 | 2. Pick **API** from the available integrations and copy the API Key in order to add it to your integration configuration in the Netdata Cloud UI |
| 179 | |
| 180 | ### Netdata Configuration |
| 181 | |
| 182 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 183 | 2. Click on the **Alerts & Notifications** tab |
| 184 | 3. Click on the **+ Add configuration** button |
| 185 | 4. Add the Opsgenie Integration |
| 186 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 187 | - **Notification settings** |
| 188 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 189 | - Rooms: A list of Rooms for which you want to be notified |
| 190 | - Notifications: The notification types you want to receive |
| 191 | - **Integration configuration** |
| 192 | - API Key: The key provided on Opsgenie for the channel you want to receive your notifications |
| 193 | |
| 194 | - id: "notify-cloud-mattermost" |
| 195 | meta: |
| 196 | name: "Mattermost" |
| 197 | link: "https://mattermost.com/" |
| 198 | categories: |
| 199 | - notify.cloud |
| 200 | icon_filename: "mattermost.png" |
| 201 | keywords: |
| 202 | - mattermost |
| 203 | setup: |
| 204 | description: | |
| 205 | ### Prerequisites |
| 206 | |
| 207 | - A Netdata Cloud account |
| 208 | - Access to the Space as an **Admin** |
| 209 | - The Space needs to be on a paid plan |
| 210 | - You need to have permissions on Mattermost to add new integrations. |
| 211 | |
| 212 | ### Mattermost Server Configuration |
| 213 | |
| 214 | 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook |
| 215 | - If you don't have the Integrations option, incoming webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. They can be enabled by a System Admin from System Console > Integrations > Integration Management. Once incoming webhooks are enabled, continue with the steps below. |
| 216 | 2. Select Add Incoming Webhook and add a name and description for the webhook. |
| 217 | 3. Select the channel to receive webhook payloads, then select Add to create the webhook |
| 218 | 4. You will end up with a webhook URL that looks like `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx`, copy it in order to add it to your integration configuration in the Netdata Cloud UI |
| 219 | |
| 220 | For more details please check [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/). |
| 221 | |
| 222 | ### Netdata Configuration |
| 223 | |
| 224 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 225 | 2. Click on the **Alerts & Notifications** tab |
| 226 | 3. Click on the **+ Add configuration** button |
| 227 | 4. Add the Mattermost Integration |
| 228 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 229 | - **Notification settings** |
| 230 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 231 | - Rooms: A list of Rooms for which you want to be notified |
| 232 | - Notifications: The notification types you want to receive |
| 233 | - **Integration configuration** |
| 234 | - Webhook URL: URL provided on Mattermost for the channel you want to receive your notifications |
| 235 | |
| 236 | - id: "notify-cloud-rocketchat" |
| 237 | meta: |
| 238 | name: "RocketChat" |
| 239 | link: "https://www.rocket.chat/" |
| 240 | categories: |
| 241 | - notify.cloud |
| 242 | icon_filename: "rocketchat.png" |
| 243 | keywords: |
| 244 | - rocketchat |
| 245 | setup: |
| 246 | description: | |
| 247 | ### Prerequisites |
| 248 | |
| 249 | - A Netdata Cloud account |
| 250 | - Access to the Space as an **Admin** |
| 251 | - The Space needs to be on a paid plan |
| 252 | - You need to have permissions on RocketChat to add new integrations. |
| 253 | |
| 254 | ### RocketChat Server Configuration |
| 255 | |
| 256 | Steps to configure your RocketChat server to receive notifications from Netdata Cloud: |
| 257 | |
| 258 | 1. In RocketChat, Navigate to Administration > Workspace > Integrations |
| 259 | 2. Click **+New** at the top right corner |
| 260 | 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) |
| 261 | 4. You will end up with a webhook endpoint that looks like `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`, copy it in order to add it to your integration configuration in the Netdata Cloud UI |
| 262 | |
| 263 | For more details please check [Incoming webhooks for RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/). |
| 264 | |
| 265 | ### Netdata Configuration |
| 266 | |
| 267 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 268 | 2. Click on the **Alerts & Notifications** tab |
| 269 | 3. Click on the **+ Add configuration** button |
| 270 | 4. Add the PagerDuty Integration |
| 271 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 272 | - **Notification settings** |
| 273 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 274 | - Rooms: A list of Rooms for which you want to be notified |
| 275 | - Notifications: The notification types you want to receive |
| 276 | - **Integration configuration** |
| 277 | - Webhook URL: URL provided on RocketChat for the channel you want to receive your notifications |
| 278 | |
| 279 | - id: "notify-cloud-awssns" |
| 280 | meta: |
| 281 | name: "Amazon SNS" |
| 282 | link: "https://aws.amazon.com/sns/" |
| 283 | categories: |
| 284 | - notify.cloud |
| 285 | icon_filename: "awssns.png" |
| 286 | keywords: |
| 287 | - awssns |
| 288 | setup: |
| 289 | description: | |
| 290 | ### Prerequisites |
| 291 | |
| 292 | - A Netdata Cloud account |
| 293 | - Access to the space as an **Admin** |
| 294 | - The Space needs to be on a paid plan |
| 295 | - An AWS account with AWS SNS access |
| 296 | |
| 297 | ### AWS SNS Configuration |
| 298 | |
| 299 | 1. [Setting up access for Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-setting-up.html) |
| 300 | 2. Create a topic |
| 301 | - On AWS SNS management console click on **Create topic** |
| 302 | - On the **Details** section, select the standard type and provide the topic name |
| 303 | - On the **Access policy** section, change the **Publishers** option to **Only the specified AWS accounts** and provide the Netdata AWS account **(123269920060)** that will be used to publish notifications to the topic being created |
| 304 | 3. Copy the **Topic ARN** in order to add it to your integration configuration in the Netdata Cloud UI |
| 305 | |
| 306 | ### Netdata Configuration |
| 307 | |
| 308 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 309 | 2. Click on the **Alerts & Notifications** tab |
| 310 | 3. Click on the **+ Add configuration** button |
| 311 | 4. Add the AWS SNS Integration |
| 312 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 313 | - **Notification settings** |
| 314 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 315 | - Rooms: A list of Rooms for which you want to be notified |
| 316 | - Notifications: The notification types you want to receive |
| 317 | - **Integration configuration** |
| 318 | - Topic ARN: The topic provided on AWS SNS (with region) for where to publish your notifications. |
| 319 | |
| 320 | - id: "notify-cloud-microsoftteams" |
| 321 | meta: |
| 322 | name: "Microsoft Teams" |
| 323 | link: "https://www.microsoft.com/en-us/microsoft-teams" |
| 324 | categories: |
| 325 | - notify.cloud |
| 326 | icon_filename: "teams.svg" |
| 327 | keywords: |
| 328 | - microsoft |
| 329 | - teams |
| 330 | setup: |
| 331 | description: | |
| 332 | ### Prerequisites |
| 333 | |
| 334 | - A Netdata Cloud account |
| 335 | - Access to the Space as an **Admin** |
| 336 | - The Space needs to be on a paid plan |
| 337 | - A [Microsoft Teams Essentials subscription](https://www.microsoft.com/en-sg/microsoft-teams/essentials) or higher. Note that this is a **paid** feature |
| 338 | |
| 339 | ### Microsoft Teams Configuration |
| 340 | |
| 341 | 1. Navigate to the desired Microsoft Teams channel and hover over the channel name. Click the three dots icon that appears |
| 342 | 2. Select "Workflows" from the options, then choose "Post to a channel when a webhook request is received" |
| 343 | 3. **Configure Workflow Details** |
| 344 | - Give your workflow a name, such as "Netdata Alerts" |
| 345 | - Select the target team and channel where you will receive notifications |
| 346 | - Click "Add workflow" |
| 347 | 4. Once the workflow is created, you will receive a unique Workflow Webhook URL, copy it, in order to add it to your integration configuration in the Netdata Cloud UI |
| 348 | |
| 349 | ### Netdata Configuration |
| 350 | |
| 351 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 352 | 2. Click on the **Alerts & Notifications** tab |
| 353 | 3. Click on the **+ Add configuration** button |
| 354 | 4. Add the Microsoft Teams Integration |
| 355 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 356 | - **Notification settings** |
| 357 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 358 | - Rooms: A list of Rooms for which you want to be notified |
| 359 | - Notifications: The notification types you want to receive |
| 360 | - **Integration configuration** |
| 361 | - Microsoft Teams Incoming Webhook URL: The Incoming Webhook URL that you copied earlier. |
| 362 | |
| 363 | - id: "notify-cloud-telegram" |
| 364 | meta: |
| 365 | name: "Telegram" |
| 366 | link: "https://telegram.org/" |
| 367 | categories: |
| 368 | - notify.cloud |
| 369 | icon_filename: "telegram.svg" |
| 370 | keywords: |
| 371 | - Telegram |
| 372 | setup: |
| 373 | description: | |
| 374 | ### Prerequisites |
| 375 | |
| 376 | - A Netdata Cloud account |
| 377 | - Access to the Space as an **Admin** |
| 378 | - The Space needs to be on a paid plan |
| 379 | - The Telegram bot token, chat ID and optionally the topic ID |
| 380 | |
| 381 | ### Telegram Configuration |
| 382 | |
| 383 | - 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**. |
| 384 | - To get the chat ID you have two options: |
| 385 | - 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. |
| 386 | - 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` |
| 387 | - 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). |
| 388 | |
| 389 | ### Netdata Configuration |
| 390 | |
| 391 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 392 | 2. Click on the **Alerts & Notifications** tab |
| 393 | 3. Click on the **+ Add configuration** button |
| 394 | 4. Add the Telegram Integration |
| 395 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 396 | - **Notification settings** |
| 397 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 398 | - Rooms: A list of Rooms for which you want to be notified |
| 399 | - Notifications: The notification types you want to receive |
| 400 | - **Integration configuration** |
| 401 | - Bot Token: The token of your bot |
| 402 | - Chat ID: The chat id where your bot will deliver messages to |
| 403 | - 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. |
| 404 | |
| 405 | - id: "notify-cloud-splunk" |
| 406 | meta: |
| 407 | name: "Splunk" |
| 408 | link: "https://splunk.com/" |
| 409 | categories: |
| 410 | - notify.cloud |
| 411 | icon_filename: "splunk-black.svg" |
| 412 | keywords: |
| 413 | - Splunk |
| 414 | setup: |
| 415 | description: | |
| 416 | ### Prerequisites |
| 417 | |
| 418 | - A Netdata Cloud account |
| 419 | - Access to the Space as an **Admin** |
| 420 | - The Space needs to be on a paid plan |
| 421 | - The URI and token for your Splunk HTTP Event Collector. Refer to the [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) for detailed instructions on how to set it up. |
| 422 | |
| 423 | ### Netdata Configuration |
| 424 | |
| 425 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 426 | 2. Click on the **Alerts & Notifications** tab |
| 427 | 3. Click on the **+ Add configuration** button |
| 428 | 4. Add the Splunk Integration |
| 429 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 430 | - **Notification settings** |
| 431 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 432 | - Rooms: A list of Rooms for which you want to be notified |
| 433 | - Notifications: The notification types you want to receive |
| 434 | - **Integration configuration** |
| 435 | - HTTP Event Collector URI: The URI of your HTTP event collector in Splunk |
| 436 | - HTTP Event Collector Token: The token that Splunk provided to you when you created the HTTP Event Collector |
| 437 | |
| 438 | - id: "notify-cloud-victorops" |
| 439 | meta: |
| 440 | name: "Splunk VictorOps" |
| 441 | link: "https://www.splunk.com/en_us/about-splunk/acquisitions/splunk-on-call.html" |
| 442 | categories: |
| 443 | - notify.cloud |
| 444 | icon_filename: "victorops.svg" |
| 445 | keywords: |
| 446 | - VictorOps |
| 447 | - Splunk |
| 448 | - On-Call |
| 449 | setup: |
| 450 | description: | |
| 451 | ### Prerequisites |
| 452 | |
| 453 | - A Netdata Cloud account |
| 454 | - Access to the Space as an **Admin** |
| 455 | - The Space needs to be on a paid plan |
| 456 | - The Destination URL for your Splunk VictorOps REST Endpoint Integration. Refer to the [VictorOps documentation](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide) for detailed instructions. |
| 457 | |
| 458 | ### Netdata Configuration |
| 459 | |
| 460 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 461 | 2. Click on the **Alerts & Notifications** tab |
| 462 | 3. Click on the **+ Add configuration** button |
| 463 | 4. Add the Splunk VictorOps Integration |
| 464 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 465 | - **Notification settings** |
| 466 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 467 | - Rooms: A list of Rooms for which you want to be notified |
| 468 | - Notifications: The notification types you want to receive |
| 469 | - **Integration configuration** |
| 470 | - Destination URL - The URL provided by VictorOps of your REST endpoint. |
| 471 | |
| 472 | - id: "notify-cloud-webhook" |
| 473 | meta: |
| 474 | name: "Webhook" |
| 475 | link: "https://en.wikipedia.org/wiki/Webhook" |
| 476 | categories: |
| 477 | - notify.cloud |
| 478 | icon_filename: "webhook.svg" |
| 479 | keywords: |
| 480 | - generic webhooks |
| 481 | - webhooks |
| 482 | setup: |
| 483 | description: | |
| 484 | ### Prerequisites |
| 485 | |
| 486 | - A Netdata Cloud account |
| 487 | - Access to the Space as an **Admin** |
| 488 | - The Space needs to be on a paid plan |
| 489 | - You need to have an app that allows you to receive webhooks following a predefined schema. |
| 490 | |
| 491 | ### Netdata Configuration |
| 492 | |
| 493 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 494 | 2. Click on the **Alerts & Notifications** tab |
| 495 | 3. Click on the **+ Add configuration** button |
| 496 | 4. Add the Webhook integration |
| 497 | 5. A modal will be presented to you to enter the required details to enable the configuration: |
| 498 | - **Notification settings** |
| 499 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 500 | - Rooms: A list of Rooms for which you want to be notified |
| 501 | - Notifications: The notification types you want to receive |
| 502 | - **Integration configuration** |
| 503 | - Webhook URL: The url of the service that Netdata will send notifications to. In order to keep the communication secured, Netdata only accepts HTTPS urls. |
| 504 | - Extra headers: Optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. |
| 505 | - Authentication Mechanism, Netdata webhook integration supports 3 different authentication mechanisms. |
| 506 | - Mutual TLS (recommended): Default authentication mechanism used if no other method is selected |
| 507 | - Basic: The client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. |
| 508 | - Bearer: The client sends a request with an Authorization header that includes a **bearer token**. |
| 509 | - **Verification** |
| 510 | - Token: The Token from the latest **Test notification** received on the webhook endpoint. |
| 511 | - Click on the **Test** button to receive a notification. Token will be embedded in the payload. |
| 512 | |
| 513 | ### Webhook service |
| 514 | |
| 515 | A webhook service allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. |
| 516 | |
| 517 | In this section, we'll go over the steps to set up a generic webhook service, including adding headers, and implementing different types of authorization mechanisms. |
| 518 | |
| 519 | #### Netdata webhook integration |
| 520 | |
| 521 | Netdata webhook integration service will send alert and reachability notifications to the destination service as soon as they are detected. |
| 522 | |
| 523 | For alert notifications, the content sent to the destination service contains a JSON object with the following properties: |
| 524 | |
| 525 | | field | type | description | |
| 526 | |:----------------------------------|:--------------------------------|:--------------------------------------------------------------------------| |
| 527 | | message | string | A summary message of the alert. | |
| 528 | | alert | string | The alert the notification is related to. | |
| 529 | | info | string | Additional info related with the alert. | |
| 530 | | chart | string | The chart associated with the alert. | |
| 531 | | context | string | The chart context. | |
| 532 | | space | string | The space where the node that raised the alert is assigned. | |
| 533 | | Rooms | object\[object(string,string)\] | Object with list of Rooms names and urls where the node belongs to. | |
| 534 | | family | string | Context family. | |
| 535 | | class | string | Classification of the alert, e.g. `Error`. | |
| 536 | | severity | string | Alert severity, can be one of `warning`, `critical` or `clear`. | |
| 537 | | date | string | Date of the alert in ISO8601 format. | |
| 538 | | duration | string | Duration the alert has been raised. | |
| 539 | | additional_active_critical_alerts | integer | Number of additional critical alerts currently existing on the same node. | |
| 540 | | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. | |
| 541 | | alert_url | string | Netdata Cloud URL for this alert. | |
| 542 | |
| 543 | For reachability notifications, the JSON object will contain the following properties: |
| 544 | |
| 545 | | field | type | description | |
| 546 | |:-----------------|:--------|:------------------------------------------------------------------------------------------------------------------------------| |
| 547 | | message | string | A summary message of the reachability alert. | |
| 548 | | url | string | Netdata Cloud URL for the host experiencing the reachability alert. | |
| 549 | | host | string | The hostname experiencing the reachability alert. | |
| 550 | | severity | string | Severity for this notification. If host is reachable, severity will be `info`, if host is unreachable, it will be `critical`. | |
| 551 | | status | object | An object with the status information. | |
| 552 | | status.reachable | boolean | `true` if host is reachable, `false` otherwise | |
| 553 | | status.text | string | Can be `reachable` or `unreachable` | |
| 554 | |
| 555 | #### Extra headers |
| 556 | |
| 557 | When setting up a webhook service, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL. |
| 558 | |
| 559 | By default, the following headers will be sent in the HTTP request |
| 560 | |
| 561 | | **Header** | **Value** | |
| 562 | |:------------:|------------------| |
| 563 | | Content-Type | application/json | |
| 564 | |
| 565 | #### Authentication mechanisms |
| 566 | |
| 567 | Netdata webhook integration supports 3 different authentication mechanisms: |
| 568 | |
| 569 | ##### Mutual TLS authentication (recommended) |
| 570 | |
| 571 | In mutual Transport Layer Security (mTLS) authentication, the client and the server authenticate each other using X.509 certificates. This ensures that the client is connecting to the intended server, and that the server is only accepting connections from authorized clients. |
| 572 | |
| 573 | This is the default authentication mechanism used if no other method is selected. |
| 574 | |
| 575 | To take advantage of mutual TLS, you can configure your server to verify Netdata's client certificate. In order to achieve this, the Netdata client sending the notification supports mutual TLS (mTLS) to identify itself with a client certificate that your server can validate. |
| 576 | |
| 577 | The steps to perform this validation are as follows: |
| 578 | |
| 579 | - Store Netdata CA certificate on a file in your disk. The content of this file should be: |
| 580 | |
| 581 | <details> |
| 582 | <summary>Netdata CA certificate</summary> |
| 583 | |
| 584 | ```text |
| 585 | -----BEGIN CERTIFICATE----- |
| 586 | MIIF0jCCA7qgAwIBAgIUDV0rS5jXsyNX33evHEQOwn9fPo0wDQYJKoZIhvcNAQEN |
| 587 | BQAwgYAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQH |
| 588 | Ew1TYW4gRnJhbmNpc2NvMRYwFAYDVQQKEw1OZXRkYXRhLCBJbmMuMRIwEAYDVQQL |
| 589 | EwlDbG91ZCBTUkUxGDAWBgNVBAMTD05ldGRhdGEgUm9vdCBDQTAeFw0yMzAyMjIx |
| 590 | MjQzMDBaFw0zMzAyMTkxMjQzMDBaMIGAMQswCQYDVQQGEwJVUzETMBEGA1UECBMK |
| 591 | Q2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEWMBQGA1UEChMNTmV0 |
| 592 | ZGF0YSwgSW5jLjESMBAGA1UECxMJQ2xvdWQgU1JFMRgwFgYDVQQDEw9OZXRkYXRh |
| 593 | IFJvb3QgQ0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCwIg7z3R++ |
| 594 | ppQYYVVoMIDlhWO3qVTMsAQoJYEvVa6fqaImUBLW/k19LUaXgUJPohB7gBp1pkjs |
| 595 | QfY5dBo8iFr7MDHtyiAFjcQV181sITTMBEJwp77R4slOXCvrreizhTt1gvf4S1zL |
| 596 | qeHBYWEgH0RLrOAqD0jkOHwewVouO0k3Wf2lEbCq3qRk2HeDvkv0LR7sFC+dDms8 |
| 597 | fDHqb/htqhk+FAJELGRqLeaFq1Z5Eq1/9dk4SIeHgK5pdYqsjpBzOTmocgriw6he |
| 598 | s7F3dOec1ZZdcBEAxOjbYt4e58JwuR81cWAVMmyot5JNCzYVL9e5Vc5n22qt2dmc |
| 599 | Tzw2rLOPt9pT5bzbmyhcDuNg2Qj/5DySAQ+VQysx91BJRXyUimqE7DwQyLhpQU72 |
| 600 | jw29lf2RHdCPNmk8J1TNropmpz/aI7rkperPugdOmxzP55i48ECbvDF4Wtazi+l+ |
| 601 | 4kx7ieeLfEQgixy4lRUUkrgJlIDOGbw+d2Ag6LtOgwBiBYnDgYpvLucnx5cFupPY |
| 602 | Cy3VlJ4EKUeQQSsz5kVmvotk9MED4sLx1As8V4e5ViwI5dCsRfKny7BeJ6XNPLnw |
| 603 | PtMh1hbiqCcDmB1urCqXcMle4sRhKccReYOwkLjLLZ80A+MuJuIEAUUuEPCwywzU |
| 604 | R7pagYsmvNgmwIIuJtB6mIJBShC7TpJG+wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC |
| 605 | AQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU9IbvOsPSUrpr8H2zSafYVQ9e |
| 606 | Ft8wDQYJKoZIhvcNAQENBQADggIBABQ08aI31VKZs8jzg+y/QM5cvzXlVhcpkZsY |
| 607 | 1VVBr0roSBw9Pld9SERrEHto8PVXbadRxeEs4sKivJBKubWAooQ6NTvEB9MHuGnZ |
| 608 | VCU+N035Gq/mhBZgtIs/Zz33jTB2ju3G4Gm9VTZbVqd0OUxFs41Iqvi0HStC3/Io |
| 609 | rKi7crubmp5f2cNW1HrS++ScbTM+VaKVgQ2Tg5jOjou8wtA+204iYXlFpw9Q0qnP |
| 610 | qq6ix7TfLLeRVp6mauwPsAJUgHZluz7yuv3r7TBdukU4ZKUmfAGIPSebtB3EzXfH |
| 611 | 7Y326xzv0hEpjvDHLy6+yFfTdBSrKPsMHgc9bsf88dnypNYL8TUiEHlcTgCGU8ts |
| 612 | ud8sWN2M5FEWbHPNYRVfH3xgY2iOYZzn0i+PVyGryOPuzkRHTxDLPIGEWE5susM4 |
| 613 | X4bnNJyKH1AMkBCErR34CLXtAe2ngJlV/V3D4I8CQFJdQkn9tuznohUU/j80xvPH |
| 614 | FOcDGQYmh4m2aIJtlNVP6+/92Siugb5y7HfslyRK94+bZBg2D86TcCJWaaZOFUrR |
| 615 | Y3WniYXsqM5/JI4OOzu7dpjtkJUYvwtg7Qb5jmm8Ilf5rQZJhuvsygzX6+WM079y |
| 616 | nsjoQAm6OwpTN5362vE9SYu1twz7KdzBlUkDhePEOgQkWfLHBJWwB+PvB1j/cUA3 |
| 617 | 5zrbwvQf |
| 618 | -----END CERTIFICATE----- |
| 619 | ``` |
| 620 | |
| 621 | </details> |
| 622 | |
| 623 | - Enable client certificate validation on the web server that is doing the TLS termination. Below there are examples on how to perform this configuration in `NGINX` and `Apache`. |
| 624 | |
| 625 | **NGINX** |
| 626 | |
| 627 | ```bash |
| 628 | server { |
| 629 | listen 443 ssl default_server; |
| 630 | |
| 631 | # ... existing SSL configuration for server authentication ... |
| 632 | ssl_verify_client on; |
| 633 | ssl_client_certificate /path/to/Netdata_CA.pem; |
| 634 | |
| 635 | location / { |
| 636 | if ($ssl_client_s_dn !~ "CN=app.netdata.cloud") { |
| 637 | return 403; |
| 638 | } |
| 639 | # ... existing location configuration ... |
| 640 | } |
| 641 | } |
| 642 | ``` |
| 643 | |
| 644 | **Apache** |
| 645 | |
| 646 | ```bash |
| 647 | Listen 443 |
| 648 | <VirtualHost *:443> |
| 649 | # ... existing SSL configuration for server authentication ... |
| 650 | SSLVerifyClient require |
| 651 | SSLCACertificateFile "/path/to/Netdata_CA.pem" |
| 652 | </VirtualHost> |
| 653 | <Directory /var/www/> |
| 654 | Require expr "%{SSL_CLIENT_S_DN_CN} == 'app.netdata.cloud'" |
| 655 | # ... existing directory configuration ... |
| 656 | </Directory> |
| 657 | ``` |
| 658 | |
| 659 | ##### Basic authentication |
| 660 | |
| 661 | In basic authorization, the client sends a request with an Authorization header that includes a base64-encoded string in the format username:password. The server then uses this information to authenticate the client. If this authentication method is selected, the user can set the user and password that will be used when connecting to the destination service. |
| 662 | |
| 663 | ##### Bearer token authentication |
| 664 | |
| 665 | In bearer token authentication, the client sends a request with an Authorization header that includes a bearer token. The server then uses this token to authenticate the client. Bearer tokens are typically generated by an authentication service, and are passed to the client after a successful authentication. If this method is selected, the user can set the token to be used for connecting to the destination service. |
| 666 | |
| 667 | - id: "notify-cloud-ilert" |
| 668 | meta: |
| 669 | name: "ilert" |
| 670 | link: "https://www.ilert.com/" |
| 671 | categories: |
| 672 | - notify.cloud |
| 673 | icon_filename: "ilert.svg" |
| 674 | keywords: |
| 675 | - ilert |
| 676 | setup: |
| 677 | description: | |
| 678 | ### Prerequisites |
| 679 | |
| 680 | - A Netdata Cloud account |
| 681 | - Access to the Space as an **Admin** |
| 682 | - The Space needs to be on a paid plan |
| 683 | - You need to have permissions on ilert to add new Alert sources. |
| 684 | |
| 685 | ### ilert Configuration |
| 686 | |
| 687 | 1. From the navigation bar, open the Alert sources drop down and click "Alert sources" |
| 688 | 2. Click on the "+ Create a new alert source" button |
| 689 | 3. Configure an Alert source: |
| 690 | - Select "API integration" and click Next |
| 691 | - Provide a name that suits the source's purpose, for example "Netdata" |
| 692 | - Select Escalation policy |
| 693 | - Select Alert grouping (optional) |
| 694 | 4. Obtain the API Key: |
| 695 | - Once the Alert source is created, you will be provided with an API key. Copy it in order to add it to your integration configuration in the Netdata Cloud UI |
| 696 | |
| 697 | ### Netdata Configuration |
| 698 | |
| 699 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 700 | 2. Click on the **Alerts & Notifications** tab |
| 701 | 3. Click on the **+ Add configuration** button |
| 702 | 4. Add the ilert Integration |
| 703 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 704 | - **Notification settings** |
| 705 | - Configuration name (optional): A name for your configuration in order to easily refer to it |
| 706 | - Rooms: A list of Rooms for which you want to be notified |
| 707 | - Notifications: The notification types you want to receive |
| 708 | - **Integration configuration** |
| 709 | - Alert Source API key: The key you copied in the ilert configuration step. |
| 710 | |
| 711 | - id: "notify-cloud-servicenow" |
| 712 | meta: |
| 713 | name: "ServiceNow" |
| 714 | link: "https://www.servicenow.com/" |
| 715 | categories: |
| 716 | - notify.cloud |
| 717 | icon_filename: "servicenow.png" |
| 718 | keywords: |
| 719 | - servicenow |
| 720 | setup: |
| 721 | description: | |
| 722 | ### Prerequisites |
| 723 | |
| 724 | - Netdata Cloud account |
| 725 | - Access to the Space as an **Admin** |
| 726 | - The Space needs to be on a paid plan |
| 727 | - The ServiceNow **Event Management** plugin enabled on your instance |
| 728 | - A ServiceNow user with the `evt_mgmt_admin` role and a password for API access |
| 729 | |
| 730 | ### ServiceNow Configuration |
| 731 | |
| 732 | 1. Verify that the **Event Management** plugin is activated on your ServiceNow instance. |
| 733 | 2. Navigate to **System Security** --> **Users** and create a dedicated integration user if one does not already exist. |
| 734 | 3. Assign the `evt_mgmt_admin` role to this user and set a strong password. Keep the username and password available for the Netdata configuration step. |
| 735 | |
| 736 | ### Netdata Configuration |
| 737 | |
| 738 | 1. Click on the **Space settings** cog (located above your profile icon) |
| 739 | 2. Click on the **Alerts & Notifications** tab |
| 740 | 3. Click on the **+ Add configuration** button |
| 741 | 4. Add the ServiceNow Integration |
| 742 | 5. A modal will be presented to you to enter the required details to enable the integration: |
| 743 | - **Notification settings** |
| 744 | - Configuration name (optional): A descriptive name to identify this notification configuration |
| 745 | - Rooms: A list of Rooms for which you want to be notified |
| 746 | - Notifications: The notification types you want to receive |
| 747 | - **Integration configuration** |
| 748 | - Instance URL: The base URL of your ServiceNow instance (for example, `https://my-instance.service-now.com/`). |
| 749 | - Username: The username of the ServiceNow integration user you created. |
| 750 | - Password: The password of the ServiceNow integration user you created. |