Alerting status updates in Email
Get status updates sent to your email inbox.
Create notification_config
In the root of your project’s folder (e.g. default_repo/
), open the file
metadata.yaml
.
Project folder name
If you initialized Mage using a different project name, then your root folder will be named differently.
default_repo
is the default project name if you didn’t customize it.
In the default_repo/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 run of a trigger passes sla
Configure email settings
In the default_repo/metadata.yaml
file, add a section with the following
configuration or update the existing notification_config
section:
Change the values for each key under the email_config
section.
Customize message templates
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 title
and either summary
or details
.
title
is used in email subject- If you specify the
summary
, the email body will be yoursummary
+ the url of the pipeline run page - If you specify the
details
, thedetails
will be used as your email body
To 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
- available only for the
failure
message template
- available only for the
stacktrace
- available only for the
failure
message template
- available only for the
Note: 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.
🚀 Pro Only: Interpolate Mage Variables in Message Templates
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 Email message templates using the familiar Jinja-like syntax:
This makes your Email notifications more dynamic and context-aware — ideal for multi-environment deployments and advanced workflows.
What next?
Whenever a pipeline run is successfully completed or fails, an email will be
delivered to all the inboxes listed under to_emails
.
Here is an example of what an email could look like:
Successfully ran Pipeline example_pipeline with Trigger 79 hourly_trigger at execution time 2022-09-28 19:00:00 .Open http://localhost:6789/pipelines/example_pipeline/triggers/79 to check pipeline run results and logs. |