Communication Templates

Overview

Communication templates in cidaas provide pre-structured frameworks for delivering consistent messages to users across email, SMS, IVR, and push notifications. Templates enable you to maintain brand voice and styling while automating user communications such as welcome messages, password resets, account verifications, and security alerts.

The template system includes group-specific settings for locale and language preferences, ensuring effective localized communication. You can configure communication providers within each template group to ensure seamless messaging delivery through appropriate platforms.

Key Benefits

• Efficiency: Pre-defined templates eliminate the need to create messages from scratch for each communication
• Brand Consistency: Ensures all communications align with your brand voice, tone, and style across teams and channels
• Clear Structure: Provides logical frameworks that make messages easier to read and understand
• Scalability: Useful for large teams to maintain alignment in messaging tone and content
• Customization: Templates support dynamic elements for audience-specific messaging while retaining consistent structure
• Multi-channel Support: Easily adapted for multiple communication channels including email, SMS, IVR, and push notifications

Template Architecture

cidaas organizes communication templates into template groups. Each template group contains multiple templates, and each template is classified by a template type. The following diagram illustrates this structure:

Built-in Template Groups

cidaas provides two built-in template groups:

• default: Contains pre-configured communication templates for common use cases
• developer: An empty template group for custom, non-cidaas-based communications

Developer templates

Use the developer template group for custom template types—messages that are not in cidaas’s fixed system template catalog. You identify each template by templateKey, locale, and communication method, same as other templates.

System templates vs developer templates

	cidaas system templates	Developer templates
Template keys	Fixed catalog (for example WELCOME_USER, VERIFY_USER)	Keys from your custom template types
Typical trigger	cidaas services (registration, verification, …)	Your application calls the API when you choose
Template group	Usually default or a group copied from it	Built-in group developer (groupId: developer)

Quick reference

Topic	What to use
Group	developer
Send API	Send Template-Based Notifications
Criteria (identify template)	templateKey, groupId (developer), commMethod, locale (as needed)
Payload (rendering)	Merge system, custom, and context attributes into subject/body placeholders

How content is built

Approach	What you do
Placeholders in the template	Define subject/body in Admin or API with double braces for normal substitution (for example {{given_name}}, {{orderId}}). At send time, pass attribute values in the request; they are merged and substituted.
Full HTML from the payload	Use triple braces so the value is inserted as raw HTML: for example {{{emailHtml}}}. Pass the entire HTML string as that attribute—useful when markup is generated outside the template.

Setup (summary):

• Create a custom template type, then templates under the developer group (Template > Template, filter by developer). Configure providers for that group like any other group.
• Step-by-step: How to Create Custom Template Types (including the developer group filter in Step 2).

Application-triggered notification flow

Your application calls the notification service directly (not via a cidaas domain service for lifecycle events). The service loads the template, renders it with your attributes, and delivers through the communication provider for that group and channel.

Customizing Communication Templates

The default template group can be customized to match your brand requirements in terms of appearance and content. You can also create custom template groups by copying the default group and customizing sender names, communication providers, layouts, and content.

Best Practices

1. Customize the default template group to follow your corporate style guidelines
2. Create separate template groups for brand-specific layouts and messaging requirements

Template Selection Criteria

The template selection process depends on several factors:

1. Available Communication Channels: Which channels are available for reaching the user (email address, phone number, or cidaas Authenticator App)?
2. Communication Purpose:
   • User verification requires secure communication channels (linked to verification procedures in cidaas)
   • Some notifications can be deactivated based on template-specific settings
   • Settings should be applied uniformly across all locales and template groups
3. Client Configuration: Template groups are assigned to applications, allowing different clients to use different communication templates

Default Template Types

cidaas provides the following template types in German (de) and English (en) by default:

