​

Create and Manage Templates

​

Creating a Custom Template

1. Click the Profile icon and navigate to Settings > Notifications > Templates.
2. Click Add Template.
3. Enter the required details. See Template Details.
4. Click Save.

1. Navigate to Settings > Notifications > Alerts.
2. Click Add Alert.
3. In the Notification Template dropdown field, select Create Custom Template and enter the required details. See Template Details.
4. Click Save.

​

Template Details

​

Template Name

• Use a clear, descriptive name that indicates the template’s purpose.
• Examples: Data Quality Alert, Incident Notification, Weekly Report

​

Template Subject

• {{eventType}} — The type of event that triggered the notification.
• {{entityType}} — The type of entity involved (Table, Pipeline, Dashboard, and so on)
• {{entityName}} — The name of the affected entity.
• {{entityUrl}} — Direct link to the entity.
• {{timestamp}} — When the event occurred.

[{{eventType}}] {{entityType}}: {{entityName}}

​

Template Body

{{#if description}}
Description: {{description}}
{{/if}}

{{#each changes}}
- {{this.fieldName}}: {{this.oldValue}} → {{this.newValue}}
{{/each}}

​

Best Practices

• Keep templates concise and actionable.
• Include relevant links for quick access to affected entities.
• Use conditional blocks for optional information.
• Select Validate before saving to check Handlebars syntax.

​

Modifying Templates

​

Editing User Templates

1. Navigate to Settings > Notifications > Templates.
2. Find the template in the list.
3. Click the Edit button.
4. Modify any fields (Name, Display Name, Description, Subject, Body).
5. Click Save.

​

Editing System Templates

• You can modify: Subject and Body.
• You cannot modify: Name and Display Name.
• System templates track if you’ve customized them.

​

Linking Templates to Event Subscriptions

​

Step 1: Navigate to Subscriptions

1. Go to Settings > Notifications > Subscriptions.
2. Create a new subscription or edit an existing one.

​

Step 2: Select a Template

1. In the subscription form, find the Notification Template dropdown.
2. Choose from:
   • System Templates - Pre-built templates for common entity types.
   • User Templates - Custom templates you’ve created.
   • (blank) - Use default formatting per channel.

​

Step 3: Configure Other Settings

• Event Type - Which changes trigger the notification.
• Destinations - Where to send notifications (email, Slack, Teams, etc.)
• Filters - Optional conditions for when to send.

​

Step 4: Save the Subscription

​

Template Preview and Testing

​

Previewing Templates

1. In the template editor, click Preview.
2. The system renders the template with sample data.
3. Review the formatted output.
4. See how it appears across different channels.
5. Make adjustments if needed.

​

Sending Test Notifications

1. In the template editor, click Send Test.
2. Select destinations where you want to send the test:
   • Email addresses.
   • Slack channels.
   • Teams channels.
   • Google Chat spaces.
3. Click Send.
4. The system sends a real notification with mock event data.
5. Check your destinations to verify formatting and content.

• Verify links and dynamic content render correctly.
• Check channel-specific formatting.
• Test with your actual notification destinations.

​

Modifying vs. Duplicating Templates

​

When to Modify

• Impact: All active subscriptions using this template immediately get new formatting.
• Use when: Improving a template everyone already uses.

​

When to Duplicate

• You want a variation for a specific use case.
• You want to test changes before affecting production subscriptions.
• Different teams need different formatting.

1. Copy the template content.
2. Create a new template.
3. Paste the content as a starting point.
4. Modify as needed.

​

Deleting Templates

​

Delete User Templates

1. Go to Settings > Notifications > Templates.
2. Find your template.
3. Click the Delete button.
4. Confirm the deletion.

​

System Templates

​

Troubleshooting Template Issues

​

Template Won’t Save

• Body exceeds 10,240 characters - simplify the content.
• Subject exceeds 256 characters - shorten the subject.
• Invalid Handlebars syntax - check brackets are balanced.
• Required fields are empty - fill in Name, Display Name, Subject, and Body.

​

Notifications Not Using Template

1. Is the template selected in the subscription settings?
2. Is the subscription active?
3. For system templates, do the subscription’s event type and entity type match your template name?

​

Template Shows Wrong Data

1. Are you using the correct property names? See Template Context Reference
2. Is the data available for this entity type?
3. Are you using conditionals for optional fields?

​

Next Steps

• Learn about available data → Template Context Reference
• Master Handlebars → Handlebars Templating Guide
• Get help with issues → Troubleshooting Guide