4.2.5.1.1 Informant and staff notifications
📣 Notifications & Messaging in OpenCRVS
In a production environment, OpenCRVS sends automated notifications to staff and informants at key points in the registration workflow. In development and QA environments, messages are disabled by default to prevent accidental delivery.
You can fully customise:
Supported communication channels (Email, SMS, WhatsApp, etc.)
Message languages and localisation
Message content and frequency
Integration providers (e.g., Infobip, SendGrid)
The Farajaland example includes:
SMS integration using Infobip
Email integration using SendGrid
🔁 Event Notification Flow
All event-related notifications pass through the onAnyActionHandler endpoint in countryconfig.
This handler is triggered whenever an event changes status (e.g., VALIDATED → REGISTERED).
From this handler, the logic routes into a shared notify method where you can:
Decide which messages to send
Apply localisation
Choose communication channels
Customise timing or suppress notifications
This is the central place to configure message behaviour for your country implementation.
📧 Email Templates
Email messages are written in HTML and can be fully customised.
Templates are located in the email templates directory
You may edit them to fit your country’s branding, tone, or regulatory requirements
For each custom event type you introduce, you must create or modify a corresponding template
The Farajaland configuration includes example templates for birth, death, and marriage events
📱 SMS & WhatsApp Templates
SMS templates also support localisation and can be used for SMS or WhatsApp delivery.
Templates are stored in the SMS templates directory
They are short-text, plain-language versions of notification messages
For every custom event type, you must use or create a matching SMS template
Farajaland provides sample templates for birth, death, and marriage
📣 Essential staff communications
The following messages are sent to staff by default, as they are required for normal OpenCRVS operation.
By default, these notifications are delivered via email, but SMS equivalents can also be configured.
Below are example SMS versions of these essential staff messages:
authenticationCodeNotification
Received by a staff member when logging in. Used to send the 2FA code for authentication during login REQUIRED IN PRODUCTION FOR SECURITY REASONS!! In development and qa environments, the 2FA code is always six zeros: 000000
Your OpenCRVS authentication code is: {{code}}
userCredentialsNotification
Received by a staff member when their OpenCRVS account has been created by a System Administrator
Your OpenCRVS account has been created. Please login with your username: {{username}} and temporary password: {{temporaryPassword}}
retrieveUserNameNotification
Received by staff when they have forgotten their username
Your username for OpenCRVS is: {{username}}
updateUserNameNotification
Received by staff when a System Administrator has changed their username
Your OpenCRVS username has been updated to: {{newUsername}}. Your password has not changed.
resetUserPasswordByAdminNotification
Received by staff when a System Administrator has changed their password
Your password has been reset. Please login to {{applicationName}} with the temporary password: {{temporaryPassword}}.
resetUserPasswordNotification
Received by staff when they attempt to reset their password
Use the code {{code}} to reset your {{applicationName}} password. This code expires in 10 minutes.
Essential staff communication endpoints
All notifications related to staff pass through these routes and should only be carefully modified. Usually these will use Email by default.
Last updated