Admin loginSmartico.aiTheAffiliatePlatform.com

▪️Gamification activities in the communications

This document describes how to inform players about gamification related activities using different communication channels

Building campaigns for gamification activities

All the gamification blocks like missions, tournaments, levels, store, mini-games, jackpots etc are generating events that are related to the user interaction with the system. For example, purchase in the Store will generated "Gamification: store purchase succeeded" event. You can find full list of such events below.

You can build a marketing campaign that is notifying user about such activities as shown on the screens.

Using tags inside the communication assets

Each event also brings details the can be used in the content of the communication, for example tag {{event.meta.name}} will contain the name of the purchased item. This way you can build a communication like "Thank you for purchasing {{event.meta.name}}"

All the content in the tags is taking into account language of the user and branding details that you can setup as part of the Store item.

Another example for the case when operator would like to send a rich body inbox to the user stating that player has unlocked a new mission. The operator would like to let the user know that player just unlocked a new mission, congratulate him/her on the achievement and encourage the user to keep going by sharing some details on the newly unlocked mission.

Example:

<body>
    <div>
        <span><h2>Congratulations, you just unlocked a new mission {{event.meta.name}}</h2></div>
	</div>
        You have unlocked {{event.meta.name}} mission via: <br />
        {{event.meta.unlock_mission_description}}
        <br />
    <span>
        <img src="{{event.meta.image_url}}" align="left" /> Short description of the mission: <br /> {{event.meta.description}} <br />

        Do not miss it as compeleting {{event.meta.name}} will grant you {{event.meta.reward}}! <br />
    </span>
        <span class="small">Terms and conditions can be found here:<br />{{event.meta.hint_text}}</span>
</body>

Available tags

Store

Event: Gamification: store purchase succeeded (shop_item_purchase_successed)

Event is sent to user when he completes purchase in the store

Column
Type
Note

{{event.meta.price}}

int64

The price of the purchased item in points

{{event.meta.name}}

string

The name of the purchased item

{{event.meta.description}}

string

The description of the purchased item

{{event.meta.image_url}}

string

The URL of the purchased item icon

{{event.meta.hint_text}}

string

The terms and conditions of the purchased item

{{ event.int_param1 }}

string

The URL populated in the 'Integration Parameter' field of the store item

Missions

Event: Gamification: mission unlocked (ach_achievement_unlocked)

Event is sent to user when he unlocks mission

Column
Type
Note

{{event.achievement_id}}

int64

The mission id of the unlocked mission

{{event.meta.reward}}

int64

The reward description of the unlocked mission

{{event.meta.name}}

string

The name of the unlocked mission

{{event.meta.description}}

string

The description of the unlocked mission

{{event.meta.image_url}}

string

The URL of the unlocked mission icon

{{event.meta.hint_text}}

string

The terms and conditions of the unlocked mission

{{event.meta.unlock_mission_description}}

string

The unlock description of the unlocked mission

Event: Gamification: mission unlocked manually or by AI (ach_achievement_unlock_manually)

Event is sent to user when mission is unlocked to him manually

Column
Type
Note

{{event.achievement_id}}

int64

The mission id of the unlocked mission

{{event.meta.reward}}

int64

The reward description of the unlocked mission

{{event.meta.name}}

string

The name of the unlocked mission

{{event.meta.description}}

string

The description of the unlocked mission

{{event.meta.image_url}}

string

The URL of the unlocked mission icon

{{event.meta.hint_text}}

string

The terms and conditions of the unlocked mission

{{event.meta.unlock_mission_description}}

string

The unlock description of the unlocked mission

Event: Gamification: mission viewed (ach_achievement_viewed)

