Custom Events
Overview
Custom events allow you to schedule events in ChargeOver automatically. For example, you can send an email to a customer when they update their payment method or send a new customer your link to the customer portal with an event. There are loads of possible options here.
Access custom events
You can access custom events on any page where the robot icon is visible. To get started, click the robot icon to open the custom events slideout canvas.
Supported objects
We support the following objects and their associated events. Each event represents a specific change that can occur to the object, such as when a customer is created or updated.
Customer
- is created
- This event triggers every time a new customer is created
- is updated
- This event triggers every time an existing customer is updated
Contact
- is created
- This event triggers every time a new contact is added to a customer
- is updated
- This event triggers every time an existing contact is updated
Invoice
- Is created
- This event triggers every time a new invoice (one-time or recurring) is created
- Is updated
- This event triggers every time an existing invoice is updated
- Status changes
- This event triggers every time an invoice's status changes
- We support the following invoice statuses:
- Unpaid
- Overdue
- Void
- Paid
- Collections
- Unapproved
- Ages
- This event triggers every time an invoice's next scheduled nightly event processes
Subscription
- Is created
- This event triggers every time a new subscription is created
- Is updated
- This event triggers every time an existing subscription is updated
- Is canceled
- This event triggers every time a subscription is canceled
- Status changes
- This event triggers every time a subscription's status changes
- We support the following subscription statuses:
- Current
- Overdue
- Suspended
- Cancelled
- Ages
- This event triggers every time a subscription's next scheduled nightly event processes
- A line item is added or updated
- This event triggers every time a subscription line item is added or updated
- Is suspended
- This event triggers every time a subscription is suspended
- Is unsuspended
- This event triggers every time a subscription is unsuspended
Transaction (Payment, Credit, Refund)
- is created
- status changes
- This event triggers every time a transaction's status changes
- We support the following transaction statuses:
- Success
- Failed (decline)
- Authorized
- Failed (unknown)
- Void
- Pending
- Pending Batch
- Pending Settlement
- Pending Refund
Credit Card
- is created
- This event triggers every time a new credit card is added to a customer
- is updated
- This event triggers every time an existing credit card is updated
- is approved for autopay
- This event triggers every time a credit card is approved for autopay
ACH/eCheck Details
- is created
- This event triggers every time a new ACH/eCheck account is added to a customer
- is updated
- This event triggers every time an existing ACH/eCheck account is updated
Examples of possible custom events
There are a few different use cases that are fairly popular with our customers. They are listed below.
Keep in mind that if you want your emails to send you certain information that relates to your custom event, you will need to enter in merge tags into the body of your email or the message box.
Receive an email notification when a new customer is created
- On the custom events slideout canvas, select New custom event
- Give your custom event a name
- Select the object you are working with, which in this case will be Customer
- Select is created from the second dropdown
- Click
Continue - Optionally, select your rules for when the event should be triggered
- Leaving the criteria section blank means that the action will always trigger when the event occurs
- Click
Continue - Select Send an email from the action dropdown
- Customize the email message with your own text or merge tags
- Click
Save
Receive an email notification when a transaction is declined
- On the custom events slideout canvas, select New custom event
- Select Transaction as the object you are working with
- Select is created from the second dropdown
- Click
Continue - Select All from the first dropdown
- Select The transaction status from the second dropdown
- Select is from the third dropdown
- Select Failed (decline) from the fourth dropdown
- Click
Continue - Select Send an email from the action dropdown
- Customize the email message with your own text or merge tags
- Example: Hello Team, {{transaction.customer_id}} from {{customer.company}} has had {{transaction.transaction_id}} fail on {{transaction.transaction_date}}
- Click
Continue - Click
Save
Send a contact instructions to set up their customer portal login
- On the custom events slideout canvas, select New custom event
- Select Contact as the object you are working with
- Select is created from the second dropdown
- Click
Continue - Optionally, select your rules for when the event should be triggered
- Leaving the criteria section blank means that the action will always trigger when the event occurs
- Click
Continue - Select Send an email from the action dropdown
- Fill in the To: blank with this merge tag {{ user.email }}
- Customize the email message with your own text or merge tags
- Click
Save
Here's our best practice for setting up the email
- From - (enter the email address you want new the email to be sent from)
- Send an email to - {{user.email}}
- Subject - (enter the subject line of the email)
- Message - fill in your message text
Get an email alert when an ACH or eCheck account is added
- On the custom events slideout canvas, select New custom event
- Select ACH/eCheck Details as the object you are working with
- Select is created from the second dropdown
- Click
Continue - Optionally, select your rules for when the event should be triggered
- Leaving the criteria section blank means that the action will always trigger when the event occurs
- Click
Continue - Select Send an email from the action dropdown
- Fill in {{user.email}} in the To: email address blank
- Customize the email message with your own text or merge tags
- Click
Save
Send automatic emails to select customers
If you have some emails you only want to send to some customers and don't want to use dunning to do this, you can set up a customer custom event.
- On the custom events slideout canvas, select New custom event
- Select Customer as the object you are working with
- Select is created from the second dropdown
- Click
Continue - Optionally, select your rules for when the event should be triggered
- Leaving the criteria section blank means that the action will always trigger when the event occurs
- Click
Continue - Select Send an email from the action dropdown
- Fill in {{user.email}} in the To: email address blank
- Customize the email message with your own text or merge tags
- Click
Continue - Click
Save
Notify different people based on payment success or failure
Let’s say we need to notify different teams based on a payment’s outcome. If a payment succeeds, notify the accounting team, so they can update records and reconcile the books. If a payment fails, notify the sales representative, so they can follow up with the customer and arrange payment.
- On the custom events slideout canvas, select New custom event
- Select Transaction as the object you are working with
- Select is created from the second dropdown
- Click
Continue - Select All from the first dropdown
- Select The transaction status from the second dropdown
- Select is from the third dropdown
- Select Success from the fourth dropdown
- Click
Continue - Select Send an email from the action dropdown
- Customize the email message with your own text or merge tags
- Click
Continue - Select Send an email from the action dropdown
- Customize the email message with your own text or merge tags
- Click
Save
Custom events are very customizable. You could set your custom event up by customer name to allow for more versatility if all the customers you are sending an email to do not have a commonality. You could also group them by shipping address, a custom field you create and more.