This documents builds on our official Community guide, so be sure to read that first. How to create custom General notifications
Backbase provides the following reference General Notification that can be adopted to your project needs.
| Id | Description | Trigger Event | Channels |
|---|---|---|---|
account-balance-low |
Notify users when their account balance drops below their specified threshold amount as per their specific notification preference for the account | com.backbase.dbs.actions.reactive.event.spec.v2.AccountBalanceChangedEvent |
in-app-notification, push |
account-statement-ready |
Notify users when account statement is ready. This GN is disabled by default for business and retail, to enable it - remove or change manageable parameter to true. This event is an example and not generated by the Backbase platform. |
com.backbase.account.statement.event.spec.v1.AccountStatementReadyEvent |
in-app-notification, push |
account-statements-archive-download-ready |
Notify users when account statements archive is ready to download | com.backbase.account.statement.event.spec.v1.AccountStatementsArchiveCreationCompletedEvent |
in-app-notification |
account-statements-archive-creation-failed |
Notify users when account statements archive creation failed and cannot be downloaded | com.backbase.account.statement.event.spec.v1.AccountStatementsArchiveCreationFailedEvent |
in-app-notification |
audit-export-ready |
Notify users when the Audit Export CSV file they initiated is ready to download | com.backbase.audit.persistence.event.spec.v1.AuditExportCompletedEvent |
in-app-notification |
audit-export-failed |
Notify users when the Audit Export CSV file they initiated has failed | com.backbase.audit.persistence.event.spec.v1.AuditExportCompletedEvent |
in-app-notification |
contacts-file-upload-completed |
Notify users when contacts file upload is completed and contacts data imported to the system | com.backbase.dbs.contactmanager.contact.event.spec.v1.ContactsFileImportFinishedEvent |
in-app-notification |
contacts-file-upload-failed |
Notify users when contacts file upload failed and cannot be imported | com.backbase.dbs.contactmanager.contact.event.spec.v1.ContactsFileImportFinishedEvent |
in-app-notification |
new-message-received |
Notify users when there is a new message or a reply to their existing conversation | com.backbase.dbs.messages.pandp.event.spec.v4.MessageReceivedEvent |
in-app-notification, push |
new-transaction-occurred |
Notify users when a new transaction is posted to their account for which they have enabled their notification preference for the account | com.backbase.transaction.persistence.event.spec.v1.TransactionsAddedEvent |
in-app-notification, push |
batch-status-updated |
Notify users when batch status is updated (rejected or processed with some rejected transfers) as per their specific notification preference for the account | com.backbase.paymentbatch.event.spec.v1.BatchOrderStatusUpdatedEvent |
in-app-notification |
contact-status-updated-rejected |
Notify users when contact status is updated (rejected) as per their specific notification preference for the account | com.backbase.dbs.contactmanager.contact.event.spec.v1.ContactUpdatedEvent |
in-app-notification |
payment-status-updated-rejected |
Notify users when payment status is updated (rejected) as per their specific notification preference for the account | com.backbase.payment.event.spec.v1.PaymentOrderUpdatedEvent |
in-app-notification |
payment-to-approve |
Notify users when the payment to approve is received as per their specific notification preference for the account | com.backbase.dbs.approval.persistence.event.spec.v3.PendingApprovalEvent |
in-app-notification |
contact-to-approve |
Notify users when the contact to approve is received as per their specific notification preference for the account | com.backbase.dbs.approval.persistence.event.spec.v3.PendingApprovalEvent |
in-app-notification |
batch-to-approve |
Notify users when the batch to approve is received as per their specific notification preference for the account | com.backbase.dbs.approval.persistence.event.spec.v3.PendingApprovalEvent |
in-app-notification |
conv-hist-export-ready |
Notify users when the Conversation History Export file they initiated is ready to download | com.backbase.employee.actions.event.spec.v1.ConvHistExportCompletedEvent |
in-app-notification |
conv-hist-export-failed |
Notify users when the Conversation History Export file they initiated has failed | com.backbase.employee.actions.event.spec.v1.ConvHistExportCompletedEvent |
in-app-notification |
pp-ach-exceptions-created |
Notify users about newly created exceptions to resolve | com.backbase.positivepay.event.spec.v1.PpAchExceptionsCreatedEvent |
in-app-notification |
pp-ach-upcoming-cut-off-time |
Notify users about about upcoming cut-off time event so users can review active exceptions during that time before default system decision is applied to them | com.backbase.positivepay.event.spec.v1.PpAchUpcomingCutOffTimeEvent |
in-app-notification |
pp-check-exceptions-created |
Notify users about newly created exceptions to resolve | com.backbase.positivepay.event.spec.v1.PpAchExceptionsCreatedEvent |
in-app-notification |
pp-check-upcoming-cut-off-time |
Notify users about about upcoming cut-off time event so users can review active exceptions during that time before default system decision is applied to them | com.backbase.positivepay.event.spec.v1.PpAchUpcomingCutOffTimeEvent |
in-app-notification |
device-added |
A device is registered to an account | com.backbase.identity.device.event.spec.v1.DeviceAddedEvent |
email |
device-removed |
A device is removed from an account | com.backbase.identity.device.event.spec.v1.DeviceRemovedEvent |
email |
email-address-added |
Notify users when a new email address is added to their account | com.backbase.dbs.user.manager.event.spec.v2.AddEmailSecNotEvent |
email |
update-email-address |
Notify users when an email address is updated on their account | com.backbase.dbs.user.manager.event.spec.v2.UpdateEmailSecNotEvent |
email |
email-address-deleted |
Notify users when an email address is deleted from their account | com.backbase.dbs.user.manager.event.spec.v2.DeleteEmailSecNotEvent |
email |
phone-number-added |
Notify users when a new phone number is added to their account | com.backbase.dbs.user.manager.event.spec.v2.AddPhoneNumberSecNotEvent |
email |
phone-number-updated |
Notify users when a phone number is updated on their account | com.backbase.dbs.user.manager.event.spec.v2.UpdatePhoneNumberSecNotEvent |
email |
phone-number-deleted |
Notify users when a phone number is deleted from their account | com.backbase.dbs.user.manager.event.spec.v2.DeletePhoneNumberSecNotEvent |
email |
postal-address-added |
Notify users when a new postal address is added to their account | com.backbase.dbs.user.manager.event.spec.v2.AddPostalAddressSecNotEvent |
email |
postal-address-updated |
Notify users when a postal address is updated on their account | com.backbase.dbs.user.manager.event.spec.v2.UpdatePostalAddressSecNotEvent |
email |
postal-address-deleted |
Notify users when a postal address is deleted from their account | com.backbase.dbs.user.manager.event.spec.v2.DeletePostalAddressSecNotEvent |
email |
username-changed |
Notify users when their username is changed | com.backbase.dbs.user.manager.event.spec.v2.ChangeUsernameSecNotEvent |
email |
password-changed |
Notify users when their password is changed | com.backbase.dbs.user.manager.event.spec.v2.ChangeOwnPasswordSecNotEvent |
email |
password-reset-success |
Notify users when their password is reset successfully | com.backbase.identity.accountrecovery.event.spec.v1.PasswordResetSuccessEvent |
email |
password-reset-failure |
Notify users when their password reset fails | com.backbase.identity.accountrecovery.event.spec.v1.PasswordResetFailureEvent |
email |
direct-deposit-success |
Notify users when a Direct Deposit is successful | com.backbase.directdepositswitch.event.spec.v1.DirectDepositSuccessEvent |
in-app-notification |
direct-deposit-failed |
Notify users when a Direct Deposit is failed | com.backbase.directdepositswitch.event.spec.v1.DirectDepositFailedEvent |
in-app-notification |
Below is a list of all the Backbase events that can be used to trigger your custom General Notification.
| Id | Event | Description | Capability | Spec |
|---|---|---|---|---|
account-balance-changed |
com.backbase.dbs.actions.reactive.event.spec.v2.AccountBalanceChangedEvent |
Account Balance Changed | Core banking system | AccountBalanceChangedEvent |
account-statement-ready |
com.backbase.dbs.actions.reactive.event.spec.v2.AccountStatementReadyEvent |
Account Statement Ready | Core banking system | AccountStatementReadyEvent |
account-statements-archive-creation-completed |
com.backbase.account.statement.event.spec.v1.AccountStatementsArchiveCreationCompletedEvent |
Account Statements Archive Creation Completed | Account Statements | AccountStatementsArchiveCreationCompletedEvent |
account-statements-archive-creation-failed |
com.backbase.account.statement.event.spec.v1.AccountStatementsArchiveCreationFailedEvent |
Account Statements Archive Creation Failed | Account Statements | AccountStatementsArchiveCreationFailedEvent |
audit-export-completed |
com.backbase.audit.persistence.event.spec.v1.AuditExportCompletedEvent |
Audit Export Completed | Audit | AuditExportCompletedEvent |
batch-status-updated |
com.backbase.paymentbatch.event.spec.v1.BatchOrderStatusUpdatedEvent |
Batch Status Updated | Batches | BatchOrderStatusUpdatedEvent |
contacts-file-import-finished |
com.backbase.dbs.contactmanager.contact.event.spec.v1.ContactsFileImportFinishedEvent |
Contacts File Import Finished | Contacts | ContactsFileImportFinishedEvent |
conv-hist-export-completed |
com.backbase.employee.actions.event.spec.v1.ConvHistExportCompletedEvent |
Conversation History Export Completed | Employee Actions | ConvHistExportCompletedEvent |
party-updated |
com.backbase.dbs.contactmanager.contact.event.spec.v1.ContactUpdatedEvent |
Contact Updated | Contacts | ContactUpdatedEvent |
message-received |
com.backbase.dbs.messages.pandp.event.spec.v4.MessageReceivedEvent |
Message Received | Messages | MessageReceivedEvent |
new-message-in-assigned-conversation |
com.backbase.dbs.messages.pandp.event.spec.v4.NewMsgInAssignedConversationEvent |
New Message In Assigned Conversation | Messages | NewMsgInAssignedConversationEvent |
new-unassigned-conversation |
com.backbase.dbs.messages.pandp.event.spec.v4.NewUnassignedConversationEvent |
New Unassigned Conversation | Messages | NewUnassignedConversationEvent |
payment-order-updated |
com.backbase.payment.event.spec.v1.PaymentOrderUpdatedEvent |
Payment Order Updated | Payment | PaymentOrderUpdatedEvent |
pending-approval |
com.backbase.dbs.approval.persistence.event.spec.v3.PendingApprovalEvent |
Pending Approval | Approval | PendingApprovalEvent |
transaction-added |
com.backbase.transaction.persistence.event.spec.v1.TransactionsAddedEvent |
Transaction Added | Transaction | TransactionsAddedEvent |
pp-ach-exceptions-created |
com.backbase.positivepay.event.spec.v1.PpAchExceptionsCreatedEvent |
Positive Pay ACH Exceptions created | Positive Pay ACH | PpAchExceptionsCreatedEvent |
pp-ach-upcoming-cut-off-time |
com.backbase.positivepay.event.spec.v1.PpAchUpcomingCutOffTimeEvent |
Positive Pay ACH cut-off time event triggered | Positive Pay ACH | PpAchUpcomingCutOffTimeEvent |
pp-check-exceptions-created |
com.backbase.positivepay.event.spec.v1.PpCheckExceptionsCreatedEvent |
Positive Pay Checks Exceptions created | Positive Pay Checks | PpCheckExceptionsCreatedEvent |
pp-check-upcoming-cut-off-time |
com.backbase.positivepay.event.spec.v1.PpCheckUpcomingCutOffTimeEvent |
Positive Pay Checks cut-off time event triggered | Positive Pay Checks | PpCheckUpcomingCutOffTimeEvent |
password-reset-success |
com.backbase.identity.accountrecovery.event.spec.v1.PasswordResetSuccessEvent |
Password reset success | Identity | PasswordResetSuccessEvent |
password-reset-failure |
com.backbase.identity.accountrecovery.event.spec.v1.PasswordResetFailureEvent |
Password reset failure | Identity | PasswordResetFailureEvent |
email-address-added |
com.backbase.dbs.user.manager.event.spec.v2.AddEmailSecNotEvent |
An email address is added to an account | User | EmailAddressAddedEvent |
email-address-deleted |
com.backbase.dbs.user.manager.event.spec.v2.DeleteEmailSecNotEvent |
An email address is deleted from an account | User | EmailAddressDeletedEvent |
update-email-address |
com.backbase.dbs.user.manager.event.spec.v2.UpdateEmailSecNotEvent |
An email address is updated | User | UpdateEmailAddressEvent |
phone-number-added |
com.backbase.dbs.user.manager.event.spec.v2.AddPhoneNumberSecNotEvent |
A phone number is added to an account | User | PhoneNumberAddedEvent |
phone-number-deleted |
com.backbase.dbs.user.manager.event.spec.v2.DeletePhoneNumberSecNotEvent |
A phone number is deleted from an account | User | PhoneNumberDeletedEvent |
phone-number-updated |
com.backbase.dbs.user.manager.event.spec.v2.UpdatePhoneNumberSecNotEvent |
A phone number is updated | User | UpdatePhoneNumberEvent |
postal-address-added |
com.backbase.dbs.user.manager.event.spec.v2.AddPostalAddressSecNotEvent |
A postal address is added to an account | User | PostalAddressAddedEvent |
postal-address-deleted |
com.backbase.dbs.user.manager.event.spec.v2.DeletePostalAddressSecNotEvent |
A postal address is deleted from an account | User | PostalAddressDeletedEvent |
postal-address-updated |
com.backbase.dbs.user.manager.event.spec.v2.UpdatePostalAddressSecNotEvent |
A postal address is updated | User | UpdatePostalAddressEvent |
username-changed |
com.backbase.dbs.user.manager.event.spec.v2.ChangeUsernameSecNotEvent |
A username is changed | User | UsernameChangedEvent |
password-changed |
com.backbase.dbs.user.manager.event.spec.v2.ChangeOwnPasswordSecNotEvent |
A password is changed | User | PasswordChangedEvent |
direct-deposit-success |
com.backbase.directdepositswitch.event.spec.v1.DirectDepositSuccessEvent |
Direct Deposit is successful | Direct Deposit Switch | DirectDepositSuccessEvent |
direct-deposit-failed |
com.backbase.directdepositswitch.event.spec.v1.DirectDepositFailedEvent |
Direct Deposit failed | Direct Deposit Switch | DirectDepositFailedEvent |
Below is a list of routes that can be used by your notification.
| Id | Description | Route data | Channel |
|---|---|---|---|
account-statements-archive-download-view |
Route to the specific link with account statements archive. Link should be provided in the Route data | {\"link\":\"{{{event.link}}}\"} |
in-app-notification |
arrangement-view |
Route to the arrangement view with specific arrangement from arrangementId field of the Route data |
{\"id\":\"{{event.id}}\",\"arrangementId\":\"{{event.arrangementId}}\"} |
in-app-notification, push |
audit-download-view |
Route to the specific link with the audit export report. Link should be provided in the Route data | {\"link\":\"{{{event.link}}}\"} |
in-app-notification |
conversation-view |
Route to the specific conversation with conversationId from the Route data |
{\"id\":\"{{event.conversationId}}\"} |
in-app-notification, push |
conversation-trends-download-view |
Route to the export view with the conversation history export report. Export id should be provided in the Route data | {\"exportId\":\"{{{event.exportId}}}\",\"fileType\":\"{{{event.fileType}}}\"} |
in-app-notification |
transaction-view |
Route to the transaction view with specific transaction and arrangement. These fields should be specified field in the Route data | {\"id\":\"{{event.id}}\",\"arrangementId\":\"{{event.arrangementId}}\"} |
in-app-notification, push |
party-view |
Route to the party view. These fields should be specified field in the Route data | {\"id\": \"{{event.party.id}}\"} |
in-app-notification |
payment-view |
Route to the payment view. These fields should be specified field in the Route data | {\"id\": \"{{event.paymentOrder.id}}\"} |
in-app-notification |
batch-view |
Route to the batch view. These fields should be specified field in the Route data | {\"id\":\"{{event.id}}\",\"batchType\":\"{{event.type}}\"} |
in-app-notification |
direct-debit-view |
Route to the direct debit batch view. These fields should be specified field in the Route data | {\"id\":\"{{event.id}}\",\"batchType\":\"{{event.type}}\"} |
in-app-notification |
payment-approve-view |
Route to the payment approve view. These fields should be specified field in the Route data | {\"id\":\"{{event.approval.itemId}}\"} |
in-app-notification |
party-approve-view |
Route to the party approve view. These fields should be specified field in the Route data | {\"id\":\"{{event.approval.itemId}}\"} |
in-app-notification |
batch-approve-view |
Route to the batch approve view. These fields should be specified field in the Route data | {\"id\":\"{{event.approval.itemId}}\",\"businessFunction\":\"{{event.approval.function}}\"} |
in-app-notification |
direct-debit-approve-view |
Route to the direct debit batch approve view. These fields should be specified field in the Route data | {\"id\":\"{{event.approval.itemId}}\",\"businessFunction\":\"{{event.approval.function}}\"} |
in-app-notification |
positive-pay-ach-active-exceptions-view |
Route to the active exception view. | - | in-app-notification |
positive-pay-check-active-exceptions-view |
Route to the active exception view. | - | in-app-notification |
The Engagements capability uses the channels from the Message Delivery capability here are a list of the supported channels.
| Id | Description | Spec |
|---|---|---|
in-app-notification |
Short in-app web message Notification service | Notification channel event |
push |
Mobile push notification sent directly to a user’s mobile device | Push channel event |
sms |
Sms notification sent directly to a user’s mobile phone | Sms channel event |
email |
Email notification sent to the user's email address | Email channel event |