Event it sent to user when he is opening mission popup (works only in Smartico gamification widget, but doesn't work when UI is implemented by Operator using API)

Column
Type
Note

{{event.achievement_id}}

int64

The mission id of the viewed mission

{{event.meta.reward}}

int64

The reward description of the viewed mission

{{event.meta.name}}

string

The name of the viewed mission

{{event.meta.description}}

string

The description of the viewed mission

{{event.meta.image_url}}

string

The URL of the viewed mission icon

{{event.meta.hint_text}}

string

The terms and conditions of the viewed mission

{{event.meta.unlock_mission_description}}

string

The unlock description of the viewed mission

Event: Gamification: mission completed (ach_achievement_completed)

Event is sent to user when he completes mission

Column
Type
Note

{{event.achievement_id}}

int64

The mission id of the completed mission

{{event.meta.reward}}

int64

The reward description of the completed mission

{{event.meta.name}}

string

The name of the completed mission

{{event.meta.description}}

string

The description of the completed mission

{{event.meta.image_url}}

string

The URL of the completed mission icon

{{event.meta.hint_text}}

string

The terms and conditions of the completed mission

{{event.meta.unlock_mission_description}}

string

The unlock description of the completed mission

Badges

Event: Gamification: badge completed (ach_badge_completed)

Event is sent to user when he completed badge (fully)

Column
Type
Note

{{event.meta.name}}

string

The name of the completed badge

{{event.meta.description}}

string

The description of the completed badge

{{event.meta.image_url}}

string

The URL of the completed badge icon

Event: Gamification: badge task completed (ach_badge_task_completed)

Event is sent to user when he completes one of the tasks in the badge

Column
Type
Note

{{event.meta.name}}

string

The name of the completed badge task

{{event.meta.points_reward}}

int64

Points to be rewarded for completing the badge task

{{event.meta.execution_period_sec}}

int64

Period to complete the badge task in seconds

{{event.meta.execution_count}}

int64

Times to complete the badge task

{{event.meta.progress_increment}}

int64

Progress increment of the badge task

Levels

Event: Gamification: level changed (ach_level_changed)

Event is sent to user when he is changing the level

Column
Type
Note

{{event.meta.name}}

string

The name of the level

{{event.meta.description}}

string

The description of the level

{{event.meta.image_url}}

string

The URL of the level icon

{{event.meta.reward}}

string

Reward of the level

{{event.meta.cashback}}

int64

Cashback of the level in %

{{event.meta.rakeback}}

int64

Monthly rakeback of the level in %

{{event.meta.image_inactive}}

string

The URL of the level inactive icon

{{event.meta.image_active}}

string

The URL of the level active icon

Leaderboards

Event: Gamification: board won (ach_listed_on_board_with_reward)

Event is sent to user when he wins position with prize in the leaderboard

Column
Type
Note

{{event.meta.name}}

string

The name of the leaderboard

{{event.meta.description}}

string

The description of the leaderboard

{{event.meta.rules}}

string

The rules of the leaderboard (might be a deep link)

{{event.meta.number_of_rewards_on_board}}

int64

How many users get rewarded

{{event.meta.number_of_users_participated}}

int64

Total number of participants in the leaderboard

{{event.meta.board_started_utc}}

timestamp

When the leaderboard will start in UTC

{{event.meta.board_finalized_utc}}

timestamp

When the leaderboard will end in UTC

Minigames

Event: Minigame: view (minigame_view)

Event is sent to user when he opens mini-game

Column
Type
Note

{{event.meta.minigame_name}}

string

The name of the minigame

{{event.meta.minigame_description}}

string

The description of the minigame

{{event.meta.minigame_promo_text}}

string

The promo text of the minigame

{{event.meta.minigame_thumbnail}}

string

The thumbnail URL of the minigame

{{event.meta.minigame_promo_image}}

string

The promo image URL of the minigame

{{event.meta.minigame_background_image}}

string

The background image URL of the minigame

{{event.meta.minigame_background_image_mobile}}

string

The background image URL of the minigame for mobile

Event: Minigame: attempt (minigame_attempt)

Event is sent at the moment user tryies to play mini-game, it could happen that he won't be able to play, e.g. doesnt have enough points, restricted by time etc.

Column
Type
Note

{{event.meta.minigame_name}}

string

The name of the minigame

{{event.meta.minigame_description}}

string

The description of the minigame

{{event.meta.minigame_promo_text}}

string

The promo text of the minigame

{{event.meta.minigame_thumbnail}}

string

The thumbnail URL of the minigame

{{event.meta.minigame_promo_image}}

string

The promo image URL of the minigame

{{event.meta.minigame_background_image}}

string

The background image URL of the minigame

{{event.meta.minigame_background_image_mobile}}

string

The background image URL of the minigame for

Event: Minigame: spins issued (minigame_spins_issued)

Event is sent when spin attempt is given to the user

Column
Type
Note

{{event.meta.minigame_name}}

string

The name of the minigame

{{event.meta.minigame_description}}

string

The description of the minigame

{{event.meta.minigame_promo_text}}

string

The promo text of the minigame

{{event.meta.minigame_thumbnail}}

string

The thumbnail URL of the minigame

{{event.meta.minigame_promo_image}}

string

The promo image URL of the minigame

{{event.meta.minigame_background_image}}

string

The background image URL of the minigame

{{event.meta.minigame_background_image_mobile}}

string

The background image URL for mobile min

Event: Minigame: win (minigame_win)

Event is sent to user when he wins any prize in the mini-game (including special prize "No prize")

Field Name
Type
Note

{{event.meta.minigame_name}}

string

The name of the minigame

{{event.meta.minigame_description}}

string

The description of the minigame

{{event.meta.minigame_promo_text}}

string

The promo text of the minigame

{{event.meta.minigame_thumbnail}}

string

The thumbnail URL of the minigame

{{event.meta.minigame_promo_image}}

string

The promo image URL of the minigame

{{event.meta.minigame_background_image}}

string

The background image URL of the minigame

{{event.meta.minigame_background_image_mobile}}

string

The background image URL for mobile min

{{event.meta.prize_name}}

string

The name of the prize

{{event.meta.prize_icon}}

string

The URL of the prize icon

{{event.meta.prize_aknowledge_message}}

string

The prize acknowledge message

{{event.meta.prize_value}}

int64

The prize amount

Tournaments

Event: Tournament: user is opted-in, waiting for qualification (tournament_registered_pending_qualification)

Event is sent to user when he opt-in to the tournament that requires qualification

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event: Tournament: user is qualified, waiting for opt in (tournament_user_qualified_pending_registration)

Event is sent to user when he completes qualification requires, matching to segment of tournament, but he didn't opt-in yet

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event: Tournament: user registered (tournament_user_registered)

Event is sent to user at the time when he registers in the tournament

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event: Tournament: started (tournament_started)

Event is sent to all users who registered in the tournament at the moment when tournament is starting

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event Tournament: cancelled (tournament_cancelled)

Event is sent to all users that registered in the tournament, in case tournament is cancelled

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event: Tournament: lose (tournament_lose)

Event is sent to users that didn't win in the tournament, but participated in it

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registred users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Event: Tournament: win (tournament_win)

Event is sent to user when he wins a tournaments (completing tournament on the place that has any type of prize)

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

URL of the tournament image on the list of the tournaments

{{event.meta.image_url2}}

string

URL of the tournament lobby image for desktop

{{event.meta.image_url2_mobile}}

string

URL of the tournament lobby image for mobile

{{event.meta.inst_reg_count}}

string

Count of the registered users

{{event.meta.prize_pool_short}}

string

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.meta.prize_activity_name}}

