Notification Templates
Notification Templates let you customize the format and content of alerts in ADOC. With templates, you can control how notifications look, what information they include, and how they are routed, ensuring alerts are more accurate, relevant, and actionable.
Currently, Notification Templates are supported for Email and Webhook channels.
Why Use Custom Templates?
By default, ADOC uses system-defined notification formats. These may not always fit business or operational needs, which can cause:
- Generic or inconsistent alerts
- Extra manual routing and classification effort
- Delays in response or remediation
With Notification Templates, you can:
- Define your own structure and styling using Freemarker Template Language (FTL)
- Add metadata, variables, and conditions that match your use case
- Customize templates for different categories such as Policies, Pipelines, or Reliability Checks
Supported Channels
- Webhook
Creating a Notification Template
- In ADOC, navigate to Settings > Notifications > Notification Templates.
- Click Create Template.
- Enter a name and description for your template, then click Save.
You will be redirected to the Edit Notification Template page.
Customizing the Template
- From the left panel, select a Source Type (for example, Data Quality or Pipeline Monitoring).
- Choose the notification channel (Email or Webhook).
- In the Subject and Body fields, define the content using Freemarker syntax.
- Use predefined variables from the Variables tab (right panel). Examples include:
- Policy metadata: ${policy.name}, ${result.qualityScore}
- Execution status: ${execution.resultStatus}, ${execution.severity}
- Time or pipeline parameters
Example
Subject
Body (HTML)
<#if execution.resultStatus == "ERRORED" || execution.resultStatus == "SUCCESSFUL" || execution.resultStatus == "WARNING"><html> <body> <h3>Policy: ${policy.name}</h3> <p>Status: ${execution.resultStatus}</p> <p>Score: ${result.qualityScore}%</p> </body></html></#if>Preview and Test
Click Preview to see how the template will render.
Click Save to store changes.
To test, click Test, then:
- Select a notification group.
- Choose a notification category (Errored, Warning, Successful).
Send a test notification.
Additional Options
- Restore System Template: Revert to the default system template at any time.
- Manage Templates: Edit or update saved templates anytime in Notification Templates.
Best Practices for Notification Templates
1. Keep Content Clear and Actionable
- Include what happened, where, severity, and next steps.
- Avoid long or overly technical messages in the subject line.
2. Use Consistent Formatting
- Apply a standard subject line structure, e.g.:
[SEVERITY] [Category] - [Entity Name]Example:[CRITICAL] Data Quality Policy Failed - Orders Table
3. Add Context with Variables
- Always include relevant metadata (e.g.,
${policy.name},${execution.resultStatus},${result.qualityScore}). - Helps recipients act quickly without needing to log in to ADOC.
4. Handle Null or Missing Values
- Use conditional logic to avoid empty or broken messages.
- Example: only show
${result.qualityScore}if available.
5. Test Before Rolling Out
- Always send test alerts to a staging notification group.
- Validate formatting across Email and Webhook channels.
6. Balance Detail vs. Brevity
- Use the subject line for quick identification.
- Use the body for details, context, and troubleshooting info.
7. Version and Review Templates Regularly
- Keep templates updated with business changes.
- Review periodically to remove outdated fields or add new ones.