Skip to main content

Configuring a template

To configure a notification template, first, you need to select some information stored in the Body:
  1. Type - could be either MAIL or SMS notifications
  2. Email Server - select the email delivery method (available for MAIL type):
    • Predefined Email Connection (default) - send emails directly through a configured SMTP server using the Send Notification action
    • Forward on Kafka - forward the notification to Kafka for the Notifications Plugin or an external adapter to handle (this is mandatory for SMS notification templates)
  3. Email Sender - displayed only when Email Server is set to Predefined Email Connection:
    • Default Server (default) - uses the default SMTP connection configured at the environment level
    • Or select a specific Email Sender data source configured in Integration Designer
  4. Language - choose the language for your notification template
  5. Subject - enter a subject
You can edit the content for each language you have defined in the project.
Notification template

Editing the content

You can edit the content of a notification template by using the WYSIWYG editor embedded in the body of the notification templates body.

Configuring the data model

SaaS ยท
Available on SaaS with FlowX.AI . This feature is live on managed (SaaS) deployments now. Self-hosted deployments will receive it with the next LTS release family.
In the upcoming structured data model, the notification template editor has two tabs. On the Data Model tab you build typed data types and attributes with the same builder used across FlowX, then use the Input Parameters tab to choose which attributes the template expects at send time. On the Data Model tab you can:
  • Add typed attributes. Supported types are String, Number, Boolean, Enum, Date, Currency, New Data type (a nested object you define inline), Existing Data Type (an object you reference), and Array.
  • Add validations to an attribute (for example min, max, length, or pattern).
  • Mark an attribute as Sensitive data or Use in Reporting.
  • Reference data types from the Project Data Model or from a Library, instead of redefining them.
On the Input Parameters tab, select the Data Model attributes the template needs. These become the values you supply when the template is filled. The tab lists only attributes you have defined on the Data Model.
For the full data model builder reference (data types, attribute paths, referenced types, validations, and reporting or sensitive-data settings), see the Project data model documentation.
Using the Data model tab, you can define key pair values (parameters) that will be displayed and reused in the editor. Multiple parameters can be added:
  • STRING
  • NUMBER
  • BOOLEAN
  • OBJECT
  • OBJECT_REF
  • ARRAY
  • ARRAY_REF
  • ENUM
Data model
After you defined some parameters in the Data Model tab, you can type โ€#โ€ in the editor to trigger a dropdown where you can choose which one you want to use/reuse.
Data model

WYSIWYG Editor

Testing the template

You can use the test function to ensure that your template configuration is working as it should before publishing it.
The test modal includes the following fields:
  • Receivers emails โ€” recipient email addresses for the test
  • Language โ€” select the template language to test
  • Attachments โ€” upload files to test attachment handling
  • Template data โ€” provide values for template variables
  • Advanced (hidden section) โ€” Sender Name and Sender Email overrides
If some keys (marked as mandatory) are not used in the template, the test will not go through.

Other actions

When opening the contextual menu (accessible by clicking on the breadcrumbs button), you have multiple actions to work with the notifications templates:
  • Configure - edit the template
  • Export template - export a template as a ZIP file
  • Audit log - view the audit log
  • Copy to another project/library - copy a template to another project/library
  • Duplicate - duplicate a template
  • Delete - delete a template

Export and import

You can export and import notification templates to transfer them between projects or environments (for example, from development to UAT to production).

Exporting a template

To export a notification template:
  1. Open the contextual menu (breadcrumbs button) for the template you want to export
  2. Select Export template
  3. The template is downloaded as a ZIP file

Importing templates

To import notification templates:
  1. Navigate to the Notification Templates list
  2. Open the context menu and select Import from ZIP
  3. Select the ZIP file exported from another project or environment
  4. If templates with the same identifiers already exist, a Review Resource Identifiers Conflicts modal appears
  5. Choose a strategy for each conflicting template (or use Apply to all):
    • Keep both - imports the template as a new copy alongside the existing one
    • Replace - overwrites the existing template with the imported version
    • Skip this one - keeps the existing template unchanged
  6. Click Continue to complete the import
Importing is only available for work-in-progress (WIP) project versions. You cannot import into a committed version.
Last modified on August 11, 2026