Merge pull request #6205 from EnterpriseDB/release/2024-11-05a

Release: 2024-11-05a

advocacy_docs/edb-postgres-ai/console/using/notifications.mdx

@@ -4,15 +4,20 @@ navTitle: Notifications
 description: "Use notifications to get an alert for the different types of events occurring in your EDB Postgres AI account, organizations, and projects."
 redirects:
   - /biganimal/latest/administering_cluster/notifications/ #generated for BigAnimal URL path removal branch
+deepToC: true
+indexdepth: 3
 ---
 
-With EDB Postgres AI, you can opt to get specific types of notifications and receive both in-app and email notifications.
+With EDB Postgres AI, you can customize the types of notifications you want to receive. There are two types of notifications channels:
 
-Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications in the in-app inbox, by email, or both. 
+- User notifications channels - where you can receive notifications on email or in-app inbox or both. These notifications are for all users who have enabled them and are eligible to receive the notifications for that event.
+- System notifications channels - where you can receive notifications on slack or webhook or pagerduty or all. These notifications are designed to trigger once per event, primarily for automating tasks within the user's organization.
+
+Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications.
 The notifications are categorized into the following preference sections:
-- Account
-- Organizations
-- Projects
+- **Account** - only for user notification channels 
+- **Organizations** - for user and system notification channels both
+- **Projects** - for user and system notification channels both
 
 The notifications under the **Account** preference section are:
 
@@ -44,12 +49,83 @@ The notifications under the **Projects** preference section are:
 
 ## Configuring notifications
 
-The project owners/editors and organization owners/admins can configure the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email, or both. They can also configure email notifications for their teams in their organization. 
-
-Project-level notifications are configured in the project.
+The project owners/editors and organization owners/admins can enable/disable the notifications for the events visible to them. They can choose if they want to receive notifications in the in-app inbox, by email or both. 
 
 Notification settings made by a user apply only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login.
 
+System notification channels can be configured at Organization-level by organization owner or at Project-level by project owner. By default, the Organization-level system notifications channel are inherited by each project of that organization. However you can enable/disable or re-configure the system notifications channel at the Project-level to override the default settings.
+
+This steps shows how to configure the system notification channels at Organization-level:
+
+### Configure Slack notification channel
+
+To configure Slack notification channel:
+
+1. Log in to the EDB Postgres AI console.
+1. From the menu under your name in the top-right panel, select **Settings**. 
+1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty.
+1. Select **Slack** and a window pops-up, provide the following details:
+   1. Access token - provide a slack bot access token.
+   1. Slack Channel on which notification are to be sent. For example: #general, #alerts, #notifications, etc.
+   1. Select **Save** button
+
+!!!note
+Before configuring slack notification channel, you need to create the slack app and grant the following permissions:
+- `chat:write`
+- `im:write`
+- `users:read.email`
+- `users:read`
+
+Once the slack app is created and installed on the slack workspace, you can use the slack bot user OAuth token of the slack app to setup the slack channel.
+
+Also make sure to add the created slack app to the slack channel of your choice.
+!!!
+
+
+### Configure Webhook notification channel
+
+To configure Webhook notification channel:
+
+1. Log in to the EDB Postgres AI console.
+1. From the menu under your name in the top-right panel, select **Settings**. 
+1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty.
+1. Select **Webhook** and provide the details on the pop-up window:
+   1. Host URL of the Webhook
+   1. Method of the Webhook - POST or PUT
+   1. Optionally provide any of these authentication parameters 
+      1. For Basic Auth:
+         1. Username
+         2. Password
+      2. For Bearer Token:
+         1. Bearer Token
+   2. Select **Save** button.
+
+### Configure Pager Duty notification channel
+
+To configure Pager Duty notification channel:
+
+1. Log in to the EDB Postgres AI console.
+1. From the menu under your name in the top-right panel, select **Settings**. 
+1. Select the **Notifications** tab. Options available are Webhook, Slack, and Pager Duty.
+1. Select **Pager Duty** and provide the details on the pop-up window:
+   1. Set Routing Key(integration key).
+   2. Select **Save** button. 
+
+!!!note
+Before configuring Pager Duty notification channel:
+- You need to have access to a Pager Duty account with elevated privileges.
+- Pager Duty Service created and configured with Events API v2 integration.
+- In your PagerDuty account, navigate to the desired Service and access its "Integrations" settings.
+- Add a new "Events API v2" integration and configure it according to your requirements.
+- Copy the Integration Key(routing key) provided by PagerDuty for the newly created integration.
+!!!
+
+To configure the system notifications channel at Project-level:
+- Go to **Project Overview** page
+- Select **Settings** on the left-side menu
+- Select **Notifications**
+- Follow the steps as mentioned above for Organization-level for each of the system notification channel.
+
 ## Viewing notifications
 
 Users in the following roles can view the notifications: