Get real-time status updates from Mage pipelines directly in your Slack channels.
To send notifications to Slack, you need to configure an incoming webhook:
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):
Follow these steps to add that webhook URL to your project settings:
Open the Mage tool in your browser (e.g. http://localhost:6789/).
Open a pipeline and start editing it (e.g. http://localhost:6789/pipelines/example_pipeline/edit).
In your left sidebar in the file browser, scroll all the way down and click
on a file named metadata.yaml
.
In the metadata.yaml
file, add a section with the following
configuration or update the existing notification_config
section:
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 failstrigger_success
: alert when a run of a trigger succeedstrigger_passed_sla
: alert when a SLA is missed.
In the metadata.yaml
file, add the following values:
Change the webhook_url
value to be the webhook URL you created from Slack.
You can customize message templates in notification_config
. Here is an example config:
You can customize the message template for success
, failure
, passed_sla
scenarios. For each message template,
you can specify either summary
or details
.
summary
, the slack message will be your summary
+ the url of the pipeline run pagedetails
, the details
will be used as your slack message directlyTo interpolate variables in the message template, you can use {variable_name}
syntax.
Here are the supported variables:
execution_time
pipeline_run_url
pipeline_schedule_id
pipeline_schedule_name
pipeline_schedule_description
pipeline_uuid
error
failure
message templatestacktrace
failure
message templateNote: For
pipeline_run_url
, the default host ishttp://localhost:6789
. You can specifyMAGE_PUBLIC_HOST
to be the host url you want to use in the notification messages.
Try our fully managed solution to access this advanced feature.
If you’re using Mage Pro, you can interpolate environment variables and other Mage variables directly in your Slack message templates using the familiar Jinja-like syntax:
This makes your Slack notifications more dynamic and context-aware — ideal for multi-environment deployments and advanced workflows.
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: