How to Use Custom Events
IN THIS GUIDE
Use the Rule Builder to create custom events that will run on a schedule that you set up. A custom event by itself will only look at the orders in a folder and not take any action on them, however you can create rules to run on your custom events that will take action when orders in the folder match the filters in the rule.
This is ideal for having the Rule Builder watch a timestamp or the order date and then take action when a certain amount of time has passed.
If you are unfamiliar with the Rule Builder, please first see this guide for a brief overview of how rules work.
Create Custom Event
Custom Events can be created in the Rule Builder.
After choosing your Rule Type, in the Event tab, you will be able to create a custom event.
Fill out the details for your custom event.
Give the custom event a unique and easily identifiable name so you can select the event in your rule and view it in your appointments later.
Choose the folder you want the custom event to run on. A custom event can only run on a single folder.
Set how often you want to run the custom event. The minimum repeat time is 5 minutes.
If you need to set the exact date and/or time that the custom event starts to run, adjust that here, otherwise your event will begin to run immediately once created. You can change the time the event runs after it is created from the View Appointments page, accessible from the left sidebar under the Tools menu.
Once you have a custom event, you will need to make a rule that will take action on any orders if the filters match when the event runs.
Late Orders Example
The most common use for custom events is to find orders that have not shipped yet.
For example, if you want to check your Prepared folder every 2 hours for orders that are older than 5 days, you can make a custom event that runs every 120 minutes on the Prepared folder. Create a rule for that custom event that says:
Event: When Custom Event Runs
Filter: If Order Date Created before time -5days
Then set the actions you want to happen, such as moving the order to a different folder or sending the admin an email notification.
To create your rule, in the Event tab, find your custom event from the dropdown, or select it from the available custom events in the lower right corner of the Rule Builder.
For the filter choose If Order Date Created or If Order Date Updated, set the operator to before time, and set the value to negative with the time you want to have passed, such as -5days, -12hours or -2weeks.
Add the actions you want to have taken on late orders. If you want to send the admin an email notification, follow the instructions in this guide for setting up that email template.
Make sure to move the order into a different folder as one of your actions unless you want the same actions to be taken on the order each time the custom event runs while it is still in this same folder and the filters continue to match. Alternatively, set a metadata tag with your rule (example: late|true) and then add an additional filter to the rule to look for that metadata tag on the order (example: If Order Metadata Field late Does Not Equal true). If you need help with this step, please contact Order Desk support.
If you need to set your delay based on an event that happened to the order after it imported into Order Desk, you can add your own timestamps with the Rule Builder. For detailed instructions, please see the How to Work with Timestamps guide.
Why can't I make my custom event more frequent than 5 minutes?
Appointments running more than once every 5 minutes will cause extreme data usage which can impact the performance of the app. For optimum performance, we request that your appointments not be more often than necessary and have found that 5 minutes is an adequate timeframe frequency for most merchants using Order Desk who need to regularly and frequently check their orders with custom events.
If you are looking to automatically refresh orders every few seconds with new information or details using custom events, this may not be the right app for your needs. If this is the case, please contact Order Desk support and we will be happy to provide further advice or assistance for your specific situation.
How do I know which folder my custom event is running on?
It isn't possible to see which folder an event is running on, however when setting up the event, create an Event Name that is easy to understand and reference. For instance, if you are checking for unshipped orders in the Prepared folder, name the event Check Prepared Folder for Unshipped Orders.
When giving your custom events easy to understand names like this, looking at your list of appointments will make a more sense than if your custom events have names like "Custom Event" or "Order Check".
If you aren't sure what folder your event is running on and you need to know, contact Order Desk support.
Can I edit a custom event after it's been created?
Custom events cannot be edited after they are created, with one exception. You can change the time they run (not the frequency) from your store's appointments.
To do this, click on View Appointments in the left sidebar under the Tools menu.
Find the custom event you want to update and click on Edit, then adjust the Next Run Date.
How do I delete a custom event?
To delete a custom event, click on View Appointments in the left sidebar under the Tools menu.
Find the custom event you want to delete and click on Edit, then click Delete Appointment.