
Overview of steps
- Set up webhooks for Teams
- Update Mage project settings
Set up webhooks for Teams
Follow these instructions on Teams to setup incoming webhooks for your workspace.Update Mage project settings
Once you’ve set up webhooks for Teams, you should have a webhook URL that Teams provides. Here is an example webhook (yours may vary):- 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 existingnotification_config
section:If you omit thealert_on
section it will default totrigger_failure
andtrigger_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
-
In the
metadata.yaml
file, add the following values:Change thewebhook_url
values to be the webhook URLs you created from Teams. Thewebhook_url
must be a string if you are using version 0.9.73 or older and it only accepts one endpoint.
Customize message templates
You can customize message templates innotification_config
. Here is an example config:
success
, failure
, passed_sla
scenarios. For each message template,
you can specify either summary
or details
.
- If you specify the
summary
, the Teams message will be yoursummary
+ the url of the pipeline run page - If you specify the
details
, thedetails
will be used as your Teams message directly
{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: Forpipeline_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
Only in Mage Pro.Try our fully managed solution to access this advanced feature.
execution_time
, pipeline_uuid
, etc), you can also use the
following in your message templates in Mage Pro:
start_time
end_time
duration
(in seconds)env
(this gets the value stored in theENV
environment variable)
What next?
Whenever a pipeline run is successfully completed or fails, a Teams message will appear in the channel you configured the webhook URL for. Here is an example of what that message could look like:![]() |