Prize wheels

Owned by Tibor Tasi
Last updated: Jun 27, 2023 by Klári Németh
7 min read

Note that there is a module called Prize wheel in the Backoffice which is a non-supported module. Please make sure you have the Prize wheels module enabled.

The Prize wheels module was built to help you boost your loyalty program strategy with further gamification elements. By spending their points, customers can spin the wheel for a chance to win a reward that you have set up using the Rewards module.

In the Prize wheels module interface, you can define the chances to win a certain reward by assigning a percentage rate to each prize wheel slice. You can use the Prize wheel editor interface to configure display and mechanics settings, which can be requested via Entities API so that you can use them to build your prize wheels on the membership site.

When the customer spins the wheel on your end, you need to send an API request to Antavo’s endpoint that will provide information related to the outcome of the spin in the response. When the response is returned, a wheel_spin event will automatically be registered that deducts the points that the customer spent to spin the wheel.

Find the configuration page of the module by searching for the ‘Prize wheels’ item in the Modules menu. The page will open to the list of wheels that you’ve already added. The status of the prize wheels is indicated below the name (active, inactive, draft).

Setting up a new wheel

You can access and display all the below configured information on the membership site through the the Entities API. Please consult your developers to implement the necessary calls.

  • Click the ‘Create new prize wheel’ button in the left sidebar

Name

Add the name of the wheel. If you handle multiple languages in your loyalty program, click the ‘Translate’ button to add translations.

Assets

You can upload two logos, a main logo, and a center logo. Logo images are returned by the API so that you can place them in your prize wheel.

Colors

Four colors (background, font, button, button text) can be selected to design your prize wheel. The hexadecimal color code is provided by the API upon request.

Basic settings

  • Click the ‘Center rotation’ checkbox to enable center logo rotation while the wheel is spinning
    Please note, that as the wheel is built on your end, the effects should be built on your end too, Antavo can only provide the information that the image should rotate or not.

  • Click the ‘Disable reward claim’ checkbox to disable the Reward event to be registered when the customer wins a reward.
    If this option is enabled, the reward customers win won’t be assigned to customers automatically.
    In this case, you may want to set up a workflow that assigns the reward when an event (that would trigger the reward assignment, eg. a custom event of the customer explicitly requesting the reward) is registered. Please make sure that the ‘Reward claim' action in the workflow is configured in a way that the reward is assigned for free.

  • Enter the point price of one spin in the ‘Price’ field
    You can let customers spin the wheel for free by defining 0 point value.

  • Set the time that should pass between two spins of one customer in the ‘Repeat interval’ field
    The repeat interval should be set in the following format: ({number}minute(s)|hour(s)|day(s).
    Leave it empty if customers should be able to spin again anytime without a time restriction being applied.

Mechanics

  • Set the start and end dates for your contest

    • Display ‘coming soon’ before the start date
      If the ‘Display ‘coming soon before start date’ option is enabled, the Display API that lists the available prize wheels for each customer will include this prize wheel with ‘scheduled’ status before the start date.

    • Display expired prize wheel after its end date
      If the ‘Display ‘coming soon before start date’ option is enabled, the Display API that lists the available prize wheels for each customer will include this prize wheel with 'expired’ status before the start date.

  • Restrict the prize wheel to segments
    You can choose to make the prize wheel available for specific customer segments and/or lists only. You can add multiple segments using the dropdown list. This configuration field works with a logical or operator, which means that the prize wheel is accessible to the members of any of the selected segment(s) and list(s).

  • Display prize wheel only for selected segments
    Tick the box if you want to hide the prize wheel from customers who are not in the selected segments.
    If you do not hide the prize wheel, the Display API that lists the available prize wheel for each customer will include the prize wheel with ‘restricted' status to customers outside of the selected segment(s) with the default restriction message.

  • Write a restriction message that tells customers why there are not able to spin at the moment
    This message is returned by the Display API when a POST request is sent to enter the customer into the prize wheel.

Options

The slices of the wheel can be added by clicking the ‘Add +’ button under the ‘Options’ section.

  • Select the slice type
    To make a slice a winning slice, choose the reward option and select the reward set up in the Reward module in the ‘Rewards’ dropdown list that subsequently appears.
    Non-winning slices should be set up with the nothing option.

Please note that in case the customer lands on a winning slice and a stock limitation has been added to the reward, the stock of the reward will be reduced by 1 item. If the reward runs out of stock and the customer lands on the reward slice, the spin will fail, meaning that no wheel_spin event will be registered and the reward will not be assigned to the customer.

Other types of reward limitations will not restrict the customer from winning the reward through a prize wheel.

  • Add the label of the slice
    If you handle multiple languages in your loyalty program, click the ‘Translate’ button to add translations.

  • Define the chance that customers will spin the current slice
    The weights are converted to percentages that are displayed next to the ‘Weight’ field. The sum of the percentage value of all the added slices must be 100% and the weights are automatically adjusted if the weights are adjusted or a slice option is inactivated.

  • Add the text that appears when the customer spins a winning slice
    If you handle multiple languages in your loyalty program, click the ‘Translate’ button to add translations.

  • Set the background and font color of the slice

  • Select the status
    Inactive slices won’t be returned by the API, therefore it may not appear on the prize wheel.

  • Set a spin repeat interval
    This setting defines the time that should pass until the next customer can land on the slice
    In this period the customer cannot land on this slice again.
    The repeat interval should be set in the following format: ({number}minute(s)|hour(s)|day(s)

  • Assign a limit to the slice defining the number of times a customer can land on this slice
    If the customer has reached the limit, or a customer cannot land on this slice again.

  • Select the reward that the customer wins when landing on this slice - only applicable for reward-type slices
    If the ‘Disable reward claim’ option is enabled and the reward is restricted for the customer based on its configured setting, the API will respond with an error message when the custom is entered into the prize wheel and the result is this reward slice.

Points economy

If your brand uses Multi-accounts, select here the account from which the price points should be deducted.

  • Click ‘Save’ at the bottom of the page

Activating a prize wheel

After saving for the first time, the mapping rule is added as a draft, which means the prize wheel will not be available for customers to use and will appear only in the list of prize wheels in the Backoffice.
You can activate the prize wheel right away using the ‘Set active’ button on the upper right-hand side of the setup page and confirm the activation in the dialog that subsequently appears.

Managing prize wheels

Edit a prize wheel

  • Navigate to the Prize wheels page

  • Click the ‘Edit’ button of the prize wheel that you would like to update

  • Edit your wheel settings

  • Save your changes by clicking ‘Save’

Deactivate a prize wheel

  • Navigate to the Prize wheels page

  • Click the ‘Edit’ button of the prize wheel that you would like to update

  • Click ‘Set inactive’ at the top right corner of the page

  • Confirm your choice in the dialog that subsequently appears

Inactive wheels will not be returned by the Display API.

Archive a prize wheel

You have the option to delete inactive prize wheels from the Backoffice by archiving them.

  • Navigate to the Prize wheels page

  • Click the ‘Edit’ button of the prize wheel that you would like to update

  • Click on the ‘Archive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

Archiving is irreversible. Once a prize wheel is archived, it cannot be restored anymore.

© Copyright 2022 Antavo Ltd.