Email notification events

This topic describes all email notification events. For information on how to configure email notifications, see Email notifications.

Core events

AML list possibly matched

Executes when a customer's data matches an entry in the AML list. Use this event to notify the customer, a third party, or a member of staff about the new customer record.

Account password reset requested

Executes when a customer requests a password reset. Use this event to send a password reset email to the customer.

Account verification requested

Executes when a customer signs-up or requests verification to be resent. Use this event to send verification or sign-up information to the customer.

Application instance enabled

Executes when a new application instance is enabled. Use this event to notify the customer, a third party, or a member of staff about the new customer record.

Application instance disabled

Executes when an application is disabled. Use this event to notify the customer, a third party, or a member of staff that the application instance is disabled.

Balance transaction settled

Executes when a balance transaction is settled. Use this event to notify the customer, a third party, or a member of staff about the settled balance transaction.

Customer created

Executes when a new customer is created. Use this event to notify the customer, a third party, or a member of staff about the new customer record.

Customer one time password requested

Executes when a customer attempts to log in with One-Time Password (OTP) active. Use case this event to email the customer their one time password.

Customer updated

Executes when an existing customer record is updated. Use this event to notify the customer, a third party, or a member of staff about the change to the customer record.

Dispute created

Executes when a dispute, also known as a chargeback, is added to one of your transactions. Use this event to notify the customer, a third party, or a member of staff about the dispute.

To configure additional automations for this event, see Dispute created.

Dispute modified

Executes when a dispute, also known as a chargeback, is modified. Use this event to notify the customer, a third party, a member of staff, or your fraud agent with the status of the dispute.

Experian check performed

Executes when an Experian identity check is performed. Use this event to notify a third party, or a member of staff of the result of the check.

Gateway account downtime started

Executes when a period of gateway downtime begins. Use case event to notify the customer, a third party, or a member of staff that this gateway is temporarily not available for use.

Gateway account downtime ended

Executes when a period of gateway downtime has ended. Use case this event to notify the customer, a third party, or a member of staff that this gateway is available for use.

Gateway account limit reached

Executes when a gateway account transaction limit is reached. A transaction limit may refer to the number of transactions per day, or the amount of a particular transaction. Use this event to notify the customer that their transaction exceeds the permitted amount.

Gateway account requested

Executes when a customer attempts to make a transaction for the first time. Use this event to notify the customer, a third party, or a member of staff.

To configure additional automations for this event, see Gateway account requested.

KYC document accepted

Executes when a KYC document is accepted. Use this event to notify the customer, a third party, or a member of staff that a KYC document has been accepted.

KYC document modified

Executes when a KYC document is modified. Use this event to notify the customer, a third party, or a member of staff that a KYC document has been modified.

KYC document rejected

Executes when a KYC document is rejected. Use this event to notify the customer, a third party, or a member of staff that a KYC document has been rejected.

KYC request fulfilled

Executes when a KYC request is fulfilled. Use this event to notify the customer, a third party, or a member of staff that a KYC request is fulfilled.

Payment card created

Executes when a payment card is created. Use this event to notify the customer, a third party, or a member of staff.

To configure additional automations for this event, see Payment card created.

Risk score changed

Executes when a transaction risk score changes. Use this event to notify the customer, a third party, or a member of staff.

To configure additional automations for this event, see Risk score changed.

Transaction amount discrepancy found

Executes when a transaction amount discrepancy is found on reconciliation. Use this event is to notify the customer of the discrepancy.

Transaction declined

Executes when a transaction is declined. Use this event to notify the customer that their transaction has been declined.

Transaction discrepancy found

Executes when a paid amount differs from the expected amount. Use this event to notify the customer, a third party, or a member of staff about the discrepancy.

Transaction process requested

Executes at a point just before the transaction process is initialized. Use this event to notify the customer, a third party, or a member of staff.

To configure additional automations for this event, see Transaction process requested.

Transaction processed

Executes after a transaction is processed by a payment gateway. Use this event to notify the customer that their transaction has been processed.

To configure additional automations for this event, see Transaction processed.

Billing events

Hard usage limit reached

Executes when a hard usage limit threshold for an item with a metered billing plan is reached. If a hard usage limit is reached, a customer can no longer use a metered billing service.

Use this event to notify the customer that the hard limit is reached, and to inform them that they must upgrade their plan to continue using the service.

Invoice issued

Executes when an invoice is issued. Use this event to email the invoice to the customer.

To configure additional automations for this event, see Invoice issued.

Invoice modified

Executes when an invoice is modified. Use this event to notify the customer that the invoice has been modified.

Invoice paid

Executes when an invoice is paid. Use this event to email the invoice to the customer.

Invoice partially paid

Executes when an invoice is partially paid. Use this event to notify the customer that the invoice is partially paid.

Invoice partially refunded

Executes when an invoice is partially refunded. Use this event to notify the customer that the invoice is partially refunded.

Invoice past due

