Event triggers
When setting up automated email, SMS, webhook, or event streaming notifications, you select the event that triggers the notification. Available events depend on the selected target and on enabled features. Some events are not available for all channels (for example, certain Cards or account authorisation hold events are exposed for webhooks and streaming).
Each row below lists the UI label and the API event name (in parentheses). Use the API name when configuring integrations.
| Event | Description |
|---|---|
Account in Arrears (ACCOUNT_IN_ARREARS) | An account changed its status to In Arrears (subject to arrears tolerance). |
End of Day processing completed (END_OF_DAY_PROCESSING_COMPLETED) | Background job completed updating accounts. |
Account Authorisation Hold Created (ACCOUNT_AUTHORISATION_HOLD_CREATED) | An authorisation hold has been created directly on an account (feature-gated). |
Account Authorisation Hold Reversed (ACCOUNT_AUTHORISATION_HOLD_REVERSED) | An authorisation hold has been reversed or cancelled on an account (feature-gated). |
Account Authorisation Hold Settled (ACCOUNT_AUTHORISATION_HOLD_SETTLED) | An authorisation hold has been settled on an account (feature-gated). |
Cards Authorisation Hold Created (CARDS_AUTHORISATION_HOLD_CREATED) | A new authorisation hold was created via the Cards API. |
Cards Authorisation Hold Created in Bulk (CARDS_AUTHORISATION_HOLD_IN_BULK_CREATED) | Authorisation holds were created in bulk via the Cards API. |
Cards Authorisation Hold Amount Increased (CARDS_AUTHORISATION_HOLD_AMOUNT_INCREASED) | An authorisation hold amount increased via the Cards API. |
Cards Authorisation Hold Amount Decreased (CARDS_AUTHORISATION_HOLD_AMOUNT_DECREASED) | An authorisation hold amount decreased via the Cards API. |
Cards Authorisation Hold Expired (CARDS_AUTHORISATION_HOLD_EXPIRED) | An authorisation hold expired after its configured period. |
Cards Authorisation Hold Reversed (CARDS_AUTHORISATION_HOLD_REVERSED) | An authorisation hold was reversed via the Cards API. |
Cards Authorisation Hold Settled (CARDS_AUTHORISATION_HOLD_SETTLED) | An authorisation hold was settled during related card transaction processing. |
Card Deposit Reversal (CARD_DEPOSIT_REVERSAL) | A card deposit transaction was reversed. |
Card Withdrawal Reversal (CARD_WITHDRAWAL_REVERSAL) | A card withdrawal transaction was reversed. |
Change Interest Rate (INTEREST_RATE_CHANGED) | The interest rate was changed at the account level. Note that this event only applies to Loans. |
Client Activity (CLIENT_ACTIVITY) | Non-transactional changes on a client record. |
Client Approved (CLIENT_APPROVED) | Client status changed to Approved. |
Client Created (CLIENT_CREATED) | A new client was created. |
Client Rejected (CLIENT_REJECTED) | Client status changed to Rejected. |
Collection Order Activity (COLLECTION_ORDER_ACTIVITY) | A collection (direct debit) progressed to the next stage. |
Credit Arrangement Created (CREDIT_ARRANGEMENT_CREATED) | A credit arrangement was created. |
Credit Arrangement Edited (CREDIT_ARRANGEMENT_EDITED) | A credit arrangement was edited. |
Credit Arrangement Approved (CREDIT_ARRANGEMENT_APPROVED) | A credit arrangement was approved. |
Credit Arrangement Rejected (CREDIT_ARRANGEMENT_REJECTED) | A credit arrangement was rejected. |
Credit Arrangement Withdrawn (CREDIT_ARRANGEMENT_WITHDRAWN) | A credit arrangement was withdrawn. |
Credit Arrangement Closed (CREDIT_ARRANGEMENT_CLOSED) | A credit arrangement was closed. |
Credit Arrangement Deleted (CREDIT_ARRANGEMENT_DELETED) | A credit arrangement was deleted. |
Credit Arrangement Account Added (CREDIT_ARRANGEMENT_ACCOUNT_ADDED) | An account was added to a credit arrangement. |
Credit Arrangement Account Removed (CREDIT_ARRANGEMENT_ACCOUNT_REMOVED) | An account was removed from a credit arrangement. |
Data Access State Changed (DATA_ACCESS_STATE_CHANGED) | Database access mode changed (read/write vs read-only). |
Deposit (SAVINGS_DEPOSIT) | A deposit transaction was posted on a savings account. |
Deposit (Adjustment) (SAVINGS_DEPOSIT_REVERSAL) | A savings deposit was adjusted. |
Deposit Account Created (SAVINGS_CREATED) | A savings account was created. |
Deposit Account Approval (SAVINGS_APPROVAL) | A savings account was approved. |
Deposit Account Activated (SAVINGS_ACCOUNT_ACTIVATED) | A savings account was activated. |
Deposit Account Activity (SAVINGS_ACCOUNT_ACTIVITY) | Non-transactional changes on a savings account. |
Deposit Account Rejection (SAVINGS_ACCOUNT_REJECTION) | A savings account was rejected in the approval process. |
Deposit Account Closure (SAVINGS_ACCOUNT_CLOSURE) | A savings account in Active or Matured state was closed. |
Deposit Interest Applied (DEPOSIT_INTEREST_APPLIED) | Interest was posted to a savings account (feature-gated). |
Deposit Interest Applied (Adjustment) (DEPOSIT_INTEREST_APPLIED_ADJUSTMENT) | A deposit interest application was adjusted (feature-gated). |
Deposit/Withdrawal Edited (SAVINGS_TRANSACTION_EDITED) | A savings deposit or withdrawal transaction was edited (availability depends on configuration). |
Group Activity (GROUP_ACTIVITY) | Non-transactional changes on a group. |
Group Created (GROUP_CREATED) | A new group was created. |
Loan Account Created (LOAN_CREATED) | A loan account was created. |
Loan Account Approval (LOAN_APPROVAL) | A loan account was approved. |
Loan Account Activity (LOAN_ACCOUNT_ACTIVITY) | Non-transactional changes on a loan account. |
Loan Account Rejection (LOAN_ACCOUNT_REJECTION) | A loan account was rejected in the application process. |
Loan Account Rescheduled (LOAN_ACCOUNT_RESCHEDULED) | A loan account was rescheduled into a new account. |
Loan Account Refinanced (LOAN_ACCOUNT_REFINANCED) | A loan account was refinanced into a new account. |
Loan Account Closed (Repaid) (LOAN_ACCOUNT_CLOSURE) | A loan account was closed after being fully repaid. |
Loan Anticipated Disbursement (LOAN_ANTICIPATED_DISBURSEMENT) | Reminder before anticipated disbursement. |
Loan Disbursement (LOAN_DISBURSEMENT) | A disbursement transaction was posted on a loan account. |
Loan Disbursement (Adjusted) (LOAN_DISBURSEMENT_REVERSAL) | A disbursement transaction was adjusted. |
Loan Repayment (LOAN_REPAYMENT) | A repayment transaction was posted on a loan account. |
Loan Repayment (Adjustment) (LOAN_REPAYMENT_REVERSAL) | A repayment transaction was adjusted. |
Loan Fee Applied (FEE_APPLIED) | A fee applied transaction was posted. |
Loan Fee Charged (FEE_CHARGED) | A fee charged (for example, a disbursement fee) was posted. |
Loan Fee Adjusted (FEE_ADJUSTED) | A fee applied transaction was adjusted. |
Loan Penalty Applied (PENALTY_APPLIED) | A penalty applied transaction was posted. |
Loan Penalty Adjustment (PENALTY_ADJUSTMENT) | A penalty applied transaction was adjusted. |
Loan Write Off (LOAN_ACCOUNT_WRITE_OFF) | A loan was closed with a write-off transaction. |
Fees Due Reduced (FEES_DUE_REDUCED) | A fee due reduce transaction was posted. |
Fee Reduction Adjustment (FEE_REDUCTION_ADJUSTMENT) | A fee due reduce transaction was adjusted. |
Payment Order Activity (PAYMENT_ORDER_ACTIVITY) | A payment order progressed to the next stage (Payment Order target). |
Repayment Reminder (REPAYMENT_REMINDER) | A repayment is due in X days (requires a non-negative trigger days value). |
Withdrawal (SAVINGS_WITHDRAWAL) | A withdrawal transaction was posted on a savings account. |
Withdrawal (Adjustment) (SAVINGS_WITHDRAWAL_REVERSAL) | A savings withdrawal was adjusted. |
Portal Activated (PORTAL_ACTIVATED) | Customer Portal was activated for a client (requires Portal and a communications channel). |
Portal Password Reset (PORTAL_PASSWORD_RESET) | A Customer Portal password reset was requested (requires Portal and a communications channel). |
Journal Entry Added (JOURNAL_ENTRY_ADDED) | A journal entry was added (Accounting target). |
Journal Entry Adjusted (JOURNAL_ENTRY_ADJUSTED) | A journal entry was adjusted (Accounting target). |
note
- Event availability depends on the selected target and on enabled features. Some event categories are not available for certain channels (for example, email templates exclude some account activity, card, and authorisation hold events).
- Cards events require the Cards capability. Account Authorisation Hold events require specific tenant feature toggles. Deposit interest and savings-transaction-edited events can be enabled via tenant settings.
- Use the API event name (in parentheses) when integrating with APIs.