Updated Cloud Notification Integrations with the new schema (#15628)
* Updated Cloud Notification Integrations with the new schema * Remove trailing spaces
Satyadeep Ashwathnarayana committed
Jul 28, 2023 at 20:31 UTC
fb3fac16437588ed02df51cdb8fb651e6ef4bdfe
1 file changed
+153
-102
integrations/cloud-notifications/metadata.yaml
+153
-102
@@ -30,27 +30,24 @@
30
3. Specify the **Name** and **Channel** on your new webhook
31
4. Use Webhook URL to add your notification configuration on Netdata UI
32
33
- - title: ''
34
- description: |
35
-
36
- ## Configuration Steps
37
-
38
- 1. Click on the **Space settings** cog (located above your profile icon)
39
- 2. Click on the **Notification** tab
40
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
41
- 4. On the **Discord** card click on **+ Add**
42
- 5. A modal will be presented to you to enter the required details to enable the configuration:
43
- * **Notification settings** are Netdata specific settings
44
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
45
- - 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
46
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
47
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
48
- - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
49
- - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
50
- - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
33
+ configuration:
34
+ description: |
35
+ ## Configuration Steps:
36
37
+ 1. Click on the **Space settings** cog (located above your profile icon)
38
+ 2. Click on the **Notification** tab
39
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
40
+ 4. On the **Discord** card click on **+ Add**
41
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
42
+ * **Notification settings** are Netdata specific settings
43
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
44
+ - 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
45
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
46
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord:
47
+ - Define the type channel you want to send notifications to: **Text channel** or **Forum channel**
48
+ - Webhook URL - URL provided on Discord for the channel you want to receive your notifications.
49
+ - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well
50
53
- configuration:
51
file:
52
name: ''
53
description: ''
@@ -103,25 +100,22 @@
100
2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined
101
3. Once the service is created you will be redirected to its configuration page, where you can copy the **integration key**, that you will need need to add to your notification configuration on Netdata UI.
102
106
- - title: ''
107
- description: |
108
-
109
- ## Configuration Steps
110
-
111
- 1. Click on the **Space settings** cog (located above your profile icon)
112
- 2. Click on the **Notification** tab
113
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
114
- 4. On the **PagerDuty** card click on **+ Add**
115
- 5. A modal will be presented to you to enter the required details to enable the configuration:
116
- * **Notification settings** are Netdata specific settings
117
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
118
- - 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
119
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
120
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
121
- - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
122
-
103
104
configuration:
105
+ description: |
106
+ ## Configuration Steps
107
+
108
+ 1. Click on the **Space settings** cog (located above your profile icon)
109
+ 2. Click on the **Notification** tab
110
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
111
+ 4. On the **PagerDuty** card click on **+ Add**
112
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
113
+ * **Notification settings** are Netdata specific settings
114
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
115
+ - 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
116
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
117
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty:
118
+ - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service.
119
file:
120
name: ''
121
description: ''
@@ -180,25 +174,22 @@
174
175
For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack).
176
183
- - title: ''
184
- description: |
185
-
186
- ## Configuration Steps
187
-
188
- 1. Click on the **Space settings** cog (located above your profile icon)
189
- 2. Click on the **Notification** tab
190
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
191
- 4. On the **Slack** card click on **+ Add**
192
- 5. A modal will be presented to you to enter the required details to enable the configuration:
193
- * **Notification settings** are Netdata specific settings
194
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
195
- - 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
196
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
197
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
198
- - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
177
+ configuration:
178
+ description: |
179
+ ## Configuration Steps
180
181
+ 1. Click on the **Space settings** cog (located above your profile icon)
182
+ 2. Click on the **Notification** tab
183
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
184
+ 4. On the **Slack** card click on **+ Add**
185
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
186
+ * **Notification settings** are Netdata specific settings
187
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
188
+ - 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
189
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
190
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack:
191
+ - Webhook URL - URL provided on Slack for the channel you want to receive your notifications.
192
201
- configuration:
193
file:
194
name: ''
195
description: ''
@@ -252,25 +243,21 @@
243
2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**.
244
3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata.
245
255
- - title: ''
256
- description: |
257
-
258
- ## Configuration Steps
259
-
260
- 1. Click on the **Space settings** cog (located above your profile icon)
261
- 2. Click on the **Notification** tab
262
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
263
- 4. On the **Opsgenie** card click on **+ Add**
264
- 5. A modal will be presented to you to enter the required details to enable the configuration:
265
- * **Notification settings** are Netdata specific settings
266
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
267
- - 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
268
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
269
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
270
- - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
271
-
272
-
246
configuration:
247
+ description: |
248
+ ## Configuration Steps
249
+
250
+ 1. Click on the **Space settings** cog (located above your profile icon)
251
+ 2. Click on the **Notification** tab
252
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
253
+ 4. On the **Opsgenie** card click on **+ Add**
254
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
255
+ * **Notification settings** are Netdata specific settings
256
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
257
+ - 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
258
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
259
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie:
260
+ - API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
261
file:
262
name: ''
263
description: ''
@@ -330,24 +317,21 @@
317
318
For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/).
319
333
- - title: ''
334
- description: |
335
-
336
- ## Configuration Steps
337
-
338
- 1. Click on the **Space settings** cog (located above your profile icon)
339
- 2. Click on the **Notification** tab
340
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
341
- 4. On the **Mattermost** card click on **+ Add**
342
- 5. A modal will be presented to you to enter the required details to enable the configuration:
343
- * **Notification settings** are Netdata specific settings
344
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
345
- - 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
346
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
347
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
348
- - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
349
-
320
configuration:
321
+ description: |
322
+ ## Configuration Steps
323
+
324
+ 1. Click on the **Space settings** cog (located above your profile icon)
325
+ 2. Click on the **Notification** tab
326
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
327
+ 4. On the **Mattermost** card click on **+ Add**
328
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
329
+ * **Notification settings** are Netdata specific settings
330
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
331
+ - 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
332
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
333
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost:
334
+ - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications
335
file:
336
name: ''
337
description: ''
@@ -407,24 +391,91 @@
391
392
For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/).
393
394
+
395
+ configuration:
396
+ description: |
397
+ ## Configuration Steps
398
+
399
+ 1. Click on the **Space settings** cog (located above your profile icon)
400
+ 2. Click on the **Notification** tab
401
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
402
+ 4. On the **RocketChat** card click on **+ Add**
403
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
404
+ * **Notification settings** are Netdata specific settings
405
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
406
+ - 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
407
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
408
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
409
+ - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
410
+ file:
411
+ name: ''
412
+ description: ''
413
+ options:
414
+ description: ''
415
+ folding:
416
+ title: ''
417
+ enabled: true
418
+ list:
419
+ - name: ''
420
+ default_value: ''
421
+ description: ''
422
+ required: false
423
+ examples:
424
+ folding:
425
+ enabled: true
426
+ title: ''
427
+ list:
428
+ - name: ''
429
+ folding:
430
+ enabled: false
431
+ description: ''
432
+ config: ''
433
+- id: 'notify-webhook'
434
+ meta:
435
+ name: 'Webhook'
436
+ link: 'https://en.wikipedia.org/wiki/Webhook'
437
+ categories:
438
+ - notify.cloud
439
+ icon_filename: 'webhooks.png'
440
+ keywords:
441
+ - generic webhooks
442
+ - webhooks
443
+ overview:
444
+ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on a webhook using a predefined schema."
445
+ notification_limitations: ''
446
+ setup:
447
+ prerequisites:
448
+ list:
449
- title: ''
450
description: |
412
-
413
- ## Configuration Steps
451
+ - A Netdata Cloud account
452
+ - Access to the Netdata Space as an **administrator**
453
+ - The Netdata Space needs to be on **Pro** plan or higher
454
+ - You need to have an app that allows you to receive webhooks following a predefined schema.
455
415
- 1. Click on the **Space settings** cog (located above your profile icon)
416
- 2. Click on the **Notification** tab
417
- 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
418
- 4. On the **RocketChat** card click on **+ Add**
419
- 5. A modal will be presented to you to enter the required details to enable the configuration:
420
- * **Notification settings** are Netdata specific settings
421
- - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
422
- - 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
423
- - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
424
- * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat:
425
- - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications.
456
457
configuration:
458
+ description: |
459
+ ## Configuration Steps
460
+
461
+ 1. Click on the **Space settings** cog (located above your profile icon)
462
+ 2. Click on the **Notification** tab
463
+ 3. Click on the **+ Add configuration** button (near the top-right corner of your screen)
464
+ 4. On the **Mattermost** card click on **+ Add**
465
+ 5. A modal will be presented to you to enter the required details to enable the configuration:
466
+ * **Notification settings** are Netdata specific settings
467
+ - Configuration name - you can optionally provide a name for your configuration you can easily refer to it
468
+ - 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
469
+ - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only
470
+ * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For webhook:
471
+ - Webhook URL - webhook URL is the url of the service that Netdata will send notifications to. In order to keep the communication secured, we only accept HTTPS urls.
472
+ - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL.
473
+ - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms.
474
+ * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected.
475
+ * Basic - the client sends a request with an Authorization header that includes a base64-encoded string in the format **username:password**. These will settings will be required inputs.
476
+ * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input.
477
+
478
+
479
file:
480
name: ''
481
description: ''
@@ -447,4 +498,4 @@
498
folding:
499
enabled: false
500
description: ''
450
- config: ''
\ No newline at end of file
501
+ config: ''