> ## Documentation Index
> Fetch the complete documentation index at: https://mage-staging.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Alerting status updates in Slack

> Get status updates in your Slack channel.

<Frame>
  <img alt="Slack" src="https://d34u8crftukxnk.cloudfront.net/slackpress/prod/sites/6/2019-01_BrandRefresh_Old-to-New-Final.gif" width="300" />
</Frame>

## Overview of steps

1. Set up webhooks for Slack
2. Update Mage project settings

## Set up webhooks for Slack

Follow these
[instructions on Slack](https://api.slack.com/messaging/webhooks)
to setup incoming webhooks for your workspace.

## Update Mage project settings

Once you’ve set up webhooks for Slack, you should have a webhook URL that Slack
provides.

Here is an example webhook (yours may vary):

```
https://hooks.slack.com/services/T01XXXXRKMJ/B04XXXXGY67/1UgUkao8pXXXXPmsuXXXX2lk
```

Follow these steps to add that webhook URL to your project settings:

1. Open the Mage tool in your browser (e.g. [http://localhost:6789/](http://localhost:6789/)).

2. Open a pipeline and start editing it (e.g.
   [http://localhost:6789/pipelines/example\_pipeline/edit](http://localhost:6789/pipelines/example_pipeline/edit)).

3. In your left sidebar in the file browser, scroll all the way down and click
   on a file named `metadata.yaml`.

4. In the `metadata.yaml` file, add a section with the following
   configuration or update the existing `notification_config` section:

   ```yaml theme={null}
   notification_config:
     alert_on:
       - trigger_failure
       - trigger_passed_sla
   ```

   If you omit the `alert_on` section it will default to `trigger_failure` and `trigger_passed_sla`.

   Options:

   * `trigger_failure`: alert when a run of a trigger fails
   * `trigger_success`: alert when a run of a trigger succeeds
   * `trigger_passed_sla`: alert when a SLA is missed.
     * In this context, SLA (Service Level Agreement) is an expected amount of time for the pipeline to complete.
     * If the pipeline runs *longer* than the SLA, an alert will be sent.

5. In the `metadata.yaml` file, add the following values:

   ```yaml theme={null}
   notification_config:
     alert_on:
       ...
     slack_config:
       webhook_url: ...
   ```

   Change the `webhook_url` value to be the webhook URL you created from Slack.

## Customize message templates

You can customize message templates in `notification_config`. Here is an example config:

```yaml theme={null}
notification_config:
  alert_on:
    ...
  slack_config:
    ...
  message_templates:
    failure:
      details: >
        Failed to execute pipeline {pipeline_run_url}.
        Pipeline uuid: {pipeline_uuid}. Trigger name: {pipeline_schedule_name}.
        Test custom message."
    success:
      details: ...
    passed_sla:
      details: ...
```

You can customize the message template for `success`, `failure`, `passed_sla` scenarios. For each message template,
you can specify either `summary` or `details`.

* If you specify the `summary`, the slack message will be your `summary` + the url of the pipeline run page
* If you specify the `details`, the `details` will be used as your slack message directly

To interpolate variables in the messaget template, you can use `{variable_name}` syntax.
Hare are the supported variables: `error`, `execution_time`, `pipeline_run_url`, `pipeline_schedule_id`,
`pipeline_schedule_name`, `pipeline_uuid`.

For `pipeline_run_url`, the default host is `http://localhost:6789`. You can specify `MAGE_PUBLIC_HOST` to be
the host url you want to use in the notification messages.

## What next?

Whenever a pipeline run is successfully completed or fails, a Slack message will
appear in the channel you configured the webhook URL for.

Here is an example of what that message could look like:

<Frame>
  <img alt="Slack" src="https://github.com/mage-ai/assets/blob/main/third-party/slack-message-run-alert.jpg?raw=true" />
</Frame>