> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aviatrix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notifications

> This section provides the purpose, elements, and actions performed on the Notifications pages.

This section provides the purpose, elements, and actions performed on the
**Notifications** pages.

> [tab] Alerts
>
> ## Purpose
>
> The **Alerts** page displays active alerts with details about affected entities,
> conditions, and timestamps.
>
> ## Elements
>
> ![Notifications: Alerts](https://docs.aviatrix.com/images/reference/ui/monitor/alerts.png)
>
> * **Search box**: Search box for filtering alerts (shows **Search Unavailable**
>   when the table has no rows).
> * **Open** button: Opens saved views (**All Alerts**, **Open Alerts**, **Unread
>   Alerts**).
> * **Actions** menu (admin only): **Mark as Read**, **Mark as Unread**, and
>   **Delete Alerts** (disabled until at least one alert is selected).
> * **Filter button**: Opens filter dialog to filter alerts.
> * **Columns button**: Opens column selection dialog to customize visible columns
>   (includes hidden-by-default **State** and **Read** columns).
> * **Download button**: Downloads alert data.
> * **Table row checkboxes** and **Table header checkbox**: Select alerts for bulk
>   **Actions**.
> * **Open alerts** chip: Appears in the toolbar when one or more alerts are in
>   the **Open** state.
> * **Name** link: Opens an alert details panel; an **Open** chip appears next to
>   the name for open alerts.
> * **actions column** (admin only): Per-row **Mark as Read** or **Mark as
>   Unread** and **Delete**.
> * **Refresh status**: Text showing last refresh time with a refresh button.
> * **Bell icon** (per row, user-defined alerts only): Pauses the alert.
>
> ## Actions
>
> > [accordion] View Alerts
> >
> > To view active alerts:
> >
> > 1. Go to **Monitor** > **Notifications** > **Alerts**.
> > 2. The Alerts page appears with the list of active alerts (Name, Affected Entities, Condition, First Received, Last Received).
> > 3. Optionally, click an alert **Name** to open its details panel.
> > 4. Optionally, use **Search**, **Open**, **Filter**, or **Columns** to customize the view.
> > 5. Optionally, select alerts with the row or header checkboxes and use **Actions**, click **Download**, or use **Refresh status** to reload the table.
> >
> > The Alerts page displays active alerts for the CoPilot environment.
> >
> > ### Parameter Details
> >
> > | CoPilot Parameter Name | Description |
> > | - | - |
> > | Name | Shows alert name; click to open details. An **Open** chip appears for open alerts. |
> > | State | Shows whether the alert is **Open** or **Closed** (hidden by default; enable with **Columns**). |
> > | Affected Entities | Shows entities affected by alert. |
> > | Condition | Shows alert condition. |
> > | First Received | Shows timestamp when alert was first received. |
> > | Last Received | Shows timestamp when alert was last received. |
> > | actions | Admin-only per-row **Mark as Read**/**Mark as Unread** and **Delete**. |
>
> > [accordion] Pause an Alert
> >
> > To pause a user-defined alert:
> >
> > 1. Go to **Monitor** > **Notifications** > **Alerts**.
> > 2. Locate the user-defined alert in the list.
> > 3. Click the alert's **bell icon**.
> >
> > The alert is paused.

> [tab] Alert Configurations
>
> ## Purpose
>
> The **Alert Configurations** page manages alert configuration rules with
> conditions, monitored entities, and recipients.
>
> ## Elements
>
> ![Notifications: Alert Configurations](https://docs.aviatrix.com/images/reference/ui/monitor/alert-configurations.png)
>
> * **Alert Configuration button**: Opens dialog to create new alert configuration
>   (admin only).
> * **Search**: Search box for filtering alert configurations.
> * **Filter button**: Opens filter dialog to filter configurations.
> * **Columns button**: Opens column selection dialog to customize visible
>   columns.
> * **Download button**: Downloads configuration data.
> * **Refresh status**: Text showing last refresh time with a refresh button.
> * **actions column** (admin only): Per-row menu with **Edit**, **Delete**, and
>   **Pause**/**Unpause**. Edit and Delete are disabled for certain built-in alert
>   configurations (for example, Global Control Plane Health, Global Network
>   Health, Global Memory Swap Surge, Scaling, and Anomaly alerts).
>
> ## Actions
>
> > [accordion] View Alert Configurations
> >
> > To view alert configurations:
> >
> > 1. Go to **Monitor** > **Notifications** > **Alert Configurations**.
> > 2. The Alert Configurations page appears with the list of alert configuration rules.
> > 3. Optionally, use **Search**, **Filter**, **Columns**, **Download**, or **Refresh status**.
> > 4. Click a configuration's **Name** to open a details drawer showing its full configuration. If you are an admin, the drawer also provides **Edit**, **Delete**, and **Pause**/**Unpause** icon buttons.
> >
> > The page displays alert configuration rules with conditions, monitored entities,
> > and recipients.
> >
> > ### Parameter Details
> >
> > | CoPilot Parameter Name | Description |
> > | - | - |
> > | Name | Shows alert configuration name. A **Paused** chip appears next to the name if the alert is paused. |
> > | Condition | Shows alert conditions configured. |
> > | Monitored Entities | Shows entities monitored by configuration. |
> > | Evaluation Period | Shows evaluation period for alert. |
> > | Recipients | Shows recipients for alert notifications. |
> > | actions | Admin-only per-row menu with **Edit**, **Delete**, and **Pause**/**Unpause**. |
>
> > [accordion] Create Alert Configuration
> >
> > To create a new alert configuration:
> >
> > 1. Go to **Monitor** > **Notifications** > **Alert Configurations**.
> > 2. Click **Alert Configuration** to open the create dialog.
> > 3. Configure conditions, monitored entities, evaluation period, and recipients.
> > 4. Save the configuration.
> >
> > The new alert configuration appears in the list.
>
> > [accordion] Edit, Delete, or Pause an Alert Configuration
> >
> > To manage an existing alert configuration:
> >
> > 1. Go to **Monitor** > **Notifications** > **Alert Configurations**.
> > 2. In the row's actions menu (or in the details drawer opened from the configuration's **Name**), select **Edit**, **Delete**, or **Pause**/**Unpause**.
> > 3. If editing, update the configuration in the dialog and save. If deleting, confirm the deletion.
> >
> > Some built-in alert configurations restrict Edit and/or Delete to protect
> > default system alerts.

> [tab] System Messages
>
> ## Purpose
>
> The **System Messages** page displays system messages with timestamps, types,
> and descriptions.
>
> Controller bell notifications also appear on this page. To identify them, filter
> the **Entity** column for `Controller`. CoPilot displays these notifications but
> does not currently manage their configuration; to turn Controller bell
> notifications on or off, configure them in the Controller UI.
>
> ## Elements
>
> ![Notifications: System Messages](https://docs.aviatrix.com/images/reference/ui/monitor/system-messages.png)
>
> * **Search box**: Search box for filtering system messages (shows **Search
>   Unavailable** when the table has no rows).
> * **Open** button: Opens saved views (**All Messages**, **Important Messages**,
>   **Unread Messages**).
> * **Actions** menu (admin only): **Mark as Read** and **Mark as Unread**
>   (disabled until at least one message is selected).
> * **Filter button**: Opens filter dialog to filter messages.
> * **Columns button**: Opens column selection dialog to customize visible columns
>   (includes hidden-by-default **Entity ID** and **Is Read** columns).
> * **Download button**: Downloads message data.
> * **Table row checkboxes** and **Table header checkbox**: Select messages for
>   bulk **Actions**.
> * **Description** expand icon: Opens a popover with the full message text and
>   timestamp.
> * **Refresh status**: Text showing last refresh time with a refresh button.
> * **actions column** (admin only): Per-row **Mark as Read** or **Mark as
>   Unread** icon button.
>
> ## Actions
>
> > [accordion] View System Messages
> >
> > To view system messages:
> >
> > 1. Go to **Monitor** > **Notifications** > **System Messages**.
> > 2. The System Messages page appears with the list of messages (Timestamp, Type, Raised By, Entity, Description).
> > 3. Optionally, use **Search**, **Open**, **Filter**, **Columns**, **Download**, or **Refresh status**. Select messages and use **Actions** as needed.
> > 4. Click a message's **Mark as Read** or **Mark as Unread** control in the **actions column**, or use the **Description** expand icon to read the full text.
> >
> > ### Parameter Details
> >
> > | CoPilot Parameter Name | Description |
> > | - | - |
> > | Timestamp | Shows message timestamp. |
> > | Type | Shows message type. |
> > | Raised By | Shows component that raised message. |
> > | Entity | Shows entity associated with message. |
> > | Description | Shows message description. |
> > | actions | Admin-only per-row **Mark as Read** or **Mark as Unread** icon button. |

> [tab] Tasks
>
> > [tab] Tasks
> >
> > ## Purpose
> >
> > The **Tasks** page displays task information with status, progress, and timing
> > details. Long-running operations started elsewhere in CoPilot (for example,
> > cloud account audits, report generation, or configuration exports) appear here
> > so you can track their status and progress.
> >
> > ## Elements
> >
> > ![Notifications: Tasks](https://docs.aviatrix.com/images/reference/ui/monitor/tasks.png)
> >
> > * **Filter button**: Opens filter dialog to filter tasks.
> > * **Columns button**: Opens column selection dialog to customize visible
> >   columns.
> > * **Download button**: Downloads task data.
> > * **Refresh status**: Text showing last refresh time with a refresh button.
> > * **Expand row icon**: Shown for tasks that have nested subtasks; expands to
> >   reveal the subtask hierarchy.
> >
> > ## Actions
> >
> > > [accordion] View Tasks
> > >
> > > To view tasks:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Tasks** > **Tasks**.
> > > 2. The Tasks page appears with the list of tasks (Name, User, Status, Progress, Start Time, End Time).
> > > 3. Optionally, use **Filter**, **Columns**, **Download**, or **Refresh status**. Click the expand icon on a task with subtasks to view its hierarchy.
> > >
> > > ### Parameter Details
> > >
> > > | CoPilot Parameter Name | Description |
> > > | - | - |
> > > | Name | Shows task name. |
> > > | User | Shows user who initiated task. |
> > > | Status | Shows task status: **Pending**, **In Progress**, **Completed**, **Error**, or **Unknown**. |
> > > | Progress | Shows task progress percentage. |
> > > | Start Time | Shows task start timestamp. |
> > > | End Time | Shows task end timestamp. |
>
> > [tab] Active Gateway Operations
> >
> > ## Purpose
> >
> > The **Active Gateway Operations** page displays in-progress gateway operations
> > (such as upgrades or restarts) with the affected gateways and progress.
> >
> > ## Elements
> >
> > ![Notifications: Active Gateway Operations](https://docs.aviatrix.com/images/reference/ui/monitor/tasks-active-gateway-operations.png)
> >
> > * **Filter button**: Opens filter dialog to filter operations.
> > * **Columns button**: Opens column selection dialog to customize visible
> >   columns.
> > * **Download button**: Downloads operation data.
> > * **Refresh status**: Text showing last refresh time with a refresh button.
> > * **View Details**: Row action that opens a dialog with the operation's full
> >   details and event log.
> >
> > ## Actions
> >
> > > [accordion] View Active Gateway Operations
> > >
> > > To view active gateway operations:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Tasks** > **Active Gateway Operations**.
> > > 2. The Active Gateway Operations page appears with the list of operations (Operation, Gateways, Progress, Start Time).
> > > 3. Click **View Details** on a row to open a dialog showing the operation's Gateways, Start Time, a progress bar, and an event log.
> > > 4. Optionally, use **Refresh status** to reload the list.
> > >
> > > ### Parameter Details
> > >
> > > | CoPilot Parameter Name | Description |
> > > | - | - |
> > > | Operation | Shows the type of gateway operation. |
> > > | Gateways | Shows the gateway(s) affected by the operation. |
> > > | Progress | Shows the operation's progress bar. |
> > > | Start Time | Shows the operation's start timestamp. |
> > > | View Details | Opens a dialog with the operation's Gateways, Start Time, progress bar, and event log console. |

> [tab] Recipients
>
> > [tab] Email Addresses
> >
> > ## Purpose
> >
> > The **Recipients** page manages email addresses and webhooks for alert
> > notifications.
> >
> > ## Elements
> >
> > ![Notifications: Email Addresses](https://docs.aviatrix.com/images/reference/ui/monitor/recipients-email-addresses.png)
> >
> > * **Email Address button** (admin only): Opens dialog to add a new email
> >   recipient.
> > * **Filter button**: Opens filter dialog.
> > * **Columns button**: Opens column selection dialog.
> > * **Download button**: Downloads recipient data.
> > * **Refresh status**: Text showing last refresh time with a refresh button.
> > * **actions column** (admin only): Per-row **Edit** and **Delete**.
> >
> > ## Actions
> >
> > > [accordion] View Email Recipients
> > >
> > > To view email recipients for alerts:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Recipients** > **Email Addresses**.
> > > 2. The Email Addresses page appears with the list of recipients (Alias, Email Address, Associated Alerts).
> > > 3. Optionally, use **Filter**, **Columns**, **Download**, or **Refresh status**.
> > >
> > > ### Parameter Details
> > >
> > > | CoPilot Parameter Name | Description |
> > > | - | - |
> > > | Alias | Shows recipient alias. |
> > > | Email Address | Shows email address. |
> > > | Associated Alerts | Shows the number of alert configurations that send to this recipient; expand to see their names. |
> > > | actions | Admin-only per-row **Edit** and **Delete**. If the recipient is associated with alert configurations, the delete confirmation asks you to acknowledge removing it from those configurations. |
> >
> > > [accordion] Add an Email Recipient
> > >
> > > To add a new email recipient:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Recipients** > **Email Addresses**.
> > > 2. Click **Email Address**.
> > > 3. Enter the recipient's alias and email address, then save.
> > >
> > > The new recipient appears in the list.
>
> > [tab] Webhooks
> >
> > ## Purpose
> >
> > The **Webhooks** page manages webhooks for alert notifications.
> >
> > ## Elements
> >
> > ![Notifications: Webhooks](https://docs.aviatrix.com/images/reference/ui/monitor/recipients-webhooks.png)
> >
> > * **Webhook button** (admin only): Opens dialog to add a new webhook.
> > * **Filter button**: Opens filter dialog.
> > * **Columns button**: Opens column selection dialog.
> > * **Download button**: Downloads webhook data.
> > * **Refresh status**: Text showing last refresh time with a refresh button.
> > * **actions column** (admin only): Per-row **Edit**, **Test Webhook**, **Preview
> >   Payload**, and **Delete**.
> >
> > ## Actions
> >
> > > [accordion] View Webhook Recipients
> > >
> > > To view webhook recipients for alerts:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Recipients** > **Webhooks**.
> > > 2. The Webhooks page appears with the list of webhooks (Name, Payload URL, Associated Alerts).
> > > 3. Click a webhook's **Name** to open its details drawer.
> > > 4. Optionally, use **Filter**, **Columns**, **Download**, or **Refresh status**.
> > >
> > > ### Parameter Details
> > >
> > > | CoPilot Parameter Name | Description |
> > > | - | - |
> > > | Name | Shows the webhook name; click to open its details drawer. |
> > > | Payload URL | Shows the webhook's destination URL. |
> > > | Associated Alerts | Shows the number of alert configurations that send to this webhook; expand to see their names. |
> > > | actions | Admin-only per-row **Edit**, **Test Webhook** (sends a test payload), **Preview Payload**, and **Delete**. If the webhook is associated with alert configurations, the delete confirmation asks you to acknowledge removing it from those configurations. |
> >
> > > [accordion] Add a Webhook Recipient
> > >
> > > To add a new webhook recipient:
> > >
> > > 1. Go to **Monitor** > **Notifications** > **Recipients** > **Webhooks**.
> > > 2. Click **Webhook**.
> > > 3. Enter a **Name** and the **Payload URL** to receive the webhook POST requests.
> > > 4. Optionally, add up to 10 **Headers**, an optional **Secret** (to validate request authenticity), an optional **CA Certificate (PEM)** (for a private CA or self-signed HTTPS endpoint), and optional **Tags/Labels**.
> > > 5. Optionally, edit the **Template** field (toggle **Preview Sample Payload** to see the resolved JSON payload), then save.
> > >
> > > The new webhook appears in the list.

> [tab] Settings
>
> ## Purpose
>
> The **Settings** page configures notification settings including recipient email
> addresses, SMTP service, software exception reporting, and which system messages
> generate bell notifications.
>
> ## Elements
>
> ![Notifications: Settings](https://docs.aviatrix.com/images/reference/ui/monitor/settings.png)
>
> * **Account and Certificate Alerts card**: Configures the **Administrator Group
>   Email** address that receives account and certificate information.
> * **Security Events card**: Configures the **Security Group Email** address that
>   receives security and CVE (Common Vulnerabilities and Exposures)
>   notifications.
> * **Critical Alerts card**: Configures the **IT Admin Group Email** address that
>   receives field notices and critical notices.
> * **Status Change Notifications card**: Configures the **IT Admin Group Email**
>   address and **Status Change Notification Interval** (in seconds, 10-3600) for
>   system/tunnel status notifications.
>
> Each of the 4 email cards above shows an inline **Verify** link once a valid,
> unverified address is entered (or **Verified** once confirmed), the autocomplete
> field's built-in clear ("x") control, and **Save**/**Cancel** buttons that
> appear once the address (or interval) is changed.
>
> * **SMTP Service card**: Displays the configured **SMTP Server**, **Protocol**,
>   and **port**, with an edit icon to open the SMTP configuration dialog.
> * **Send Software Exception Notification Emails to Aviatrix**: On/Off toggle to
>   enable/disable sending software exception notifications to Aviatrix.
> * **System Message Management card**: On/Off toggles per system message type
>   that control which system events generate a bell notification (see Parameter
>   Details), with **Save**/**Cancel** buttons that appear when a toggle is
>   changed.
>
> ## Actions
>
> > [accordion] Configure Email Notification Recipients
> >
> > To configure email notification recipients:
> >
> > 1. Go to **Monitor** > **Notifications** > **Settings**.
> > 2. In the **Account and Certificate Alerts**, **Security Events**, **Critical Alerts**, or **Status Change Notifications** card, enter the email address (and, for Status Change Notifications, the notification interval).
> > 3. Optionally, click **Verify** to send a verification email.
> > 4. Click **Save** to apply the change, or **Cancel** to discard it.
> >
> > The updated address appears in the card once saved. If the same email address is
> > already used for another notification type, a confirmation dialog appears before
> > the change is applied.
>
> > [accordion] Configure the SMTP Service
> >
> > To configure the SMTP service used for email notifications:
> >
> > 1. Go to **Monitor** > **Notifications** > **Settings**.
> > 2. In the **SMTP Service** card, click the edit icon.
> > 3. Enter the **SMTP Server**, **Protocol** (**TLS**, **SSL**, or **None**), **Port**, **Sender Email**, **Test Email**, and optional **Sender Login**/**Sender Password**.
> > 4. Save your changes.
>
> > [accordion] Manage System Message Notifications
> >
> > To control which system events generate a bell notification:
> >
> > 1. Go to **Monitor** > **Notifications** > **Settings**.
> > 2. In the **System Message Management** card, toggle individual message types **On** or **Off**.
> > 3. Click **Save** to apply your changes, or **Cancel** to discard them.
> >
> > ### Parameter Details
> >
> > | CoPilot Parameter Name | Description |
> > | - | - |
> > | Overlapped CIDR Checks | Notifies when overlapping CIDRs are detected. |
> > | Log Service Checks | Notifies on log service issues. |
> > | Reach of Route Limit Checks | Notifies when a gateway approaches its route limit. |
> > | Blackhole Route Entry Checks | Notifies when a blackhole route entry is detected. |
> > | Edge Gateway Alerts | Notifies on Edge gateway events. |
> > | Gateway Alerts | Notifies on gateway events. |
> > | Tunnel Alerts | Notifies on tunnel events. |
> > | BGP Alerts | Notifies on BGP events. |
> > | Telemetry Alerts | Notifies on telemetry events. |
> > | Metering Alerts | Notifies on metering events. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.