string

Reward type name: Funnel Marker Add Points Mini Game Deduct Points Reset Points Change Level Prize drop Give Bonus Note: Funnel Marker is tangible prize

{{event.meta.prize_activity_type_id}}

int64

Reward type id: 8 - Funnel Marker (Tangible prize) 12 - Add Points 16 - Mini Game 21 - Deduct Points 22 - Reset Points 23 - Change Level 24 - Prize drop 100 - Give Bonus

{{event.meta.prize_place_from}}

int64

From which place the users are entitled to receive rewards

{{event.meta.prize_place_to}}

int64

To which place users are entitle to receive rewards

{{event.meta.prize_name}}

string

Won prize name

{{event.meta.prize_image_url}}

string

Prize image url

{{event.meta.prize_points_won}}

int64

The amount of points rewarded to the player. Applicable only for reward type points

{{event.meta.prize_total_prizes_won}}

int64

Total prizes won by the user

{{event.place}}

int64

Place at which the user finished

{{event.start_time}}

timestamp

Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

{{event.end_time}}

timestamp

Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.

Note that the time zone is UTC.

Jackpots

Event: Jackpot: opt-in (jackpot_opt_in)

Event is sent when user is opting in into the jackpot

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

The jackpot image URL

{{event.meta.min_amount}}

float

Minimum pot amount at which the jackpot can explode

{{event.meta.max_amount}}

float

Maximum pot amount at which the jackpot can explode

{{event.meta.contribution_value}}

float

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.meta.contribution_type}}

int64

Jackpot's contribution type: 1 - Fixed amount contribution 2 - Percentage of the bet amount

{{event.meta.contribution_player_percentage}}

float

Percentage of the contribution amount that will be taken from the player's wallet. Valid only for mixed contribution money source.

Event: Jackpot: opt-out (jackpot_opt_out)

Event is sent when user is opting out from jackpot

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

