Notification Management

Overview

The Notification Management module enables automated communication with participants through multiple channels (email, SMS) based on entity state changes and business events configured in the SDK.

Understanding Notification Components

Key Components

Notification Templates: Pre-defined message structures with dynamic field placeholders for personalized content delivery.

Notification Events: Entity state changes configured in the SDK that trigger notification sending (e.g., application moves to "Approved" state, document moves to "Requested" state).

Delivery Channels: Communication methods available for notification transmission (email, SMS).

Template Configuration

Accessing Notification Templates

Navigation:

Navigate to Admin Panel → Notifications → Templates
Select Create New Template or edit existing template

Creating Notification Templates

Step 1: Define Template Basic Information

Template Name: Internal identifier for the template
Template Type: Select notification channel
- Email
- SMS
Event Trigger: Select from SDK-configured entity state changes
Language: Set template language (supports multi-language variants)

Note: Events are entity states configured in the SDK. The dropdown will show available events based on your SDK configuration (e.g., "Loan Application - Submitted", "Loan Application - Approved", "Document - Requested").

Step 2: Design Template Content

For Email Templates:

Subject Line: Use dynamic placeholders by typing {{ to reference data model fields (e.g., {{participant.name}}, {{application.id}})
Email Body: Rich text editor with HTML support. Insert dynamic fields using {{field.name}} syntax
Sender Name: Display name for email sender
Reply-To Address: Email address for participant responses

For SMS Templates:

Message Text: Plain text with 160-character optimization
Dynamic Fields: Reference data model fields using {{ syntax (e.g., {{loan.amount}}, {{appointment.date}})
Character Count: Real-time character counter with multi-part SMS indicator

Dynamic Field Reference: To insert dynamic fields, type {{ in the template content and reference fields from the data model:

Participant attributes: {{participant.firstName}}, {{participant.email}}
Application data: {{application.id}}, {{application.status}}
Loan information: {{loan.amount}}, {{loan.currency}}
Custom workflow variables: {{custom.fieldName}}

Step 3: Save and Preview Template

Click Save Template
Click Check button to preview the template
Select Entity: Choose a specific entity (application, loan, participant) from your data
View Generated Template: System generates the complete template with actual data from the selected entity
Review how dynamic fields are populated with real values

Example Preview:

Original Template:
"Dear {{participant.firstName}}, your loan #{{application.id}} for {{loan.amount}} {{loan.currency}} has been approved."

After selecting Entity (Application #12345):
"Dear John, your loan #12345 for 50,000 USD has been approved."

Template becomes available for event association.

Event Association

Linking Templates to Entity State Changes

Events are configured in the SDK as entity state transitions. In the Admin Panel, you associate notification templates with these pre-configured events.

Event Configuration (SDK-Level):

Entity states are defined in SDK (e.g., Loan Application states: Draft, Submitted, Under Review, Approved, Declined)
State transitions trigger events (e.g., transition from "Under Review" → "Approved" triggers "Application Approved" event)
Each event can trigger one or more notifications

Template Association (Admin Panel):

Navigate to Admin Panel → Notifications → Events
View list of SDK-configured events
Select event to configure
Click Add Notification Template
Choose template from dropdown
Configure recipient:
- Participant (entity owner)
- Specific user role
- Custom email from entity field
Save configuration

Example Event Association:

Event: "Loan Application - Approved" (SDK-configured state change)
↓
Notification Template: "loan-approval-email"
↓
Recipient: Participant (application owner)
↓
Delivery: Email sent when application transitions to "Approved" state

Notification Verification

After configuring notification templates and associating them with entity state events, verification requires triggering the actual entity state change:

Manual Verification Process:

Trigger the relevant entity state change in a test environment
- Example: Move a test loan application to "Approved" state to trigger "Application Approved" event
Verify notification delivery to the intended recipient
Check notification content for correct dynamic field population
Confirm delivery channel functionality (email inbox, SMS receipt)

Note: There is no built-in test functionality within the notification template interface. Verification must be performed through actual entity state changes in a test environment.

Examples

Example 1: Email Notification Configuration

Loan Application Approval Email

Step 1: Create Email Template

Template Name: loan-approval-email
Template Type: Email
Event Trigger: Select from dropdown: "Loan Application - Approved"

Note: The "Loan Application - Approved" event is configured in the SDK as a state transition.

Step 2: Design Template Content

Subject: Your loan application #{{application.id}} has been approved!
Body:

Dear {{participant.firstName}},

Congratulations! Your loan application for {{loan.amount}} {{loan.currency}} has been approved.

Next Steps:
- Review your loan agreement in the customer portal
- Sign documents electronically
- Funds will be disbursed within 2 business days

Best regards,
{{company.name}} Team

Step 3: Save and Preview

Click Save Template
Click Check button
Select a test loan application from the dropdown
Review generated template with actual data

Step 4: Associate with Event

Navigate to Notifications → Events
Find "Loan Application - Approved" event
Click Add Notification Template
Select loan-approval-email
Set recipient: Participant (application owner)
Save configuration

Step 5: Verify Notification

Move a test loan application to "Approved" state in test environment
Verify email delivery to test participant email address
Confirm all dynamic fields populated correctly

Example 2: SMS Notification Configuration

Document Request SMS

Step 1: Create SMS Template

Template Name: document-request-sms
Template Type: SMS
Event Trigger: Select from dropdown: "Document - Requested"

Step 2: Design SMS Content

Message: {{company.name}}: Please upload {{document.type}} for application #{{application.id}}. Login: {{portal.url}}