The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.
With the out-of-box functionality of the Friend referral module, you can define a referral system that rewards referrers with bonus points upon the first purchase of the friend they invited to join the loyalty program. However, there might be cases, when instead of points, you may want to reward the referrer with a coupon or any other type of instant benefit. This tutorial guides you through the steps of using the Workflows functionality, the Rewards and Custom events modules, and the Events API endpoint to introduce this mechanism in your loyalty program.
...
| Info |
|---|
Prerequisites Friend referral moduleIf you haven’t used the Friend referral module in your loyalty program yet, please contact us through Service Desk to enable it and set up the basic configuration for you. This is essential, as the Friend referral module is the one that establishes the relationship between the referee and referrer through the built-in ‘Referrer’ attribute of the customer entity. Referral tracking systemAlso, make sure you have implemented a tracking mechanism in your website environment that is capable of handling invitations and recognizing customers as referrers and referees. |
...
A new reward can be created in the UI by clicking on ‘Create a new reward’, under ‘Rewards’.
You can choose any of the reward types according to your needs, you can find the steps of the configuration of each reward type in our user manual.
...
A new event can be created by clicking on ‘Create a new custom event’ under ‘Custom events’.
When creating the event, please make sure to keep the value of the ‘Points’ field ‘0’ to ensure no points are added to the referrer’s point balance when the event is registered.
...
You can find further information about the configuration of customer events in our user manual.
...
4. Set up the workflows
Referral registration workflow
...
Start by adding the 'Event' trigger to the canvas, which will be a ‘Checkout’ or ‘Checkout accept’ event, depending on whether you handle a return period for purchases or not.
To the ‘action’ (lower) branch of the trigger node, connect a ‘Customer attributes’ filter.
...
Don’t forget to save and activate both of the configured workflows. If you need a deep dive into workflows, read our articles /wiki/spaces/DOC/pages/445546994 here.
...
5. Test the referral reward flow
...