The jackpot image URL

{{event.meta.min_amount}}

float

Minimum pot amount at which the jackpot can explode

{{event.meta.max_amount}}

float

Maximum pot amount at which the jackpot can explode

{{event.meta.contribution_value}}

float

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.meta.contribution_type}}

int64

Jackpot's contribution type: 1 - Fixed amount contribution 2 - Percentage of the bet amount

{{event.meta.contribution_player_percentage}}

float

Percentage of the contribution amount that will be taken from the player's wallet. Valid only for mixed contribution money source.

Event: Jackpot: non-win (jackpot_user_nonwin)

Event is sent when jackpot is exploding and user that particapted in it, didn't win. Note that this event is not send to all non-winners by default and target audience need to be configured in the Jackpot template

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

The jackpot image URL

{{event.meta.min_amount}}

float

Minimum pot amount at which the jackpot can explode

{{event.meta.max_amount}}

float

Maximum pot amount at which the jackpot can explode

{{event.meta.contribution_value}}

float

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.meta.contribution_type}}

int64

Jackpot's contribution type: 1 - Fixed amount contribution 2 - Percentage of the bet amount

{{event.meta.contribution_player_percentage}}

float

Percentage of the contribution amount that will be taken from the player's wallet. Valid only for mixed contribution money source.

{{event.winning_amount_jp_currency}}

float

Won amount in jackpot currency

{{event.jp_currency}}

string

Jackpot currency code

{{event.winning_amount_wallet_currency}}

float

Won amount in user's wallet currency

{{event.winning_game_id}}

string

Game id of the winning game

Event: Jackpot: win (jackpot_user_win)

Event is sent when user wins the jackpot, note that target audience need to be configured in the Jackpot template

Field Name
Type
Note

{{event.meta.name}}

string

The name of the jackpot

{{event.meta.description}}

string

The description of the jackpot

{{event.meta.image_url}}

string

The jackpot image URL

{{event.meta.min_amount}}

float

Minimum pot amount at which the jackpot can explode

{{event.meta.max_amount}}

float

Maximum pot amount at which the jackpot can explode

{{event.meta.contribution_value}}

float

Jackpot's contribution amount in fixed value or percentage depending on the contribution type.

{{event.meta.contribution_type}}

int64

Jackpot's contribution type: 1 - Fixed amount contribution 2 - Percentage of the bet amount

{{event.meta.contribution_player_percentage}}

float

Percentage of the contribution amount that will be taken from the player's wallet. Valid only for mixed contribution money source.

{{event.winning_amount_jp_currency}}

float

Won amount in jackpot currency

{{event.jp_currency}}

string

Jackpot currency code

{{event.winning_amount_wallet_currency}}

float

Won amount in user's wallet currency

{{event.winning_game_id}}

string

Game id of the winning game

Raffles

Event: Raffle: Tickets given (raffle_tickets_given)

Event is sent when tickets for raffle are given

Field name
Type
Note

{{event.meta.raffle_name}}

string

Name of raffle

{{event.meta.raffle_description}}

string

Description of raffle

{{event.meta.raffle_image_url}}

string

Image of raffle

{{event.meta.raffle_image_url_mobile}}

string

Mobile image of raffle

Event: Raffle: Draw Won (raffle_draw_won)

Event is sent do the winners of draw in the raffle

Field name
Type
Note

{{event.meta.raffle_name}}

string

Name of raffle

{{event.meta.raffle_description}}

string

Description of raffle

{{event.meta.prize_description}}

string

Description of prize

{{event.meta.raffle_image_url}}

string

Image of raffle

{{event.meta.raffle_image_url_mobile}}

string

Mobile image of raffle

{{event.meta.draw_name}}

string

Name of the draw

{{event.meta.draw_description}}

string

Description of the draw

{{event.meta.draw_image_url}}

string

Image of the draw for desktop

{{event.meta.draw_image_url_mobile}}

string

Image of the draw for mobile

{{event.meta.prize_name}}

string

Name of prize

{{event.meta.prize_image_url}}

string

Image of prize

FAQ

Q: Why the event details might be wrong if used in a communication sent not at the start of the journey/campaign?

A: Because the details are tied to the last executed event so if you would like to take the trigger event details of the campaign then the communication should be placed immediately after the start of the flow or to save the details in a campaign tag/s and then use campaign tags in the communication instead of event details.

Last updated

Was this helpful?