Menu Close
Apps

    Rewards

    Documentation for Gleam Rewards app

    Getting ready to run your first Reward? In this doc we'll take you step by step through the setup process, plus give you some tips and tricks to get the most out of your campaign.

    🧙‍♂️ Not sure what Rewards are? Check out our Rewards Overview first

    Rewards Widget

    The rewards widget is what you will expose to your customers, it's an interface between them and the reward that you have setup. Between the users and the reward you'll have actions that need to be completed in order to unlock it. You can choose how many actions you require before it unlocks.

    Before Reward Is Unlocked

    Before the Reward unlocks the user will see the widget like below.

    Reward widget in locked state

    1. Title of your Reward, this is configurable during setup
    2. Feature image, this is the main call to action for the reward that you will design
    3. Description, you can add a description here or let us generate one automatically for you
    4. Actions, this is a list of actions that you'd like the user to complete
    5. Unlock status, if still locked we'll show the users how many more actions they need before the reward will unlock

    After Reward Is Unlocked

    What happens after the Reward is unlocked depends on which type of Reward you setup. You can test one of each below.

    Coupon Code

    Download

    Link

    Redirect

    Creating a Reward

    To create a Reward you will first need to add a site. Each site has access to our apps & you can switch between your sites using the site navigation dropdown in the left menu.

    Multiple sites have the following advantages: You can keep your data separated, ensure your campaigns are branded from that site & also allows you to have site specific integrations.

    You'll need to use the following steps to create a Reward:

    1. Make sure you have selected the correct site
    2. Click on the Rewards tab in the left navigation
    3. You will need to be on a paid Rewards plan to start creating your Reward
    4. Click on the New Reward button on the top right

    If you have a Competitions plan already you can add Rewards to your plan by upgrading to a Package.

    1. Reward Setup

    Once you start a new reward you are taken to the setup tab. This allows you to configure some of the basic settings for your campaign.

    Setting up your Gleam Rewards campaign

    Reward Name

    This is a name that helps identify the reward. This doesn't appear in the widget at all, but may appear in any activation emails the customer receives, so please name it something recognisable like "Gleam 25% Discount Coupon"

    This name will also determine the URL that gets generated for your default landing page:

    https://gleam.io/H5eC0/gleam-25-discount-coupon

    Start/End Date

    Use our easy date picker to set custom start & end dates for your reward. Clicking the green time icon will allow more granular time settings by hours/minutes.

    Enter start & end dates with the datepicker

    End dates for rewards are optional, the campaign will end either when you run out of claims or when the end date is reached.

    Timezone

    It is important to ensure the competition runs in a specific timezone, this can be completely independent from the default timezone you setup in your User Settings (by clicking your Name in the sidebar).

    Choose a timezone from the dropdown menu

    We use Javascript to check the user's current time settings when redeeming the reward.

    Adding Custom Terms & Conditions

    If you need to add terms & conditions to your reward you can add them here. Users will be able to read them from within the widget before redeeming.

    The terms & conditions use our WYSIWYG editor or basic HTML for formatting, you can also include links, headers, paragraphs or line breaks to format things as you need:

    Add custom terms & conditions with the WYSIWYG editor

    Which will look like this when a user clicks on them inside your reward:

    Terms & conditions displayed in Rewards widget

    Custom Styles

    On the business plan you can add custom CSS to your Rewards. You can use this to control almost any element inside the widget that you want, any styles added during campaign setup will affect this campaign only.

    Add custom CSS to your Rewards widget

    You can set global CSS Styles to apply to all your campaigns in your Site > Settings > CSS

    Event Mode

    Event Mode enables a special state for the widget that allows you to use it for events if you are getting users to redeem from shared wifi, shared devices or internal corporate internet.

    This mode:

    • Doesn't use Cookies to keep users logged into the widget
    • Automatically logs users out based on activity or if you simply refresh the page
    • Reduced fraud filter settings to allow entries from the same IP and device
    • Social Logins will have reduced functionality due to the lack of Cookies, so you should avoid these Actions

    This mode should only be used if you are at a live event with users entering from the same device. It will have unintended and consequences (and probably annoy users) if you enable this on a standard web based campaign.

    Allowed Locations

    By default your reward will be available to anyone in the world, you can restrict or allow entries to specific countries (not cities) using this setting.

    Configure locations that are allowed to enter your Rewards campaign

    If a user views a Reward that is country restricted this is what they will see:

    We use MaxMind to determine the country of the user. On rare occasions the MaxMind database can allocate IPs incorrectly, if that happens you can get users to test their IP here & submit a change request.

    Supported Languages

    We support 27 languages out of the box. Choosing your preferred language here will ensure the widget is translated into that language (this also includes emails).

    Note: We do not translate the default text in actions that require text input. Just those that have fixed text like Tweet on Twitter or Instagram Visit.

    You can translate your campaign into any of our supported languages using the Language field in the Setup tab of your Rewards campaign.

    Change the language with dropdown menu

    Widget Text Overrides

    You are able to change any text within our widget. To change the text, simply add the key for the text and a value in quotes (it uses YAML layout). When adding text with quotes use \". You only need to add overrides - don't paste the whole file in.

    In the reference bundle, you see this:

     reward_confirmation_opening_singular: "You have successfully unlocked "
 reward_coupon_data_prefix: "Your coupon to redeem this reward is below:"

    To change them, add this to the Widget Text Overrides:

     reward_confirmation_opening_singular: "Thanks for unlocking "
 reward_coupon_data_prefix: "Your coupon to get 10% off your order is below"

    You can add HTML to the overrides easily enough:

     unlock_heading_plural: "<i class='fas fa-lock'></i> You can get %{count} more entries - <a href='https://gleam.io'>I'm a link</a>"
 notify_other: "<p style='font-size:10px'>Sign me up to the weekly comp email, thanks (optional) - <a  href='https://gleam.io'>I'm a link too</a></p>"

    And here's what it looks like in the Gleam UI:

    Customise display text with widget text overrides

    The full list of text that you can override is in this downloadable file:

    View Text Overrides List

    2. User Details

    Rewards by default are Anonymous, unless you specifically have an action that captures user details.

    You can see below the typical flow to complete a reward by answering a question.

    In the Actions tab you will see the data for the completed action, but the user will be Anonymous:

    An anonymous user in the redemption log for a campaign

    If a user attempts to redeem a Reward action that requires details then they will see a form. You can also make capturing details mandatory by enabling the Capture Contact Details option.

    Force users to enter their email with Capture Contact Details option

    If the entrant authenticates with a social network, then we'll prefill as much of the information above as the network will give us. For example, Facebook gives us their email address to prefill, Twitter doesn't.

    On our business plan you can also add additional custom fields to this form & also notify users that subscribe to your competition notifications.

    Minimum Age

    If you require that your users meet a minimum age requirement then you can select from multiple options on this dropdown. We support both UK & US formatted DOB.

    This will add an extra field onto the user details form:

    Date of Birth field in the Gleam widget

    Require Login Before Actions

    By default the Rewards widget will show all of the actions a user can complete to unlock. You may want to force the user to login or provide details first before they see how to redeem.

    You can see an example of this functionality below (ensure that you are logged out of the widget):

    Please note that for Rewards you must also have the Capture User Details option enabled for this to work.

    Capture User Details

    If you choose to capture user details, then the widget will prompt users to enter their email address.

    Name & Email fields in the Gleam widget

    This will then make any data in the backend associated with the user claiming your reward:

    User details are captured in the redemption log for a Rewards campaign

    Login With

    Getting users to login to the widget with Rewards is not as important as it would be with Competitions. However you still have a number of ways to customise this particular flow.

    Default

    This is the default behaviour of the widget, all the login options will be selected. The user will see these displayed at the top of the Reward:

    Default login options for Gleam Rewards

    Adding More Login Options

    Add more login options to your Rewards campaign

    Using Require Login

    Require Login allows you to prompt the user to login before they see the available actions required to claim your reward

    This option can be useful in many different ways, for example say you're targeting Facebook users only and want each users to Login with Facebook only. It allows you to control the login type completely.

    Single Login Type

    You can ask users to login with a single social network (i.e. Facebook or Instagram). This is particularly useful if your contest is focused on a single social network.

    Force all users to login through a Facebook account

    Multiple Login Types

    If you choose multiple login types, then users will be able to select which one they prefer to login with.

    Allow users to choose a social media login

    Custom User Details Fields

    You can control what extra details you collect from users during signup on the Business plan. Please note that this additional data does not currently sync with mail providers.

       View Custom Fields Configurations

    3. How To Redeem

    We currently support a range of actions that you can use to allow users to redeem your Reward. You will need to find a balance of what you are asking a user to do versus what you are giving them to redeem.

    Simply select one of the supported actions from the list:

    List of supported redemption methods for Gleam Rewards

    We support the following actions with Rewards:

    Actions Required

    You can use the Actions required option to lock certain actions until a designated number of other actions have been completed.

    Actions required feature for Gleam Rewards

    You can use this to encourage users to complete certain actions with the incentive of unlocking additional actions and entries.

    In this example you must complete each available action in order to unlock the subsequent action:

    Actions required is available to use for the following actions:

    4. Reward

    Once you've created all of your redemption methods you can now add your coupons into Gleam.

    Enter details for your Reward

    Reward Type

    Rewards currently has 4 types you can choose from:

    Name / Title

    This will appear in the header of your coupon when they load it. So try to make it as descriptive about the discount as possible (i.e. 10% Off Your Order).

    Actions Required to Unlock

    Your Reward is considered claimed once a user completes the required number of actions set here to unlock it.

    For example:

    • If you set this to 1, then 1 action is required for the reward to unlock
    • If you set this to 3, then the user must complete 3 actions

    You need to consider the value of your offer against the number of actions you're asking a user to complete. It's possible to require the user to complete too much which will impact your conversion rates.

    Description

    You can choose to either leave this blank & have us auto generate it based on the number of actions needed to unlock. Or you can write a description in here.

    You can see what your reward will look like once you've added a Title a Description below:

    Feature Images

    Adding Feature Images to your reward allow you to add visual appeal:

    Feature Image Slider

    On Business plans and above you can upload up to 5 images to your Prize area in a slideshow format.

    Upload up to 5 images in the feature image slider

    The slider is set to automatically switch between the Prize images or users are free to move backwards anf forwards using the forward/back arrows:

    Reward Codes / Links

    This it the area that you add your reward. You have a few options depending on which reward type you select.

    Coupon Code

    If your Reward is a coupon or code of some sort then you can enter in your code into this field. If you add a single code then every user that redeems the reward will see that code.

    Enter a single, reusable coupon code

    Multiple Coupon Codes

    If you want to use unique coupons for each user then you need to add comma separated codes into the field, this will limit the total number of claims for the reward to the number of codes that you enter.

    Enter multiple, one-time-only coupon codes

    Downloads

    A download should be a link to a direct file that you intend to give the user. It could be a zip, mp3, pdf or something else.

    Enter the URL for a downloadable file

    Multiple Download Links

    You can provide unique download links by comma separating them, this will limit the total number of downloads for the reward to the number of links that you enter.

    Enter URLs for multiple downloads

    Link / Redirect

    A link or redirect should link to the end location that you want to send your user to.

    Enter a URL for redirecting

    Multiple Links/Redirects

    You can provide unique redirect links by comma separating them, this will limit the total number of claims for the reward to the number of redirect links that you enter.

    Enter multiple URLs for redirecting

    CAPTCHA

    We also use certain attributes to challenge certain users with a CAPTCHA. This option has a few modes for you to select:

    Automatic: Our smart Fraud filter will automatically challenge users

    Always: Always prompt users with a CAPTCHA

    Never: Never prompt users with a CAPTCHA

    Number of Claims

    Number of claims are restricted by each unique IP address. If you are distributing a single coupon code or link, you can use this setting to limit the number of times the Reward can be claimed. If you leave this set at 1 then the reward will expire after 1 redemption.

    If you entered multiple codes or links, this setting will be disabled. Instead, the number of claims will be limited by the number of codes or links that you enter.

    5. Post Redeem

    Display Reward in Widget

    This is the default option for all Rewards, it allows you to display your reward directly in the widget once the user has met the requirements:

    The Reward link or code is displayed in the Gleam widget

    You must use this option if you allow users to redeem your reward anonymously.

    Default Post Redeem Notification Email

    If you collect user details and have the notification email enabled than users will receive a post redeem email. This email will display the unlocked reward to the user.

    If you select a language other than English this email will send to the user in your selected language.

    Post-redemption email for Gleam Rewards

    Custom Emails

    Business customers have the ability to send custom emails to users that redeem a reward. We have a nice WYSIWYG editor that you can use to build or preview the email.

    Customise your post-redemption email in the editor

    There's also a bunch of tokens that you can use to dynamically replace data inside the email:

    • CAMPAIGN_NAME
    • CAMPAIGN_LANDING_PAGE_URL
    • CAMPAIGN_END
    • CONTESTANT_FIRST_NAME
    • CONTESTANT_FULL_NAME
    • CODE
    • CURRENT_REDEMPTIONS_LIST
    • UNSUBSCRIBE
    • UNSUB_URL

    We give you the ability to test what the email will look like before your campaign goes live.

    Preview of the post-redemption email

    Pixel Tracking

    Pixel Tracking allows you to fire tracking pixels from one of our supported providers.

    Connect your Rewards campaign with our pixel tracking integrations

    We currently support:

    Adroll

    This will allow you to fire an Adroll retargeting pixel when a user triggers an impression or view on the campaign.

    Facebook Pixel

    To set up Facebook Pixel Tracking you will need to follow these steps:

    1. Go to the Events Manager in your Facebook Business Suite.
    2. Click Connect Data Sources (the green plus icon in the sidebar).
    3. Select Web > Facebook Pixel.

    Set up a Facebook Pixel in Events Manager

    1. Name your Pixel and add your website URL.

    Configure your new Facebook Pixel

    1. Navigate to your Data Source's Settings to find the Pixel ID.
    Find the Pixel ID for your new Facebook Pixel
    1. In the Post Entry tab of your Reward, select Facebook Pixel under Pixel Tracking and add your Pixel ID.
    Add your Pixel ID to gleam

    The Facebook Pixel has three options:

    • On load: This will fire an Impression for all users that view the campaign (good for Retargeting or Custom Audiences)
    • Conversion: This will fire a Lead for all users that enter the campaign (good for tracking Conversions)
    • On load + Conversion
    Choose a trigger for your Pixel ID

    You may need to create a Custom Audience based on the Gleam data to track Facebook Conversions in your campaigns.

    We will send the same event_id for all events on Facebook Pixel and Facebook Conversions API, so no events will be duplicated even if both methods are connected to the one Pixel.

    Facebook Conversions API

    To set up Facebook Conversions API Tracking you will need to follow these steps:

    1. Go to the Events Manager in your Facebook Business Suite.
    2. Click Connect Data Sources (the green plus icon in the sidebar).
    3. Select Web > Conversions API.

    Set up Conversions API in Events Manager

    1. Name your Pixel and add your website URL.

    Configure your Facebook Pixel

    1. Navigate to your Data Source's Settings to find the Pixel ID.
    Find the Pixel ID for your new Facebook Pixel
    1. Scroll down the Settings until you reach the Conversions API heading and click "Generate access token" to access your Pixel Token.
    Generate an access token for your Pixel Token
    1. In the Post Entry tab of your Reward, select Facebook Conversions API under Pixel Tracking and add your Pixel ID and Pixel Token.
    Add Pixel ID and Token to the Post Entry tab

    The Facebook Conversions API has three options:

    • On load: This will fire an Impression for all users that view the campaign (good for Retargeting or Custom Audiences)
    • Conversion: This will fire a Lead for all users that enter the campaign (good for tracking Conversions)
    • On load + Conversion
    Select a Conversions API trigger

    We will send the same event_id for all events on Facebook Pixel and Facebook Conversions API, so no events will be duplicated even if both methods are connected to the one Pixel.

    The Facebook Conversions API is not affected by Ad Blockers or Apple's iOS 14 Requirements.

    You may need to create a Custom Audience based on the Gleam data to track Facebook Conversions in your campaigns.

    Twitter

    This will fire a "Signed Up" conversion for all users the enter the campaign.

    Post-Redeem Webhook

    The Post Redeem Webhook allows you to send all entry data from the Reward to your own endpoint, this option is available on Premium plans only.

    Learn more about the type of data we send and the format below:

    Webhook Setup Docs

    Reward Installation Methods

    There's a few ways that you can install your reward:

    Run in a Tab

    This is the most common way to expose users to the offer, you can run a tab across your entire site that's is activated by the user clicking on it.

    There's two options currently for your tab, you can choose our own default design or you can upload your own image. You can then choose which location on the page you want the tab to appear.

    Example of Tab

    Display your Reward as a tab in your website

    When Clicked

    Reward widget expanded in your website

    Embed in a Page

    Reward widget embedded on a webpage

    Hosted Landing Page

    Reward widget in a hosted landing page

    Adding to a URL on Your Own Site

    If you have already setup your Hosted Landing Page like above you can mirror this page onto any URL on your own website using iFrames.

    You can follow the specific Adding to a Page Guide here.

    Sending Users To Your Landing Page Via QR Code

    You can drive traffic to your Rewards campaign's landing page from a physical location by using your Reward's unique QR code. All you need to do is display or distribute your QR code and users will be able to scan the code and enter your campaign directly from their mobile devices.

    You can find your campaign's QR code under the Promote tab:

    Unique QR code for your Rewards campaign

    Add Rewards Campaign to Linktree

    You can add your Rewards campaign to your Linktree to increase campaign awareness and drive entries.

    Install Gleam Rewards on Linktree

    Display Preview of Gleam Reward on Linktree

    All you need to do is go to the Promote tab of your Rewards campaign and select Add This to My Linktree.

    Add Reward to Linktree From Promote Tab

    You will then be prompted to login to your Linktree account. Once you have done this your Rewards campaign will be added to your Linktree where you can further customize your link.

    Add Gleam Rewards to Linktree

    You can customize your link by:

    • Changing your link's text.
    • Choosing your link's behavior to determine if visitors who interact with your link see a campaign preview or get taken directly to your campaign.
    • Toggling the display of your campaign's feature image.

    Rewards Drafts

    When you are setting up a Rewards campaign Gleam will autosave your progress as a draft. If you exit your Rewards setup before you have successfully saved your campaign it will be saved as a draft so you don't lose your progress.

    Your progress is automatically saved as a draft

    If you want to exit your Rewards setup without saving your progress as a draft all you have to do is click the 'Cancel' button.

    Accessing Your Rewards Drafts

    You can easily find your drafts in your Rewards dashboard under Draft Rewards.

    You can click a draft to continue editing the campaign, or click Discard to delete the draft.

    Access campaign drafts from the dashboard

    Coupon Tips & Tricks

    Auto Loading Coupons

    If you choose the tab installation method by default the user has to click the tab in order for the coupon to load. However you can send users to a URL with a special gleam hashtag to auto load the coupon on entry.

    http://www.yourwebsite.com/#gleam

    Number of Actions

    Play around with the number of actions required to unlock a specific reward, generally we see conversion rates decrease progressively the more actions you add. But it also depends on the value of the reward.