summaryrefslogtreecommitdiffstats
path: root/integrations/cloud-notifications/integrations/ilert.md
diff options
context:
space:
mode:
Diffstat (limited to 'integrations/cloud-notifications/integrations/ilert.md')
-rw-r--r--integrations/cloud-notifications/integrations/ilert.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/integrations/cloud-notifications/integrations/ilert.md b/integrations/cloud-notifications/integrations/ilert.md
new file mode 100644
index 000000000..31243d6cc
--- /dev/null
+++ b/integrations/cloud-notifications/integrations/ilert.md
@@ -0,0 +1,51 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/ilert.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml"
+sidebar_label: "ilert"
+learn_status: "Published"
+learn_rel_path: "Alerts & Notifications/Notifications/Centralized Cloud Notifications"
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE"
+endmeta-->
+
+# ilert
+
+<img src="https://netdata.cloud/img/ilert.svg" width="150"/>
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Setup
+
+### Prerequisites
+
+- A Netdata Cloud account
+- Access to the Space as an **Admin**
+- The Space needs to be on a paid plan
+- You need to have permissions on ilert to add new Alert sources.
+
+### ilert Configuration
+
+1. From the navigation bar, open the Alert sources drop down and click "Alert sources"
+2. Click on the "+ Create a new alert source" button
+3. Configure an Alert source:
+ - Select "API integration" and click Next
+ - Provide a name that suits the source's purpose, for example "Netdata"
+ - Select Escalation policy
+ - Select Alert grouping (optional)
+4. Obtain the API Key:
+ - 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
+
+### Netdata Configuration
+
+1. Click on the **Space settings** cog (located above your profile icon)
+2. Click on the **Alerts & Notifications** tab
+3. Click on the **+ Add configuration** button
+4. Add the ilert Integration
+5. A modal will be presented to you to enter the required details to enable the integration:
+ - **Notification settings**
+ - Configuration name (optional): A name for your configuration in order to easily refer to it
+ - Rooms: A list of Rooms for which you want to be notified
+ - Notifications: The notifications which you want to be notified
+ - **Integration configuration**
+ - Alert Source API key: The key you copied in the ilert configuration step.
+
+