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

# Alert rules

> Set up monitoring notifications for your document processing pipelines.

Alert rules let you define conditions that trigger notifications when your pipelines cross a threshold. Use them to stay informed about failure spikes, callback issues, or unexpected credit consumption.

## Creating a rule

1. Go to **Settings** → **Alert rules**
2. Click **New Alert Rule**
3. Configure the rule (see below)
4. Click **Create Alert Rule**

## Rule configuration

| Field                | Description                                                                                   |
| -------------------- | --------------------------------------------------------------------------------------------- |
| **Name**             | A descriptive name for the rule                                                               |
| **Metric**           | The metric to monitor (see [available metrics](#available-metrics))                           |
| **Operator**         | Comparison operator: **Greater Than** or **Less Than**                                        |
| **Threshold**        | The value that triggers the alert                                                             |
| **Scope**            | Optional. Limit the rule to a specific pipeline, or leave blank to apply across all pipelines |
| **Channels**         | How you want to be notified: **In-App**, **Email**, or both                                   |
| **Email recipients** | Required when Email is one of the selected channels. One or more email addresses              |
| **Enabled**          | Toggle the rule on or off                                                                     |

## Available metrics

| Metric                    | Description                                                    | Threshold range       |
| ------------------------- | -------------------------------------------------------------- | --------------------- |
| **Failure Rate**          | Proportion of runs that failed in the past hour                | 0–1 (e.g., 0.1 = 10%) |
| **Callback Failure Rate** | Proportion of callback deliveries that failed in the past hour | 0–1                   |
| **Credit Burn Rate**      | Credits consumed per day                                       | Credits/day           |
| **Credit Balance**        | Remaining credits on your organization's plan                  | Credits               |

<Tip>Rate metrics are calculated over a rolling one-hour window and expressed as a value between 0 and 1. A threshold of `0.15` means the alert fires when the rate exceeds 15%.</Tip>

<Note>**Credit Balance** is an organization-wide metric. Pair it with the **Less Than** operator to get notified when your remaining credits drop below a threshold so you can top up before runs start failing.</Note>

## Notification channels

* **In-App:** alerts appear in real time via the notification area in the app
* **Email:** alerts are sent to the specified email recipients

Select both to have a breach reach the app and the mailbox at once. Each channel delivers independently, so a mail delivery problem never suppresses the in-app notification.

## Pipeline scope

By default, a rule evaluates metrics across all pipelines. To monitor a specific pipeline, select it in the **Scope** field when creating or editing the rule. The **Credit Balance** metric is always organization-wide and cannot be scoped to a pipeline.

## Managing rules

From **Settings** → **Alert rules**, you can:

* **Edit:** update any rule configuration
* **Enable/disable:** toggle a rule without deleting it
* **Delete:** permanently remove a rule

## Real-time evaluation

Alert rules are evaluated continuously. When a threshold is crossed, the notification is delivered immediately through each configured channel.

## Permissions

Managing alert rules requires a role with **Core.AlertRule** permissions:

| Permission              | Description            |
| ----------------------- | ---------------------- |
| `Core.AlertRule.Read`   | View alert rules       |
| `Core.AlertRule.Create` | Create new alert rules |
| `Core.AlertRule.Update` | Edit alert rules       |
| `Core.AlertRule.Delete` | Delete alert rules     |