Concepts and Overview
This page explains how notification templates work, the two template types available, and the structure of each template.How Notification Templates Work
When an event occurs in Collate (for example, a table is updated or a test case fails), the notification system follows this process:- Triggers an event subscription configured with a notification template.
- Renders the template with live data from the event using Handlebars syntax.
- Adapts the rendered HTML for each channel (email as HTML, Slack as formatted blocks, Teams as adaptive cards, and so on)
- Sends the notification to configured destinations.
Two Template Types
Collate provides two types of notification templates to meet different needs:System Templates
Pre-built templates provided by Collate for common notification scenarios. Characteristics:- Read-only by default (cannot be deleted).
- Can be modified to customize appearance.
- Auto-update if you haven’t customized them.
- Only users with “Edit All” permission can create system templates.
User Templates
Custom templates you create for specific business needs:- Fully editable and deletable.
- Custom formatting for domain-specific events.
- Reusable across multiple event subscriptions.
- Require “Edit All” or “Edit User Notification Template” permission.
Template Structure
Each template contains two essential parts:Template Subject (templateSubject)
The email subject line or notification title that appears at the top of messages.
Constraints:
- Maximum 256 characters.
- Supports Handlebars templating for dynamic content.
[Data Alerts] - Table Updated: database.schema.customer_data
Note: Keep the subject line concise (under 100 characters) as it appears in email clients and chat apps where space is limited.
Template Body (templateBody)
HTML content with Handlebars placeholders that forms the main notification message.
Constraints:
- Maximum 10,240 characters.
- Supports HTML formatting and Handlebars templating.
- Automatically adapted by Collate for each channel.
- Email: Renders as formatted HTML with links.
- Slack: Converts to Slack block format with proper formatting.
- Teams: Converts to Adaptive Cards format.
- Google Chat: Converts to Google Chat message format.
- Webhooks: Sends the raw template data.
Next Steps
- New to templates? → Start with Create and Manage Templates
- Want to write templates? → Learn Handlebars Templating Guide