Create workflows To create a new workflow, click the Create new general workflow or the Create new campaign button on the sidebar depending on the workflow type you plan to configure. Campaigns require fundamental settings that you need to define before creating the course(s) of workflow(s) within the newly added campaign. In contrast, the general workflow configuration, as there’s no campaign level, starts with defining the Workflow settings right away. Configure campaign settings 📓 Remember, while general workflows define one single workflow running long-term, campaigns can include multiple workflows running in parallel. Enter the name of the campaign Add a description to provide context Set the start date and end date of the campaign in the UTC timezone All workflows under this campaign will inherit these dates. The help text displays the dates converted to the workspace timezone . Max bonus points This value determines the maximum …

Antavo offers the capability to preconfigure multiple authenticated trusted sites in a single interface, streamlining the operation of outgoing webhook messages through workflows. The Webhooks extension introduced the Webhook message workflow action node in the workflow editor. This node features a dropdown menu that enables you to select a preconfigured trusted site authentication, as opposed to the 'Webhook message (legacy)' node, where all details must be added individually. We recommend using this node as it simplifies the process of configuring trusted sites, minimizing the potential for errors. For detailed instructions on preconfiguring multiple authenticated sites, refer to the Trusted sites user manual and the description of the workflow action node . To access the module, search for Webhooks under the Modules menu. The page consists of two sub-menus: Logs and Queue. Logs Here’s the log of the outgoing webhooks. The list provides the following information about each webhook message …

📓 Note that there is a module called Prize wheel in the Management UI which is a non-supported module. Please make sure you have the Prize wheels module enabled. The Prize wheels module enhances your loyalty program strategy with gamification elements. Customers can spend their points to spin the wheel for a chance to win rewards set in the Rewards module . In the Prize wheels module interface, you can assign a percentage rate to each prize wheel slice to define the chances of winning a certain reward. The Prize wheel editor interface allows the configuration of display and mechanics settings, which can be requested via Entities API to build your prize wheels on the membership site. When the customer spins the wheel, you need to send an API request to Antavo’s endpoint to retrieve information about the spin outcome. Upon receiving the response, a prize_wheel_spin event …

Ope Export details On the Export module page, you’ll find a list of previously created exports . Clicking the Details button next to any export item allows you to manage and follow up on your exports using the subtabs. View The View tab opens up first after clicking the Details button on the export listing page. Status You can track the status of the export in the upper right corner. You can find the descriptions of statuses here . Fields The Fields section of the View tab displays the fields included in the export, with the From , To , and Default (if any) values of the fields. Download one-time export files ⚠️ File download is available only if you have selected the download option ( None ) under the Upload target section of the configuration page. Non-scheduled and On-date scheduled export can be downloaded when the status of the export …

The Custom events module provides a solution for registering and rewarding customer actions that are not covered by Antavo’s built-in functionalities. You can define your events in the Custom events module configuration page and send these events through our Events API . Additionally, the module enables you to expand built-in events with extra fields. To find the configuration page, navigate to the Modules menu and search for the Custom events module. The page will display the list of built-in events that have been updated or extended with custom attributes, along with any custom events that have been added, with the following information: Label Name of the event ID Unique ID of the event Built-in yes : the event is a built-in event provided by default no : custom event configured through this module Open custom_events.png Defining a new event Click the Create new custom event …

specify the minimum number of days that a member must part of a club before they can spend club points. - Only applicable if the Burn Eligibility is set to All active members Note that the value must be between 0 and 365 days. Mark the Enable the Limitation of Spending checkbox to limit the amount of club points that a club member can spend. Note that this limitation also applies to the club owner. Next to Limit Reset Type , select the spending limitation logic: The limit will not be reset : Select this option if the point spending limit can only be reached once, after which it will not be reset. Fix date : Select this option to set one or more recurring dates on which the amount of spendable club points is reset. Based on the customer’s first spending event : Select this option to reset the amount of spendable club …

The page within the Security logs tab displays all actions related to login, onboarding, password reset, and multi-factor authentication events for the specific workspace. Open security_log.png When you access the Security logs tab, the page will display the list of logged actions, including the following information: Type : Type of the user action login : Successful login login_failed : Unsuccessful login attempt login_banned : Account banned due to 5 consecutive failed login attempts login_unbanned : Account unbanned 1 hour after being banned logout : User clicked the Logout button mfa_enabled : Multi-factor authentication was enabled mfa_disabled : Multi-factor authentication was disabled onboarding : Newly created Management UI user logged in for the first time password_reset_request : Password reset email was sent to a user password_reset : User reset the password via the password reset email password_reset_failed : Password reset attempt failed password_change : User changed the password …