Template Key	Description	Deactivatable	Communication Methods
AFTER_ACTIVATE_USER	Informs users after their account has been activated	Yes	email, sms, ivr
AFTER_CHANGE_PASSWORD	Notifies users after their password has been changed	Yes	email, sms, ivr
AFTER_DE_ACTIVATE_USER	Informs users after their account has been deactivated	Yes	email, sms, ivr, push
INVITE_USER	Invites users to complete the sign-up process	No	email, sms, ivr, push
NEW_DEVICE	Alerts users when a new device is detected during login or other actions	Yes	email, sms, ivr, push
NEW_LOCATION	Alerts users when a new location is detected during login or other actions	Yes	email, sms, ivr, push
NOTIFY_COMMUNICATION_CHANGE	Notifies users when they change their communication medium (phone number or email)	Yes	email, sms, ivr, push
OPTIN_REMINDER	Reminds users to opt in to the system	Yes	email, sms
PASSWORD_RESET_BY_ADMIN	Informs users that their password has been reset by an administrator	Yes	email, sms, ivr, push
RESET_PASSWORD	Prompts users to proceed with their requested password reset	No	email, sms
UN_REGISTER_USER_ALERT	Sends an alert when a user unregisters	Yes	email, sms, push
USER_CREATED	Notifies relevant parties when a user account has been created	Yes	email, sms, ivr, push
USER_CREATED_VERIFY	Requests newly created users to verify their email address	Yes	email, sms
USER_MERGE_IDENTITY_ALERT	Alerts users when their account has been merged with another account	Yes	email, sms, push
USER_MERGE_VERIFY_IDENTITY	Requests users to verify and confirm account merge requests	Yes	email, sms, push
VERIFY_ACCOUNT	Prompts users to verify their account	No	email, sms
VERIFY_USER	Initiates user verification processes	No	email, sms, ivr, push
WEBHOOK_FAILED	Notifies administrators about failed webhooks	Yes	email, sms
WELCOME_USER	Welcomes users after successful sign-up and provides next steps	Yes	email, sms, ivr

How to Create Custom Template Types

You can create custom communication template types tailored to your specific requirements.

Step 1: Create Template Type

1. Log in to the cidaas Admin Dashboard
2. Navigate to Template > Template Types
3. Click Create Custom Types
4. Enter the following information:
   • Template Type: Descriptive name for filtering and search operations
   • Description: Supporting description for the template type
   • Communication Methods: Select applicable communication channels (email, SMS, IVR, push)
   • Custom Attributes: Define allowed and required attributes for your template
5. Click Create

The new template type appears in the custom template section. You can update system and custom templates by clicking on them.

Note

You can add custom fields in the registration field section to support your template attributes.

Step 2: Create and Publish Custom Template

1. Log in to the cidaas Admin Dashboard

2. Navigate to Template > Template

3. Select developer from the group type dropdown filter

4. Click the More option in the filtered list

   

5. Click Create Template

6. Search for your template type and enter required details

   

7. Click the template to edit according to your requirements

8. Click Publish

Additional Configuration Options

Locale Settings: Update the locale for the template group to support multiple languages.

Communication Provider: Configure the communication provider for the template group.

Use the Template Keys, Communication Method, and Locale filters to locate specific templates quickly.

How to Create Custom Template Groups

1. Log in to the cidaas Admin Dashboard
2. Navigate to Template > Template
3. Click Create Group Types
4. Enter the following information:
   • Template Group Name: Descriptive name for the group
   • Description: Supporting description for the group
   • Copy from Group: Select the template group to copy from (defaults to default)
   • Language: Choose supported languages for the template group
   • Default Locale: Select the default locale
5. Click Create

Developer Reference

The following APIs enable programmatic management of communication templates:

API	Description	Reference
Manage Template Groups by ID	Get, update, or delete template groups using their ID	View API
Create Template Groups	Create new template groups	View API
Find Template Groups Using Filters	Retrieve template groups using filter criteria	View API
Find Templates Using Filters	Retrieve templates using filter criteria	View API
Manage Templates	Create, update, or delete templates	View API
Manage Templates by ID	Get, update, or delete templates using their ID	View API
Manage Template Types Using Filters	Manage template types in a graph-based structure	View API
Send Template-Based Notifications	Send notifications based on templates	View API
Create Template Types	Create new template types with custom attributes	View API
Get Notification Status	Retrieve service setup and status information for notification vendors	View API
Manage Template Type Attributes	Create or update attributes for a communication template type	View API
Get Template Filters by Group	Retrieve template filters associated with a specific template group	View API

Support

Need Help?

For any further assistance, feel free to visit our Support Portal.