Executes when an invoice is past due. Use this event is to remind the customer to pay the invoice.

To configure additional automations for this event, see Invoice past due.

Invoice past due reminder

Executes when an invoice has been past due for an amount of time. Use this event is to remind the customer to pay the invoice.

To configure additional automations for this event, see Invoice past due reminder.

Invoice refunded

Executes when an invoice payment is refunded. Use this event to notify the customer that the invoice has been refunded.

Invoice revenue recognized

Executes when invoice revenue is recognized. Use this event to notify the customer, a third party, or a member of staff about the recognized revenue.

Invoice tax calculation failed

Executes when an invoice tax calculation fails. Use this event to notify the customer, a third party, or a member of staff about the failed tax calculation.

Invoice voided

Executes when an invoice is voided. Use this event to notify the customer that the invoice has been voided.

Order abandoned

Executes when an order is abandoned. Use this event to notify the customer that their order has been abandoned.

Order abandon reminder

Executes an order is about to be abandoned. Use this event to notify the customer that their order is about to be abandoned and to remind them to complete the order.

Order completed

Executes when an order is completed. Use this event to notify the customer that their order has been completed.

Order delinquency reached

Executes when the delinquency period of an order is reached. The delinquency period is the length of time after which a subscription is canceled if it is not paid. For information on how to set the delinquency period, see Create an order.

Use this event to notify the customer by email that their order is delinquent and that it will be canceled if it is not paid.

Payment card expiration reminder

Executes when a customer's payment card is due to expire. Use this event to notify the customer and remind them to update their payment card details.

To configure additional automations for this event, see Payment card expiration reminder.

Payment card expired

Executes when a customer's payment card expires. Use this event to notify the customer and instruct them to update their billing information.

To configure additional automations for this event, see Payment card expired.

Renewal invoice issued

Executes when a renewal invoice is issued. Use case event to email the invoice to the customer.

To configure additional automations for this event, see Renewal invoice issued.

Renewal invoice payment canceled

Executes when a renewal invoice payment is canceled. Use this event to notify the customer that renewal payment has been canceled.

To configure additional automations for this event, see Renewal invoice payment canceled.

Renewal invoice payment declined

Executes when a renewal invoice payment is declined. A renewal invoice is a recurring invoice for a plan or product which is charged automatically. Use this event to inform the customer that their payment was declined.

To configure additional automations for this event, see Renewal invoice payment declined.

Soft usage limit reached

Executes when a soft usage limit threshold for an item with a metered billing plan is reached. Soft usage limits are used to notify customers that their usage is near the hard limit of their metered billing plan, so that they can upgrade their plan before the hard limit is reached.

Use this event to notify customers that their usage is near the hard limit of their metered billing plan, and that they may soon need to upgrade their plan to continue using the service.

Subscription activated

Executes when a customer's subscription is activated. Use this event is to send a confirmation email to the customer.

To configure additional automations for this event, see Subscription activated.

Subscription canceled

Executes when a customer's subscription is canceled. Use this event to notify third-party services, and request to disallow access for the customer.

To configure additional automations for this event, see Subscription canceled.

Subscription created

Executes when a customer signs up to a subscription service. At this point in the order lifecyle, the subscription order is in the pending state and is not active. The order becomes active when an invoice is paid, or when a payment instrument is verified for free trial.

Use this event to notify the customer, a third party, or a member of staff about the new subscription.

To configure additional automations for this event, see Subscription created.

Subscription items changed

Executes when items of a subscription are changed. Use this event to notify the customer, a third party, or a member of staff about the change to the subscription.

Subscription reactivated

Executes when a subscription is reactivated. Use this event to notify the customer, a third party, or a member of staff about the reactivation of the subscription.

Subscription churned

Executes when a customer's subscription is churned. Use this event to notify the customer, a third party, or a member of staff about the churned subscription.

Subscription downgraded

Executes when a subscription is downgraded. Use this event to notify the customer, a third party, or a member of staff about the downgrade of the subscription.

Subscription paused

Executes when a subscription is paused. Use this event to notify the customer, a third party, or a member of staff about the paused subscription.

Subscription renewal reminder

Executes when a subscription renewal is approaching. Use this event to email the customer and remind them of the renewal date.

To configure additional automations for this event, see Subscription renewal reminder.

Subscription renewed

Executes when a customer's subscription is renewed. Use this event to notify the customer about the renewed subscription.

To configure additional automations for this event, see Subscription renewed.

Subscription trial converted

Executes when the first invoice after the trial period is paid. Use this event to notify the customer, a third party, or a member of staff about the conversion of the trial subscription to a paid subscription.

To configure additional automations for this event, see Subscription trial converted.

Subscription trial end reminder

Executes when a subscription trial end date is approaching. Use this event to email the customer and remind them of the trial end date.

To configure additional automations for this event, see Subscription trial end reminder.

Subscription upgraded

Executes when a subscription is upgraded. Use this event to notify the customer, a third party, or a member of staff about the upgrade of the subscription.