diff options
author | Satyadeep Ashwathnarayana <96257330+sashwathn@users.noreply.github.com> | 2023-08-01 18:35:39 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-08-01 16:05:39 +0300 |
commit | 7a9f81f8c30a3e27020624611ee98269252216e1 (patch) | |
tree | ea2c1831423c833d679c5397f18f70d8f82eb26e /integrations/cloud-notifications | |
parent | 9b461c49ea82a006ccaba7d48046c611eae8f384 (diff) |
Adapt Cloud notifications to the new schema (#15674)
* Update metadata.yaml for Cloud Notifications
* Update metadata.yaml
* Adapting Cloud Notifications to the updated schema
* Added "|" to every description section
Diffstat (limited to 'integrations/cloud-notifications')
-rw-r--r-- | integrations/cloud-notifications/metadata.yaml | 641 |
1 files changed, 232 insertions, 409 deletions
diff --git a/integrations/cloud-notifications/metadata.yaml b/integrations/cloud-notifications/metadata.yaml index d608f9da10..f9a8adaa6e 100644 --- a/integrations/cloud-notifications/metadata.yaml +++ b/integrations/cloud-notifications/metadata.yaml @@ -14,63 +14,34 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Discord." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - title: 'Discord Server Configuration' - description: | - You need to have a Discord server able to receive [webhooks integrations](https://support.discord.com/hc/en-us/articles/228383668). - Steps to configure your Discord server to receive notifications from Netdata: - - 1. Go to `Server Settings` --> `Integrations` - 2. **Create Webhook** or **View Webhooks** if you already have some defined - 3. Specify the **Name** and **Channel** on your new webhook - 4. Use Webhook URL to add your notification configuration on Netdata UI - - configuration: - description: | - ## Configuration Steps: - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **Discord** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord: - - Define the type channel you want to send notifications to: **Text channel** or **Forum channel** - - Webhook URL - URL provided on Discord for the channel you want to receive your notifications. - - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well - - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + description: | + ### Prerequisites + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - You need to have a Discord server able to receive webhooks integrations. + + ### Discord Server Configuration + Steps to configure your Discord server to receive [webhook notifications](https://support.discord.com/hc/en-us/articles/228383668) from Netdata: + 1. Go to `Server Settings` --> `Integrations` + 2. **Create Webhook** or **View Webhooks** if you already have some defined + 3. Specify the **Name** and **Channel** on your new webhook + 4. Use Webhook URL to add your notification configuration on Netdata UI + + ### Netdata Configuration Steps + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Discord** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Discord: + - Define the type channel you want to send notifications to: **Text channel** or **Forum channel** + - Webhook URL - URL provided on Discord for the channel you want to receive your notifications. + - Thread name - if the Discord channel is a **Forum channel** you will need to provide the thread name as well + - id: 'notify-pagerduty' meta: name: 'PagerDuty' @@ -84,61 +55,35 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on PagerDuty." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher - - title: 'Discord Server Configuration' - description: | - You need to have a PagerDuty service to receive events using webhooks. - Steps to configure your PagerDuty to receive notifications from Netdata: - - 1. Create a service to receive events from your services directory page on PagerDuty - 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined - 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. - - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **PagerDuty** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty: - - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service. - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + description: | + ### Prerequisites + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Business** plan or higher + - You need to have a PagerDuty service to receive events using webhooks. + + + ### PagerDuty Server Configuration + Steps to configure your PagerDuty to receive notifications from Netdata: + + 1. Create a service to receive events from your services directory page on PagerDuty + 2. At step 3, select `Events API V2` Integration or **View Webhooks** if you already have some defined + 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. + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **PagerDuty** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For PagerDuty: + - Integration Key - is a 32 character key provided by PagerDuty to receive events on your service. + - id: 'notify-slack' meta: name: 'Slack' @@ -152,67 +97,42 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Slack." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher - - title: 'Slack Server Configuration' - description: | - You need to have a Slack app on your workspace to receive the Webhooks. - Steps to configure your Slack to receive notifications from Netdata: - - 1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details - 2. Install the app on your workspace - 3. Configure Webhook URLs for your workspace - - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks** - - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace** - - After pressing that specify the channel where you want your notifications to be delivered - - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI - - For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack). - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **Slack** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack: - - Webhook URL - URL provided on Slack for the channel you want to receive your notifications. - - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + description: | + ### Prerequisites + + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Business** plan or higher + - You need to have a Slack app on your workspace to receive the Webhooks. + + ### Slack Server Configuration + + Steps to configure your Slack to receive notifications from Netdata: + + 1. Create an app to receive webhook integrations. Check [Create an app](https://api.slack.com/apps?new_app=1) from Slack documentation for further details + 2. Install the app on your workspace + 3. Configure Webhook URLs for your workspace + - On your app go to **Incoming Webhooks** and click on **activate incoming webhooks** + - At the bottom of **Webhook URLs for Your Workspace** section you have **Add New Webhook to Workspace** + - After pressing that specify the channel where you want your notifications to be delivered + - Once completed copy the Webhook URL that you will need to add to your notification configuration on Netdata UI + + For more details please check Slacks's article [Incoming webhooks for Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack). + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Slack** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Slack: + - Webhook URL - URL provided on Slack for the channel you want to receive your notifications. + - id: 'notify-opsgenie' meta: name: 'Opsgenie' @@ -227,60 +147,36 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher - - title: 'Opsgenie Configuration' - description: | - You need to have permissions on Opsgenie to add new integrations. - Steps to configure your Opsgenie to receive notifications from Netdata: - - 1. Go to integrations tab of your team, click **Add integration** - 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**. - 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata. - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **Opsgenie** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie: - - API Key - a key provided on Opsgenie for the channel you want to receive your notifications. - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + description: | + ### Prerequisites + + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Business** plan or higher + - You need to have permissions on Opsgenie to add new integrations. + + ### Opsgenie Server Configuration + + Steps to configure your Opsgenie to receive notifications from Netdata: + + 1. Go to integrations tab of your team, click **Add integration** + 2. Pick **API** from available integrations. Copy your API Key and press **Save Integration**. + 3. Paste copied API key into the corresponding field in **Integration configuration** section of Opsgenie modal window in Netdata. + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Opsgenie** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Opsgenie: + - API Key - a key provided on Opsgenie for the channel you want to receive your notifications. + - id: 'notify-mattermost' meta: name: 'Mattermost' @@ -294,67 +190,44 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Mattermost." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher - - title: 'Mattermost Configuration' - description: | - You need to have a Mattermost app on your workspace to receive the webhooks. - Steps to configure your Mattermost to receive notifications from Netdata: - - 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook - - 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. - 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters - 3. Select the channel to receive webhook payloads, then select Add to create the webhook - 4. You will end up with a webhook endpoint that looks like below: - `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx` - - - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance. + description: | + ### Prerequisites + + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Business** plan or higher + - You need to have permissions on Mattermost to add new integrations. + - You need to have a Mattermost app on your workspace to receive the webhooks. + + ### Mattermost Server Configuration + + Steps to configure your Mattermost to receive notifications from Netdata: + + 1. In Mattermost, go to Product menu > Integrations > Incoming Webhook + - 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. + 2. Select Add Incoming Webhook and add a name and description for the webhook. The description can be up to 500 characters + 3. Select the channel to receive webhook payloads, then select Add to create the webhook + 4. You will end up with a webhook endpoint that looks like below: + `https://your-mattermost-server.com/hooks/xxx-generatedkey-xxx` + + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your Mattermost instance. - For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/). - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **Mattermost** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost: - - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + For more details please check Mattermost's article [Incoming webhooks for Mattermost](https://developers.mattermost.com/integrate/webhooks/incoming/). + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Mattermost** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Mattermost: + - Webhook URL - URL provided on Mattermost for the channel you want to receive your notifications + - id: 'notify-rocketchat' meta: name: 'RocketChat' @@ -368,68 +241,44 @@ notification_description: "From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on RocketChat." notification_limitations: '' setup: - prerequisites: - list: - - title: 'Netdata Access' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Business** plan or higher - - title: 'RocketChat Configuration' - description: | - You need to have a RocketChat app on your workspace to receive the webhooks. - Steps to configure your RocketChat to receive notifications from Netdata: - - 1. In RocketChat, Navigate to Administration > Workspace > Integrations. - 2. Click **+New** at the top right corner. - 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). - 4. After configuring integration, click Save. - 5. You will end up with a webhook endpoint that looks like below: - `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` - - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance. + description: | + ### Prerequisites + + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Business** plan or higher + - You need to have permissions on Mattermost to add new integrations. + - You need to have a RocketChat app on your workspace to receive the webhooks. + + ### Mattermost Server Configuration + + Steps to configure your RocketChat to receive notifications from Netdata: + + 1. In RocketChat, Navigate to Administration > Workspace > Integrations. + 2. Click **+New** at the top right corner. + 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). + 4. After configuring integration, click Save. + 5. You will end up with a webhook endpoint that looks like below: + `https://your-server.rocket.chat/hooks/YYYYYYYYYYYYYYYYYYYYYYYY/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX` + - Treat this endpoint as a secret. Anyone who has it will be able to post messages to your RocketChat instance. - For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/). - - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **RocketChat** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat: - - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications. - file: - name: '' - description: '' - options: - description: '' - folding: - title: '' - enabled: true - list: - - name: '' - default_value: '' - description: '' - required: false - examples: - folding: - enabled: true - title: '' - list: - - name: '' - folding: - enabled: false - description: '' - config: '' + For more details please check RocketChat's article Incoming webhooks for [RocketChat](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations/). + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **RocketChat** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For RocketChat: + - Webhook URL - URL provided on RocketChat for the channel you want to receive your notifications. + - id: 'notify-webhook' meta: name: 'Webhook' @@ -444,42 +293,39 @@ 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." notification_limitations: '' setup: - prerequisites: - list: - - title: '' - description: | - - A Netdata Cloud account - - Access to the Netdata Space as an **administrator** - - The Netdata Space needs to be on **Pro** plan or higher - - You need to have an app that allows you to receive webhooks following a predefined schema. - - - configuration: - description: | - ## Configuration Steps - - 1. Click on the **Space settings** cog (located above your profile icon) - 2. Click on the **Notification** tab - 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) - 4. On the **Mattermost** card click on **+ Add** - 5. A modal will be presented to you to enter the required details to enable the configuration: - * **Notification settings** are Netdata specific settings - - Configuration name - you can optionally provide a name for your configuration you can easily refer to it - - 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 - - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only - * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For webhook: - - 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. - - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. - - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms. - * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected. - * 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. - * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input. - - ## Webhook service + description: | + ### Prerequisites + + - A Netdata Cloud account + - Access to the Netdata Space as an **administrator** + - The Netdata Space needs to be on **Pro** plan or higher + - You need to have an app that allows you to receive webhooks following a predefined schema. + + ### Netdata Configuration Steps + + 1. Click on the **Space settings** cog (located above your profile icon) + 2. Click on the **Notification** tab + 3. Click on the **+ Add configuration** button (near the top-right corner of your screen) + 4. On the **Webhook** card click on **+ Add** + 5. A modal will be presented to you to enter the required details to enable the configuration: + * **Notification settings** are Netdata specific settings + - Configuration name - you can optionally provide a name for your configuration you can easily refer to it + - 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 + - Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only + * **Integration configuration** are the specific notification integration required settings, which vary by notification method. For Webhook: + - 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. + - Extra headers - these are optional key-value pairs that you can set to be included in the HTTP requests sent to the webhook URL. + - Authentication Mechanism - Netdata webhook integration supports 3 different authentication mechanisms. + * Mutual TLS (recommended) - default authentication mechanism used if no other method is selected. + * 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. + * Bearer - the client sends a request with an Authorization header that includes a **bearer token**. This setting will be a required input. + + + ### Webhook service A webhook integration allows your application to receive real-time alerts from Netdata by sending HTTP requests to a specified URL. In this document, we'll go over the steps to set up a generic webhook integration, including adding headers, and implementing different types of authorization mechanisms. - ### Netdata webhook integration + #### Netdata webhook integration A webhook integration is a way for one service to notify another service about events that occur within it. This is done by sending an HTTP POST request to a specified URL (known as the "webhook URL") when an event occurs. @@ -505,7 +351,7 @@ | additional_active_warning_alerts | integer | Number of additional warning alerts currently existing on the same node. | | alarm_url | string | Netdata Cloud URL for this alarm. | - ### Extra headers + #### Extra headers When setting up a webhook integration, the user can specify a set of headers to be included in the HTTP requests sent to the webhook URL. @@ -515,11 +361,11 @@ |:-------------------------------:|-----------------------------| | Content-Type | application/json | - ### Authentication mechanisms + #### Authentication mechanisms Netdata webhook integration |