Events
In the Rebilly rules engine, an event is a preconfigured occurrence. Actions are tasks that execute when an event with a configured rule or bind occurs. This topic describes all event types and actions available for each event.
To configure actions for an event, press an associated action and follow the steps to create a rule, bind, or draft ruleset.
To configure event based email notifications, see Email notifications.
Terms
Event: An event is a preconfigured occurrence. For example, when a customer new customer is created, the 'customer created' event is triggered.
Rules and binds: There are two methods of creating automations in Rebilly:
- Rules: Can be configured to stop subsequent rules in the event list from being executed.
- Binds: Can be configured to always execute, regardless of rule-based events. Use this automation type when you want to ensure an automation always executes when an event occurs.
Action: An action is a task that executes when an event with a configured rule or bind occurs.
Ruleset: Each event maintains a list of automations that are to be executed under specified conditions when the event occurs. These lists of automations are called rulesets. Rulesets are executed in the order they are listed on the event.
Draft rulesets: Provide a means of testing, and comparing changes with the active ruleset before publishing.
Core events
Customer created
Executes when a new customer is created. Use this event to perform an Experian check on the new customer. To configure this event, see Perform an Experian check.
Customer updated
Executes when customer data is updated. Use this event to perform an Experian check on the new customer. To configure this event, see Perform an Experian check.
Gateway account requested
Executes when a customer attempts to make a transaction for the first time. Use this event to assign a gateway account to process the transaction based on certain conditions, such as: payment card attributes, bank country, currency, and so on.
To configure this event, select from the following actions:
Payment card created
Executes when a payment card is created. Use this event to schedule a reminder at a point in time before or after the expiration date of the card. To configure this event, see Schedule a reminder.
Ready to pay requested
Executes when a customer requests available payment methods for a payment.
Use this event to display the most relevant payment method options for a customer, based on their geographic location. For example, you may need to display different payment methods for customers in Canada and Germany, because they have different payment method expectations. You may also prioritize the customer's active payment methods.
To configure this event, see Adjust ready to pay.
Ready to payout requested
Executes when a customer requests available payment methods for a payout. A common automation for this event is to display the most relevant payment method options for the customer, based on their geographic location.
To configure how a gateway manages payout requests, set the ready to payout instruction in gateway account settings. For more information, see the configure how the gateway manages payout requests step when setting up a gateway account.
To configure this event, see Adjust ready to payout.
Transaction process requested
Executes at a point just before the transaction process is initialized. This provides an opportunity to review the transaction and perform an action based on its attributes. Use this event to increase the risk score for suspicious transactions. For example, if a transaction has a billing address in a country which is considered to be high-risk location for online fraud.
To configure this event, select from the following actions:
Billing events
Invoice issued
Executes when an invoice is issued. Use this event to schedule a reminder. Reminders may be used to alert customers that a payment is automatically collected on a certain date. To configure this event, see Schedule a reminder.
Invoice past due
Executes when an invoice is past due. Use this event to schedule and manage reminders. To configure this event, select from the following actions:
Invoice past due reminder
Executes when an invoice has been past due for an amount of time. Use this event to schedule and manage reminders. To configure this event, select from the following actions:
Order delinquency reached
Executes when an order exceeds the delinquency period. The delinquency period is the length of time after which a subscription is canceled if it is not paid. Use this event to abandon scheduled payments for an order that exceeds the configured delinquency period. For information on how to set the delinquency period, see Delinquency periods.
To configure this event, see Abandon scheduled payments.
Payment card expiration reminder
Executes when a customer's payment card is due to expire. Use this event to schedule and manage reminders. To configure this event, select from the following actions:
Payment card expired
Executes when a customer's payment card expires. Use this event to schedule and manage reminders, and to guess a new expiration date.
Rebilly can be configured to guess a new expiration date. For each guess, the system attempts a $1 authorization. On successful authorization, the customer's payment card will be updated to use that card.
To configure this event, select from the following actions:
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 schedule a payment retry.
To configure this event, see Schedule a payment retry.
Subscription activated
Executes when a customer's subscription is activated. Use this event to schedule reminders. To configure this event, see Schedule a reminder.
Subscription canceled
Executes when a customer's subscription is canceled. Use this event to cancel all scheduled payments for the customer.
To configure this event, see Cancel scheduled payments.
Subscription created
Executes when a customer signs up to a subscription service. At this point in the order lifecyle, the subscription 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.
To configure this event, see Schedule a reminder.
To manage the abandonment of pending orders, see Abandon a pending order. To set this configuration using the Rebilly API, see Configure automatic abandonment of pending orders.
Subscription renewal reminder
Executes when a subscription renewal is approaching. Use this event to schedule and manage reminders. To configure this event, select from the following actions:
Subscription renewed
Executes when a customer's subscription is renewed. Use this event to schedule a payment for the subscription when a subscription is renewed. To configure this event, select from the following actions:
Subscription trial converted
Executes when the first invoice is paid and the trial has ended. Use this event to schedule and manage reminders. To configure this event, select from the following actions:
Subscription trial will end reminder
Executes when a subscription trial is three days from ending. Use this event to schedule and manage reminders.