> For the complete documentation index, see [llms.txt](https://docs.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.collibra.com/data-quality-self-hosted/core-concepts/alerts/working-with-the-alert-builder/adding-dataset-alerts.md).

# Adding dataset alerts

This topic shows you how to configure dataset alerts. You can set alerts to send via email or to a webhook.

## Steps

{% stepper %}
{% step %}
Sign in to Data Quality & Observability (self-hosted).
{% endstep %}

{% step %}
On the left sidebar navigation, click <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-149f6488de35c8c3b2e950d06d652e404fc8c36d%2Fdq-alerts-icon.png?alt=media" alt="Alerts icon" data-size="line"> **Alerts**, then select **Alert Builder**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The Alert Builder page opens.
{% endstep %}

{% step %}
Search for your dataset, or select one from either the **App Frequent Runs:** section below the search bar or from the **App Recent Runs** list.\ <i class="fa-chevrons-right">:chevrons-right:</i> The dataset you selected displays. You can now view, create, and edit alerts for this dataset.
{% endstep %}

{% step %}
In the upper right corner, click **Add Alert +**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The Add Alert dialogue appears.
{% endstep %}

{% step %}
From the Add Alert dialogue, select an option and then click **Next**.\ <i class="fa-chevrons-right">:chevrons-right:</i> Depending on the option you select, the Condition Alert, Job Status Alert, or Rule Status Alert modal appears.
{% endstep %}

{% step %}
Enter the required information for the option you select.

{% tabs %}
{% tab title="Condition Alert" %}
A condition alert generates an alert when the user-defined condition is satisfied during a dataset run.

<table><thead><tr><th width="152">Option</th><th>Description</th></tr></thead><tbody><tr><td>Alert Name</td><td>The name of the alert for the selected dataset.</td></tr><tr><td>Dataset</td><td>The name of the dataset. This field cannot be edited.</td></tr><tr><td>Condition</td><td><p>The <a href="/data-quality-self-hosted/core-concepts/alerts/working-with-the-alert-builder/adding-dataset-alerts/using-conditions-for-alerts.md">user-defined condition</a> that triggers an alert to send when its criteria are met during a dataset run. You can specify conditions such as:</p><ul><li>score &#x3C; 75</li><li>daysWithoutData > 1</li><li>rc = 0</li></ul></td></tr><tr><td>Add Rule Details</td><td><p>Enter the name of your rule in the Condition field to include the following details of your rule in the email:</p><ul><li>Rule name</li><li>Rule condition</li><li>Total number of points to deduct from the quality score when breaking</li><li>Percentage of records that are breaking</li><li>Number of breaking records</li><li>Assignment Status</li></ul><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Add Rule Details is unavailable by default. When you enter the name of a rule in the Condition field, this option becomes available.</p></div><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Alerts with rules are triggered based on the <a href="/data-quality-self-hosted/core-concepts/findings/data-quality-monitors/rules.md">percentage of breaking records</a> calculated by each data quality rule. These percentages are then evaluated against the alert's combined condition, such as comparing 100% to the rule requirements.</p></div></td></tr><tr><td colspan="2">Alert delivery method</td></tr><tr><td>Email</td><td><p>Select this option to use email for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have SMTP configured to use this option. For more information on how to set up SMTP, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-configuration.md">Alert Configuration</a>.</p></div></td></tr><tr><td>Email Batch Trigger</td><td>Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically.</td></tr><tr><td>Batch Name</td><td><p>Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This option is only available when the Batch option is enabled.</p></div></td></tr><tr><td>Alert Recipient</td><td><p>The email address where alerts will send. You can specify either a single recipient or multiple.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters.</p></div><p>The accepted formats for email are "<a href="mailto:name@email.com">name@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">,name2@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">;name2@email.com</a>".</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>When the batch option is enabled, the Alert Recipient field locks automatically. You can click the <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-b6917d333c59fbeea5b780be15ed2e10cf2b756f%2Flock-large%402x.png?alt=media" alt="" data-size="line"> to the right of the Alert Recipient field to unlock it and edit the alert recipients.</p></div></td></tr><tr><td>Webhook</td><td><p>Select this option to use a webhook for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have a webhook configured to use this option. For more information on how to set up webhooks, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-webhook-configuration.md">Alert Webhook Configuration</a>.</p></div></td></tr><tr><td>Webhook</td><td>Select a webhook from the drop-down list where the JSON payload containing your alert details will be sent.</td></tr><tr><td>Custom Msg</td><td>A custom message relevant to the alert.</td></tr></tbody></table>
{% endtab %}

{% tab title="Job Status Alert" %}
A job status alert generates an alert when a job run completes.

<table><thead><tr><th width="152">Option</th><th>Description</th></tr></thead><tbody><tr><td>Alert Name</td><td>The name of the alert for the selected dataset.</td></tr><tr><td>Dataset</td><td>The name of the dataset. This field cannot be edited.</td></tr><tr><td>Job Alert Status</td><td><p><strong>Job Completion</strong></p><ul><li>Select this option to generate an alert when a job run completes for the selected dataset.</li></ul><p><strong>Job Failure</strong></p><ul><li>Select this option to generate an alert when a job run fails.</li></ul></td></tr><tr><td colspan="2">Alert delivery method</td></tr><tr><td>Email</td><td><p>Select this option to use email for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have SMTP configured to use this option. For more information on how to set up SMTP, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-configuration.md">Alert Configuration</a>.</p></div></td></tr><tr><td>Email Batch Trigger</td><td>Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically.</td></tr><tr><td>Batch Name</td><td><p>Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This option is only available when the Batch option is enabled.</p></div></td></tr><tr><td>Alert Recipient</td><td><p>The email address where alerts will send. You can specify either a single recipient or multiple.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters.</p></div><p>The accepted formats for email are "<a href="mailto:name@email.com">name@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">,name2@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">;name2@email.com</a>".</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>When the batch option is enabled, the Alert Recipient field locks automatically. You can click the <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-b6917d333c59fbeea5b780be15ed2e10cf2b756f%2Flock-large%402x.png?alt=media" alt="" data-size="line"> to the right of the Alert Recipient field to unlock it and edit the alert recipients.</p></div></td></tr><tr><td>Webhook</td><td><p>Select this option to use a webhook for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have a webhook configured to use this option. For more information on how to set up webhooks, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-webhook-configuration.md">Alert Webhook Configuration</a>.</p></div></td></tr><tr><td>Webhook</td><td>Select a webhook from the drop-down list where the JSON payload containing your alert details will be sent.</td></tr><tr><td>Custom Msg</td><td>A custom message relevant to the alert.</td></tr></tbody></table>
{% endtab %}

{% tab title="Rule Status Alert" %}
A rule status alert generates an alert when a rule is breaking, passing, and/or has an exception.

<table><thead><tr><th width="152">Option</th><th>Description</th></tr></thead><tbody><tr><td>Alert Name</td><td><p>The name of the alert for the selected dataset.</p><div data-gb-custom-block data-tag="hint" data-style="warning" class="hint hint-warning"><p>If the name of your alert already exists, the new alert will replace the existing one.</p></div></td></tr><tr><td>Dataset</td><td>The name of the dataset. This field cannot be edited.</td></tr><tr><td>Rule Status Triggers</td><td><p>You can select one or more of the following options:</p><p><strong>Breaking</strong></p><ul><li>Select this option to generate an alert when a rule is breaking.</li></ul><p><strong>Exception</strong></p><ul><li>Select this option to generate an alert when a rule is throwing an exception.</li></ul><p><strong>Passing</strong></p><ul><li>Select this option to generate an alert when a rule is passing.</li></ul></td></tr><tr><td colspan="2">Alert delivery method</td></tr><tr><td>Email</td><td><p>Select this option to use email for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have SMTP configured to use this option. For more information on how to set up SMTP, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-configuration.md">Alert Configuration</a>.</p></div></td></tr><tr><td>Email Batch Trigger</td><td>Select the checkbox option to create a batch alert to multiple recipients. When this option is enabled, the Batch Name field appears and the Alert Recipient field locks automatically.</td></tr><tr><td>Batch Name</td><td><p>Enter a batch name to send the alert to multiple recipients. To search for an existing batch name, enter its characters into the Batch Name field to populate a dropdown list containing all available matches.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This option is only available when the Batch option is enabled.</p></div></td></tr><tr><td>Alert Recipient</td><td><p>The email address where alerts will send. You can specify either a single recipient or multiple.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When you specify multiple email addresses, ensure that you also fill out the Batch Name field. Multiple recipients are specified by comma (,) and/or semicolon (;) delimiters.</p></div><p>The accepted formats for email are "<a href="mailto:name@email.com">name@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">,name2@email.com</a>" OR "<a href="mailto:name1@email.com">name1@email.com</a><a href="mailto:,name2@email.com">;name2@email.com</a>".</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>When the batch option is enabled, the Alert Recipient field locks automatically. You can click the <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-b6917d333c59fbeea5b780be15ed2e10cf2b756f%2Flock-large%402x.png?alt=media" alt="" data-size="line"> to the right of the Alert Recipient field to unlock it and edit the alert recipients.</p></div></td></tr><tr><td>Webhook</td><td><p>Select this option to use a webhook for alerting.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You must have a webhook configured to use this option. For more information on how to set up webhooks, go to <a href="/data-quality-self-hosted/admin-configuration/admin-console/alerts/alert-webhook-configuration.md">Alert Webhook Configuration</a>.</p></div></td></tr><tr><td>Webhook</td><td>Select a webhook from the drop-down list where the JSON payload containing your alert details will be sent.</td></tr><tr><td>Custom Msg</td><td>A custom message relevant to the alert.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
Click **Save**.
{% endstep %}
{% endstepper %}