This tutorial explains how to integrate with Antavo’s APIs, Prize Wheel module, and Rewards module to incorporate a scratch card reward as a gamification feature in your loyalty program. 1. Build the scratch card You can retrieve all the necessary information to build and display the scratch card reward on the loyalty membership site through Antavo’s Entites API. Please refer to the specific endpoint to call in our API documentation . 2. Create prizes through the Rewards module You can configure the prizes that customers can win by scratching a card as a reward using the Rewards module. To create a reward, click Create a new reward under the Rewards module.  Open dh3QhvINC9dghAsFX2LExM327ph4z4Rf8a_3nTah_D-HuCnob2yPp0eBhTGKLKyueQ06vK7prDC1MTQYt8k9eCXnM-43lPyo89g0tvHJAa-wi3SLCpENy3a_QP5pY6MN8lYJMvqygzF5fZpAnvc You can choose from various reward types according to your needs. You can find the configuration steps for each reward type in our user manual . Regardless of the number of …

To enhance your ability to increase average order value, frequency of purchases, and total spend, we designed workflows to empower you to fine-tune purchase incentivization in your webstore. You can set up periodic campaigns to offer your customers the opportunity to earn bonus points with qualified purchases. Our filters help you target specific customer segments, allowing you to personalize your campaigns. The cases we will explore in this article: Case 1: Encourage customers to purchase from a specific product category Case 2: Give new registrants double points for purchases made Case 3: Give a bonus tier upgrade for making a purchase with a minimum basket value Case 1: Encourage customers to purchase from a specific product category Introducing a new product category is an exciting opportunity to engage customers and attract new ones. To achieve these goals, we will implement a month-long campaign consisting two distinct workflows: Double …

soon’ before the start date If enabled, the promotion will be added to the API response even before the issuance start date. Display the promotion only for the selected segments If this option is not disabled, the promotion will be added to the API response even if the customer is not eligible based on segment restriction. Set the inventory size The number of promotions available to be assigned per customer or globally. For example, if you want to assign the promotion to one specific customer only once a day, set the issuance frequency to 1 per day. Set the issuance frequency Specify how often the promotion can be assigned to a specific customer per day, per week, per month, or per year. For example, if you want to assign the promotion to one specific customer only once a day, set the Issuance frequency to 1 per day . Specific settings of …

corner of the pass. Upload the strip image The strip image is displayed under the logo and the header field, behind the primary fields as a background image. The image will be center-cropped if it is too large. For Apple passes, it’s also possible to upload retina (HiDpi) images to improve the visual quality of passes. It depends on the resolution of the customer’s mobile device if the standard or the retina assets are displayed. While uploading standard assets is mandatory, adding retina assets is optional. Asset size requirements: Asset Standard resolution asset size Retina resolution asset size Icon image 29×29 pixels 58×58 pixels Logo image 160×50 pixels 320×100 pixels Strip image event tickets 375×98 pixels 750×196 pixels gift cards, coupons 375×144 pixels 750×288 pixels other 375×123 piels 750×246 pixels On the Pass Template editor page, oversized …

