Documentation Index
Fetch the complete documentation index at: https://docs.maia.ai/llms.txt
Use this file to discover all available pages before exploring further.
This guide explains how registered users can configure pipeline notifications to receive alerts when pipeline runs fail. Pipeline notifications allow you to subscribe to alerts for pipeline failures within the projects and environments you have access to. These alerts help you respond quickly to issues, minimizing downtime, and improve overall reliability.
Notifications can be delivered via:
Use cases
- Environment-specific routing: Send development failures to a sandbox channel and production alerts to your high-priority alerts channel.
- Noise reduction: Rather than building alerts into every pipeline, simply subscribe to a project or environment once.
Prerequisites
Before setting up pipeline notifications, ensure the following:
- You have a registered account.
- You have access to the relevant projects and environments where the data pipelines are running.
- If you plan to use Slack notifications, you have access to a Slack workspace and a configured Slack webhook URL.
Pipeline notification behavior
- Eligibility: Any user with access to a project or environment can subscribe to pipeline notifications.
- Notification triggers: You can choose to receive notifications for pipeline Run failure.
- Scope: Notifications are sent for pipelines triggered by schedules or API-executed pipelines.
Pipelines that are run manually through don’t generate notifications.
Subscribe to pipeline notifications
Select a delivery method to set up notifications:
When you select Email as the delivery method for a pipeline notification, alerts are sent to the email address associated with your account.No additional setup is required. Once you select Email, alerts are delivered automatically when your chosen trigger conditions are met.
-
In the left navigation, click your Profile & Account icon. Then, select Notifications from the menu.
-
Click Add notification at the top.
-
In the Add notification dialog, select the Project and Environment you’d like to be notified about.
-
Under When should this notification be sent?, select Run failure.
The Run failure checkbox is selected by default. It applies only to scheduled and API-triggered runs. Manual runs do not trigger alerts.
-
Under How do you want to receive this notification?, select Email.
-
Click Add.
What the notification includes
Each notification includes the following details about the pipeline run:
- Project name
- Environment name
- Pipeline name
- Time of failure
It also includes links to the Pipeline run history and the Notifications page for further investigation. When you select Slack as the delivery method for a pipeline notification, alerts are sent to a Slack channel of your choice via an incoming webhook URL.Prerequisites
Before setting up Slack notifications, you must create a Slack app and generate an incoming webhook URL in your Slack workspace. For step-by-step instructions, see Sending messages using incoming webhooks.Setup
When configuring a pipeline notification with Slack as the delivery method, provide the following:
- Slack Webhook URL — the incoming webhook URL generated in your Slack workspace.
- Slack Webhook Name — a label to help you identify this webhook later.
-
In the left navigation, click your Profile & Account icon. Then, select Notifications from the menu.
-
Click Add notification at the top.
-
In the Add notification dialog, select the Project and Environment you’d like to be notified about.
-
Under When should this notification be sent?, select Run failure.
The Run failure checkbox is selected by default. It applies only to scheduled and API-triggered runs. Manual runs do not trigger alerts.
-
Under How do you want to receive this notification?, select Slack.
-
Enter the Slack Webhook URL generated in your Slack workspace.
-
Enter a Slack Webhook Name to help you identify the webhook later.
-
Click Add.
What the notification includes
Each notification includes the following details about the pipeline run:
- Project name
- Environment name
- Pipeline name
- Time of failure
It also includes links to the Pipeline run history and the Notifications page for further investigation. When you select Webhook as the delivery method for a pipeline notification, alerts are sent as HTTP POST requests to an endpoint of your choice. You can also supply a custom JSON payload template to control exactly what data is sent.Setup
When configuring a pipeline notification with Webhook as the delivery method, provide the following:
- Webhook URL — the endpoint that receives the notification.
- Webhook Name — a label to identify this webhook later.
- Payload — a custom JSON template using
${variableName} syntax to control the notification body. Click View available variables to see the full list of supported variables.
-
In the left navigation, click your Profile & Account icon. Then, select Notifications from the menu.
-
Click Add notification at the top.
-
In the Add notification dialog, select the Project and Environment you’d like to be notified about.
-
Under When should this notification be sent?, select Run failure.
The Run failure checkbox is selected by default. It applies only to scheduled and API-triggered runs. Manual runs do not trigger alerts.
-
Under How do you want to receive this notification?, select Webhook.
-
Enter the Webhook URL (Required) — the endpoint that receives the notification.
-
Enter a Webhook Name (Required) to identify this webhook later.
-
Enter a Payload (Required) — a JSON template using
${variableName} syntax to customize the notification body. Click View available variables to see the full list of supported variables.
-
Click Add.
What the notification includes
Each notification includes the following details about the pipeline run:
- Project name
- Environment name
- Pipeline name
- Time of failure
It also includes links to the Pipeline run history and the Notifications page for further investigation.
Available variables
The following variables are available for use in the payload template. Select the ones that best fit your needs.| Variable | Description |
|---|
${pipelineName} | Pipeline name |
${status} | Execution status |
${finishedAt} | Completion timestamp |
${pipelineExecutionId} | Execution ID |
${projectId} | Project ID |
${accountId} | Account ID |
Example payload
The following example uses all available variables in a realistic payload structure:{
"text": "Pipeline ${pipelineName} finished with status ${status}",
"pipeline": {
"name": "${pipelineName}",
"status": "${status}",
"executionId": "${pipelineExecutionId}",
"finishedAt": "${finishedAt}"
},
"context": {
"projectId": "${projectId}",
"accountId": "${accountId}"
}
}
Managing pipeline notifications
After creating a notification, you’ll return to the Notifications page, where your pipeline notification has been added, displaying the following:
- Project name
- Environment name
- Trigger status (always Failure)
- Delivery method (the delivery method or methods you selected)
You can select more than one delivery method for a single notification.
If you change your mind, you can cancel the deletion action by clicking Cancel in the confirmation dialog.
