Notifications
Understanding Notifications
The notification system enables automated communication with stakeholders throughout the lending process. When specific events occur in your lending operations—such as loan approvals, payment due dates, or document requests—the system automatically sends notifications through email, SMS, messaging platforms, or letter generation.
Notifications require two-layer implementation: developers create notification events in the SDK that define when notifications can trigger, and administrators configure templates in the admin panel that define what messages are sent and to whom. This separation ensures technical flexibility while maintaining business control over communication content.
The Three-Step Implementation Process
Step 1: SDK Setup (Developer Task) Development teams create notification events in code that define available trigger points. This includes specifying what data is available for templates and when notifications can be generated.
Step 2: Admin Configuration (Administrator Task) Administrators configure notification templates in the admin panel, selecting from available event types, designing message content, choosing delivery channels, and specifying recipients.
Step 3: Automatic Delivery (System Task) When configured events occur, the system automatically generates and sends notifications using the templates and delivery channels you've configured.
How Notifications Work
Notification Architecture
The notification system operates through these integrated components:
NotificationEvent (SDK Layer) Defines when notifications can trigger based on system events like status changes, date-based schedules, or user actions. Created by developers and registered with the platform.
NotificationTemplate (Admin Layer) Stores the message content, recipient configuration, and delivery channel settings. Created by administrators through the admin interface.
Gateway Integration (System Layer) Handles actual message delivery through configured channels: SMTP for email, SMS gateways for text messages, messaging platform APIs for WhatsApp or Telegram.
Template Processing (System Layer) Combines templates with entity data at send time, replacing variables with actual values and generating personalized messages.
Event-Driven Execution
Notifications trigger automatically when events occur:
System Event Occurs: Application status changes to "Approved"
Event Detection: Platform identifies registered NotificationEvent for this status
Template Matching: System finds active templates configured for this event type
Data Preparation: NotificationModel provides entity data to template
Content Generation: Template engine replaces variables with actual values
Delivery: Gateway sends notification through configured channel
Tracking: System logs delivery status for monitoring
Step 1: Developer Creates Notification Events (SDK)
Before administrators can configure notifications, developers must create notification events in the SDK. This technical setup defines:
Available Event Types: The triggering conditions administrators can select from (e.g., "LOAN_APPROVED", "PAYMENT_REMINDER")
Available Data: What information templates can access (application details, client information, payment schedules)
Triggering Logic: The business rules that determine when notifications send (status checks, date calculations, conditional logic)
Recipient Options: Who can receive notifications (borrowers, guarantors, internal staff)
For complete SDK implementation details, see SDK Notifications Guide.
Step 2: Admin Configures Templates (Admin Panel)
Once developers have created notification events, administrators configure templates through the admin interface:
Select Event Type: Choose from the dropdown of available event types (populated from SDK setup)
Design Message Content: Use the WYSIWYG editor to create message content with dynamic variables
Choose Delivery Channel: Select EMAIL, SMS, VOICE, or LETTER based on message urgency and recipient preference
Specify Recipients: Configure who receives notifications (participant roles, employee groups, assigned users)
Set Template Parameters: For events with configurable behavior, set timing or threshold parameters
Activate Template: Enable the template to begin automatic notification sending
For detailed configuration instructions, see Notification Configuration.
Step 3: System Sends Notifications (Automatic)
After configuration, the system handles notification delivery automatically:
Automatic Triggering: When events occur, the platform identifies matching templates without manual intervention
Personalization: Each notification is generated with recipient-specific information from the system
Multi-Channel Delivery: Messages are sent through configured channels based on template settings
Delivery Tracking: The system logs all notifications with timestamps, recipients, and delivery status
Error Handling: Failed deliveries are logged and can trigger retry attempts or fallback channels
Common Notification Scenarios
Loan Approval Notifications
Business Need: Inform applicants immediately when their loan application is approved
SDK Event: LoanApprovedEvent triggers when application status changes to APPROVED
Available Data: Application details, approved amount, interest rate, client information
Template Configuration:
Event Type: LOAN_APPROVED
Recipient: Participant (Borrower role)
Gateway: EMAIL and SMS
Content: Congratulations message with loan terms and next steps
Result: Borrower receives immediate notification with approval details and disbursement timeline
Payment Reminder Notifications
Business Need: Remind borrowers of upcoming payments before due dates
SDK Event: PaymentReminderEvent with configurable days-before-due parameter
Available Data: Credit account, payment amount, due date, account balance
Template Configuration:
Event Type: PAYMENT_REMINDER
Event Parameter: daysCount = 3 (send 3 days before due)
Recipient: Participant (Borrower role)
Gateway: SMS
Content: Brief reminder with amount and due date
Result: Borrowers receive SMS reminders three days before payment due dates
Document Request Notifications
Business Need: Alert applicants when additional documents are required
SDK Event: DocumentRequiredEvent triggers when document requirements are added
Available Data: Participant information, required document types, application reference
Template Configuration:
Event Type: DOCUMENT_REQUIRED
Recipient: Participant (specific roles)
Gateway: EMAIL
Content: List of required documents with upload instructions
Result: Applicants receive email notifications specifying exactly what documents to provide
Manual Review Alerts
Business Need: Notify underwriting staff when applications require manual review
SDK Event: ApplicationStatusChangeEvent triggers on MANUAL_REVIEW status
Available Data: Application details, review reasons, assigned underwriter
Template Configuration:
Event Type: APPLICATION_STATUS_CHANGE
Event Parameter: status = MANUAL_REVIEW
Recipient: Organization Employees (subscribed underwriters)
Gateway: Internal messaging
Content: Application summary with review priority
Result: Underwriting team receives task notifications for applications requiring attention
Payment Received Confirmations
Business Need: Confirm payment receipt to borrowers for record-keeping
SDK Event: PaymentReceivedEvent triggers when payment is processed
Available Data: Payment amount, payment date, remaining balance, receipt number
Template Configuration:
Event Type: PAYMENT_RECEIVED
Recipient: Participant (Borrower role)
Gateway: EMAIL
Content: Payment confirmation with transaction details and updated balance
Result: Borrowers receive immediate email confirmation of payment processing
Notification Capabilities
Recipient Configuration
Direct Participants: Notifications to borrowers, co-borrowers, guarantors, or pledgors associated with specific applications or credits
Role-Based Routing: Target participants by their role in the lending process without specifying individuals
Employee Subscriptions: Internal staff subscribe to notification types relevant to their responsibilities, receiving alerts for all matching events
Assigned Users: Notifications to the specific employee assigned to an application, credit account, or workflow task
Dynamic Resolution: The system automatically determines the correct recipient based on entity relationships at send time
Multi-Channel Delivery
EMAIL: Detailed communications with formatting, links, and attachments through SMTP gateway integration
SMS: Brief, urgent notifications delivered via SMS gateway with character limit optimization
VOICE: Automated voice calls for critical alerts through telephony integration
LETTER: Generated documents for postal delivery or physical record requirements
Channel Selection: Templates specify the delivery channel; some notifications may use multiple channels simultaneously
Content Personalization
Variable Substitution: Templates use Pebble template syntax to insert dynamic data (e.g., {{ application.requestedAmount }})
Conditional Content: Different message sections display based on entity state or properties
Localization Support: Templates can be created in multiple languages for multi-region deployment
Formatting Options: HTML email support, plain text for SMS, structured formatting for letters
Delivery Control
Late Send Available: Flag indicating whether notifications can be sent outside business hours for 24/7 operations
Duplicate Prevention: Option to prevent sending the same notification multiple times to the same recipient
Delivery Timing: Immediate sending for urgent notifications or batched delivery for routine communications
Retry Logic: Automatic retry attempts for failed deliveries with configurable retry intervals
Compliance and Tracking
Audit Trail: Complete logging of all notifications with send timestamps, recipients, content, and delivery status
Template Versioning: Track changes to templates over time for regulatory compliance
Delivery Confirmation: Status tracking showing successful delivery, failures, or pending states
Reporting: Analytics on notification volume, delivery rates, and channel effectiveness
Employee Notification Management
For internal team communications, the notification system supports subscription-based delivery to employees who don't have direct assignments to specific applications or credits.
Subscription Mechanism
Template Configuration: Create templates with recipient type "Organization Employees"
User Subscriptions: Configure employee subscriptions on user creation or editing forms in the admin panel
Subscription Matching: When events occur, the system identifies subscribed employees and sends notifications
Department Coverage: Enables department-wide alerts without explicit assignment to individual cases
Subscription Use Cases
Underwriting Queue Notifications: Underwriters subscribe to manual review alerts to see new items requiring attention
Risk Alerts: Risk team subscribes to high-value application notifications for oversight monitoring
Operations Alerts: Operations team subscribes to system exceptions or processing failures
Management Reporting: Managers subscribe to summary notifications for oversight and reporting
Troubleshooting Guide
Event Type Not Available in Admin Panel
Problem: Expected event type doesn't appear in the event type dropdown when creating templates
Cause: SDK notification event has not been created or registered by development team
Solution:
Verify the desired event type has been implemented in the SDK
Contact development team to create the required NotificationEvent class
After SDK deployment, the event type will appear in the admin panel dropdown
Notifications Not Sending
Problem: Templates are configured and active, but notifications are not being delivered
Possible Causes and Solutions:
Gateway Not Configured: Verify SMTP settings for email, SMS gateway credentials for text messages, or messaging platform API configuration
Event Not Triggering: Confirm the system event is actually occurring (status changes, date-based triggers)
Template Inactive: Check that the template's "Active" flag is enabled in the admin panel
Recipient Resolution Failure: Verify that target participants have the required contact information (email addresses, phone numbers)
Event Parameter Mismatch: For parameterized events, ensure template parameters match the conditions for triggering
Variables Not Populating Correctly
Problem: Notification content shows {{ variable }} instead of actual data
Cause: Variable name in template doesn't match available data from NotificationModel
Solution:
Check variable hints in the admin panel template editor for correct variable names
Verify the SDK NotificationModel exposes the property you're trying to access
Ensure proper Pebble template syntax (double curly braces, correct property path)
Duplicate Notifications
Problem: Recipients receive the same notification multiple times
Cause: Multiple templates configured for the same event without duplicate prevention
Solution:
Enable "Prevent Duplicate" flag on templates
Review active templates to ensure only one template per event/recipient combination
Check for multiple event triggering paths in custom business logic
Missing Required Contact Information
Problem: Notification fails to send due to missing recipient contact details
Cause: Participant or employee records lack email addresses or phone numbers
Solution:
Implement data validation to require contact information during participant creation
Add data completeness checks before status changes that trigger notifications
Configure fallback notification channels when primary channel information is missing
Implementation Resources
Through SDK (Development team)
Notification events must be created in code before admin configuration:
Notifications - Complete SDK implementation guide
Creating Notification Events - Event class structure
Notification Models - Data exposure for templates
Event Parameters - Configurable event behavior
Through Admin Panel
After SDK setup, configure notification delivery:
Notification Configuration - Template creation and management
Gateway Setup - Email, SMS, and messaging configuration
User Management - Employee subscription configuration
Related Topics
Status Management - Status-based notification triggers
Document Management - Document-related notification events
Workflow Engine - Workflow-triggered notifications
User Roles - Role-based recipient configuration
timveroOS: Event-driven notification orchestration for efficient lending operations
Last updated
Was this helpful?