added as literals (e.g., if you set ' @##COUPON ’, a generated coupon code could be G11COUPON or T35COUPON). If you would like to assign a generic coupon code to all customers, don’t use pattern characters, only literals (e.g., if you set SPRINGCOUPON , all coupons codes to each customer claiming the reward will be generated as SPRINGCOUPON ) Remote: If you prefer to manage coupon distribution on your end, you can set a callback URL endpoint to provide Antavo with the coupon codes to assign. If you need us to serve your endpoint with the pattern, you can define it here. Set a minimum basket value restriction Set a coupon expiration time Period: The coupon expiration date will be dynamically set when the coupon reward is claimed and assigned to the customer (e.g., 1 week , 2 months , etc.) Specific date: The expiration date is a predefined date (e.g …

Use Customer Insights to get actionable information about your loyalty members and their activities in your loyalty program, as well as to manage customer profiles. The built-in segmentation scheme facilitates targeting customers with personalized offers. Customers page To access the Customer insights menu, click on the customer icon located in the sidebar. This action will redirect you to the Customers page, where you can view the current list of customers enrolled in the loyalty program. The searchable list provides the following information: Name Name of the customer If the customer is suspended, their status will be indicated here. Email address Email address of the customer You can alphabetize the customer list by clicking this header. Score Number of points earned Spent Number of points spent Expired Earned points that expired without being spent Spendable Number of points currently available to spend Last login The last time the /auth endpoint …

document. Selecting the data source 📓 Providing a data source and the procedure of importing historical transactions varies from the processes associated with other data models . While other data models support both CSV and JSON formats, the Historical transactions data model supports JSON files exclusively . CSV files cannot be used for this purpose. To learn about the whole import procedure of historical transactions, see the Importing historical transactions section of this document. In the Source dropdown field, you’ll need to select the source from which Antavo can access the import file. Here are the available options: Upload : You can upload the CSV or JSON file directly by selecting the file using the Choose file button in the Filename fields. You can download a template CSV file or JSON file containing all the necessary fields by clicking the name of the corresponding file extension. Please note, that the import of …

The Multi-language module enables you to translate all the copies related to loyalty program functionalities, allowing you to display them on the membership site according to customers' language preferences. Please contact the Antavo Service Desk if you need to add a new language to your loyalty program. Once the language is added, you can start translating texts in the Management UI. Translate the membership site If you use Antavo’s iframe solution to display the membership site on your website, you can use the Translations tab of the Settings page to translate texts to all available languages in your loyalty program. Translate module-related text Use the Translate button next to each text field to input your translations in the pop-up that appears. Any translations you enter will be incorporated into the response provided by the dedicated API endpoint . Currently, the Translate buttons are accessible in the following …

The Social follow module helps increase the number of your social media followers by offering incentives for members to follow your Twitter account or connect their Facebook profiles with the loyalty program. Enabling Twitter follow or Facebook connect activity adds a new card to the membership site. To access the module configuration page, search for Social follow under the Modules menu. The page will open to the configuration interface to configure incentives for Facebook connection and Twitter follow actions. Enabling Facebook connect To collect profiling data, you can ask customers to connect their Facebook accounts . The data provided by Facebook will be stored in customer attributes and used for various purposes. ⚠️ As Facebook is restricting third parties' access to customer data, Antavo can only retrieve age-range information from customers’ accounts. To enable this point-earning option, ensure your Facebook app is connected to your Antavo workspace under the …

the referrer’s point balance. If you use marketing automation to send loyalty program notifications, you can trigger an email by adding a Trigger Marketing Communication action at the end of the workflow to inform the referrer that they have unlocked a reward through a successful referral. Remember to save and activate both of the configured workflows. If you require further information on workflows, read our Workflow articles . 5. Test the referral reward flow After you have added the referrer ID to the Optin event and defined all the mechanics in the Management UI, you can begin testing. You should send two API events, both to be registered in the Events history of a referred test customer. An Optin event with having the Referrer field populated with the ID of the referrer test customer. A Checkout/Checkout accept event to register the completed purchase. If the mechanism is configured …

The Club Applicant Refuse event is automatically registered when a club applicant is refused, and it is displayed on: the club’s Event History page the Events page of the club member The customer’s membership status changes from applicant to removed . Refused and removed customers disappear from the default view of the Club Members list, but you can filter the list by status to display them. Refuse and ban a club applicant You can refuse a club applicant’s request and ban them to prevent them from requesting to join the club in the future: In the list of clubs, click the hamburger button at the end of the row of the club whose members you want to display. Click Club Members . Click the hamburger button at the end of the row of the club member whose request you want to refuse. Click Refuse joining request . Confirm the …

customer field (eg. {customer.referrer} ) instead. Define the coupon code to be transferred You can add a specific coupon code or use a variable (eg. {event.coupon_code}) instead. The Coupon transfer action registers a Coupon receive event in the event history of the recipient. Push notification EARLY ACCESS Sends push notifications to a specific pass saved on the customer’s device. Select which wallet pass should be the subject of the notification Add a message that will pop up on the screen You can insert variables (eg. {event.coupon_code} , {customer.first_name} or volt expressions in the notification. Pass Lookup EARLY ACCESS Looks up a customer pass or passes and adds the pass ID(s) to the transport, so that the template of the pass(es) can be modified through a Switch Pass Template node later in the workflow. Select the search method: Pass ID: Enter the ID …

mParticle is a customer data platform (CDP) for omnichannel consumer brands, facilitating customer data management throughout the entire customer lifecycle. Its integration with Antavo enables brands to effectively synchronize customer data and actions. This document outlines the process of configuring the two-way connection between the two platforms to enable seamless field and event synchronization. Additionally, two use cases will be briefly discussed to demonstrate the key functionalities of the integration. To access the configuration interface, navigate to the Modules menu and search for mParticle integration in the list. Setting Up Antavo with mParticle This connection allows data to flow in both directions, ensuring accurate customer data management. To enable data synchronization between Antavo and mParticle, access credentials are required for configuration at the appropriate locations. Enabling Antavo in mParticle Navigate to Directory in mParticle Search for the Antavo Loyalty Cloud and click Setup Select the integration type(s) based …