Versions Compared

Version Old Version 4 New Version 5
Changes made by

Lopes da Costa, Valentina

Lopes da Costa, Valentina

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents

Table of Contents
stylenone
Info

This guide will run through how to configure a Brame gamification campaign and how it shows in the RBI app. Please ensure your market has a valid contract with Brame and reach out to your designated CSM to setup a new contract.

How does it work?

RPReplay_Final1713883139.MP4

Events

Event Name

Trigger

Type

Properties

Offer Assignment

When a prize offer is assigned to a user

BE

  • Status: successful or error

  • Partner: [Partner name, e.g. Brame]

  • Duration (ms): Time to assign the offer

  • engineID: Loyalty engine ID of the offer

  • Reference: Optional field where the partner can send the reason for the request (E.g. Whopper Prize)

  • UserId: Loyalty Id of the user

  • ErrorDescription (only if status=error): The specific error that happened during assignment

Loyalty Points Assignment

When a prize loyalty points is assigned to a user

BE

  • Status: successful or error

  • Partner: [Partner name, e.g. Brame]

  • Duration (ms): Time to assign the offer

  • pointsEarned: How many points the user earned

  • Reference: Optional field where the partner can send the reason for the request (E.g. 100 LPs Prize)

  • UserId: Loyalty Id of the user

  • ErrorDescription (only if status=error): The specific error that happened during assignment

Info

Currently it is only possible to assign points to user’s. RBI API allows to deduct points but further integration work needs to be done by Brame

How to configure it?

  1. Create an iFrame campaign in the RBI app that redirects users to Brame iFrame URL. Please follow this guide: /wiki/spaces/EGMT/pages/4023648754

  2. Login to your Brame dashboard: https://app.brame-gamification.com/login

  3. In Brame dashboard home screen, click on Configuration Icon

image (199).png

  1. Click on Results

In the Wheel section you can configure the background color that will show for each prize in the spin the wheel game. If you are leveraging a different game with Brame, then this will not be relevant.

image (200).png

IMG_1450.png

  1. In the Results section configure all the potential prizes, image and description when the user wins that prize

image (201).png

  1. When the user clicks on editing a prize they can configure a prize that assigns loyalty points and click on Save. This will show in the app after the user has spun the wheel and won a prize. In the Brame dashboard operators can configure:

    1. Result Title – this is the internal name used to identify this prize

    2. Image – this is the image that shows when user wins this prize

    3. Result Description – this is the description that shows when user wins this prize

    4. Integrations – for assigning loyalty points this needs to be set to BK Points

    5. Identifier – this is the identifier that is sent to the app and that will be seen in reporting of the campaign to understand which prize and which campaign was sent from Brame

      1. This will correspond to the Reference property in the Loyalty Points Assignment event

    6. Value – this is a number that represents how many loyalty points will be assigned to the user.

      1. This value will show up in the pointsEarned property in the Loyalty Points Assignment event

Info

It is also possible to set up a raffle or conditions for users to enter. Just need to set Value to 0 so users do not earn any loyalty points and then in the Identifier input the reference field you want so it’s easily identifiable in the engagement tool to be able to assign to the user the raffle prize or any specific prize you have set up in your canvas.

image (202).png

IMG_1456.png

  1. When the user clicks on editing a prize they can configure a prize that assigns an offer and click on Save. This will show in the app after the user has spun the wheel and won a prize. In the Brame dashboard operators can configure:

    1. Result Title – this is the internal name used to identify this prize

    2. Image – this is the image that shows when user wins this prize

    3. Result Description – this is the description that shows when user wins this prize

    4. Integrations – for assigning loyalty points this needs to be set to BK Offers

    5. Identifier – this is the Loyalty Engine ID of the offer from Sanity. This corresponds to the offer that will be assigned to the user if they win this prize.

      1. This will correspond to the engineID property in the Offer Assignment event

The offer needs to be a Config Offer personalized (or config) offer so that the offer only shows to the user after the user plays the Brame game and wins an offer. More information on config offers here: Config Offers Follow this guide to create the offer: Offers - Configuration Guide

  1. Value – this is the identifier that is sent to the app and that will be seen in reporting of the campaign to understand which prize and which campaign was sent from Brame

    1. This will correspond to the Reference property in the Offer Assignment event

Info

WIP by Brame to reflect the Reference, engineID and Points Earned in the Brame FEdashboard

Note

If the Offer is not correctly configured in Sanity or if the offer PLUs are not available in the POS system of the market, then the offer will not show in the offer list of the user.

image (203).png

IMG_1452.png

  1. If the user in the app is wins loyalty points, then the user will be redirected to the homepage and the new loyalty point balance will be seen immediately. If the user in the app wins offers, then the user will be redirected to the offer list page and the won offer will appear on the top of the offers list.