> For the complete documentation index, see [llms.txt](https://help.smartico.ai/welcome/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.smartico.ai/welcome/products/crm-automation/communication-channels/gamification-activities-in-the-communications.md).

# 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.

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FvjGvfzDitlQoAnWUimFM%2F618a37d521-crop-1-82a344bb-8179cb.png?alt=media" alt=""><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fgit-blob-2f806d4210e6dcd188c2a8b0895f23da6c9ebf48%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

## Ready email templates in Vibe Studio

Vibe Studio has ready email designs for 16 of the events on this page. Each template already uses the tags of its event, so the email shows the player's own mission, tournament, prize or level without extra work. Under each group of events below, you can see a preview of its templates.

1. Go to **Marketing → Assets → Email**, click **Create** and choose **HTML with Vibe Studio**.
2. In the gallery, open the row **Missions & levels**, **Tournaments** or **Rewards & mini-games**. Click **Preview** to see the email with sample values, or **Apply** to load it.
3. Change the texts, colours and links by writing in the chat, then click **Apply & Save**.
4. Put the email right after the trigger of a campaign that starts on the template's event, with no delay or condition step before it — see the note on event tag scope below.

| Event                                  | Template in Vibe Studio            |
| -------------------------------------- | ---------------------------------- |
| Gamification: store purchase succeeded | Store: order confirmed             |
| Gamification: mission unlocked         | New mission unlocked               |
| Gamification: mission completed        | Mission completed                  |
| Gamification: badge completed          | Badge earned                       |
| Gamification: level changed            | Level up                           |
| Minigame: spins issued                 | Mini-game: your spins are ready    |
| Minigame: win                          | Mini-game: you won a prize         |
| Tournament: user registered            | Tournament: you're registered      |
| Tournament: started                    | Tournament: it's live              |
| Tournament: cancelled                  | Tournament: cancelled              |
| Tournament: lose                       | Tournament: not this time          |
| Tournament: win                        | Tournament: you won a prize        |
| Tournament: leaderboard update         | Tournament: your leaderboard place |
| Jackpot: win                           | Jackpot: you won                   |
| Raffle: Tickets given                  | Raffle: new tickets                |
| Raffle: Draw Won                       | Raffle: your ticket won            |

{% hint style="info" %}
Two templates need a condition on the trigger event:

* **Level up** — the level changed event also fires when a player moves down. Add the condition **Gamification: level change direction = UP** to the trigger.
* **Mini-game: you won a prize** — the win event also fires for the "No prize" result. Add the condition that the prize type is not **No prize** to the trigger.
  {% endhint %}

## 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}}"

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
**Important Note on Event Tag Scope:**

Gamification event tags, such as `{{event.meta.name}}` or `{{event.meta.reward}}`, are only available when the communication step connects directly to the campaign trigger node. If your campaign flow includes intermediate delays, conditions, or checks, the original event payload context is no longer active. To retain event values across multiple steps, store them in **Campaign Tags** at the trigger step.

For general rules on combining event data with user state tags, see [Tags, properties, and event data in the communication resources](/welcome/products/crm-automation/communication-channels/tags-properties-and-event-data-in-the-communication-resources.md).
{% endhint %}

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:

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fgit-blob-5fb923f86278fa060c7c0f13f2afc37af59a243d%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

```html
<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>
```

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fgit-blob-60d9be145ef2934a5f98bf7355e3013b7bd0df8d%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fgit-blob-40bb9af4d6e4e3bb3fd3d7f4b09d96066dacc54c%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

## Available tags

### Store

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fpc5tmeNIULR2jFpE7eTe%2Fmail-template-store-purchase-3f1d4e1f-6c28e1.jpg?alt=media" alt="Vibe Studio email template Store: order confirmed" width="300"><figcaption><p>Template for Gamification: store purchase succeeded</p></figcaption></figure></div>

**Event: Gamification: store purchase succeeded (shop\_item\_purchase\_successed)**

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

<table><thead><tr><th width="333">Column</th><th width="124">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.price}}</td><td>int64</td><td>The price of the purchased item in points</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the purchased item</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the purchased item</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the purchased item icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the purchased item</td></tr><tr><td>{{ event.int_param1 }}</td><td>string</td><td>The URL populated in the 'Integration Parameter' field of the store item</td></tr></tbody></table>

### **Missions**

<div><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fagt0IIaGZ0b0ED5PkkjA%2Fmail-template-new-missions-320111e4-712a67.jpg?alt=media" alt="Vibe Studio email template New mission unlocked"><figcaption><p>Template for Gamification: mission unlocked</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FgGbyINWBKrpf2sIroMfG%2Fmail-template-mission-completed-82c9e987-f7a0dc.jpg?alt=media" alt="Vibe Studio email template Mission completed"><figcaption><p>Template for Gamification: mission completed</p></figcaption></figure></div>

**Event: Gamification: Opt-In to mission (ach\_achievement\_opt\_in)**

Event is sent to user when he opts into a mission

<table><thead><tr><th width="267">Column</th><th width="159">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.achievement_id}}</td><td>int64</td><td>The mission id of the mission the user opted into</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>The reward description of the mission</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the mission</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the mission</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the mission icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the mission</td></tr></tbody></table>

**Event: Gamification: mission unlocked (ach\_achievement\_unlocked)**

Event is sent to user when he unlocks mission

<table><thead><tr><th width="267">Column</th><th width="159">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.achievement_id}}</td><td>int64</td><td>The mission id of the unlocked mission</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>The reward description of the unlocked mission</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the unlocked mission</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the unlocked mission</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the unlocked mission icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the unlocked mission</td></tr><tr><td>{{event.meta.unlock_mission_description}}</td><td>string</td><td>The unlock description of the unlocked mission</td></tr></tbody></table>

**Event: Gamification: Mission Unlock Triggered (Manual or AI) (ach\_achievement\_unlock\_manually)**

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

<table><thead><tr><th width="268">Column</th><th width="160">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.achievement_id}}</td><td>int64</td><td>The mission id of the unlocked mission</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>The reward description of the unlocked mission</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the unlocked mission</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the unlocked mission</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the unlocked mission icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the unlocked mission</td></tr><tr><td>{{event.meta.unlock_mission_description}}</td><td>string</td><td>The unlock description of the unlocked mission</td></tr></tbody></table>

**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)

<table><thead><tr><th width="269">Column</th><th width="160">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.achievement_id}}</td><td>int64</td><td>The mission id of the viewed mission</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>The reward description of the viewed mission</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the viewed mission</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the viewed mission</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the viewed mission icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the viewed mission</td></tr><tr><td>{{event.meta.unlock_mission_description}}</td><td>string</td><td>The unlock description of the viewed mission</td></tr></tbody></table>

**Event: Gamification: mission completed (ach\_achievement\_completed)**

Event is sent to user when he completes mission

<table><thead><tr><th width="267">Column</th><th width="159">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.achievement_id}}</td><td>int64</td><td>The mission id of the completed mission</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>The reward description of the completed mission</td></tr><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the completed mission</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the completed mission</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the completed mission icon</td></tr><tr><td>{{event.meta.hint_text}}</td><td>string</td><td>The terms and conditions of the completed mission</td></tr><tr><td>{{event.meta.unlock_mission_description}}</td><td>string</td><td>The unlock description of the completed mission</td></tr></tbody></table>

### Badges

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FV4O2Qrkl23pHpZn7xOZR%2Fmail-template-badge-earned-773a72d3-e477a4.jpg?alt=media" alt="Vibe Studio email template Badge earned" width="300"><figcaption><p>Template for Gamification: badge completed</p></figcaption></figure></div>

**Event: Gamification: badge completed (ach\_badge\_completed)**

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

<table><thead><tr><th width="271">Column</th><th width="160">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the completed badge</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the completed badge</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the completed badge icon</td></tr></tbody></table>

**Event: Gamification: badge task completed (ach\_badge\_task\_completed)**

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

<table><thead><tr><th width="274">Column</th><th width="161">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the completed badge task</td></tr><tr><td>{{event.meta.points_reward}}</td><td>int64</td><td>Points to be rewarded for completing the badge task</td></tr><tr><td>{{event.meta.execution_period_sec}}</td><td>int64</td><td>Period to complete the badge task in seconds</td></tr><tr><td>{{event.meta.execution_count}}</td><td>int64</td><td>Times to complete the badge task</td></tr><tr><td>{{event.meta.progress_increment}}</td><td>int64</td><td>Progress increment of the badge task</td></tr></tbody></table>

### Levels

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FFxQJvd7wN2R7aZbZ9W6c%2Fmail-template-level-up-f7272ec8-abb608.jpg?alt=media" alt="Vibe Studio email template Level up" width="300"><figcaption><p>Template for Gamification: level changed (with the condition level change direction = UP)</p></figcaption></figure></div>

**Event: Gamification: level changed (ach\_level\_changed)**

Event is sent to user when he is changing the level

<table><thead><tr><th width="276">Column</th><th width="163">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the level</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the level</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The URL of the level icon</td></tr><tr><td>{{event.meta.reward}}</td><td>string</td><td>Reward of the level</td></tr><tr><td>{{event.meta.cashback}}</td><td>int64</td><td>Cashback of the level in %</td></tr><tr><td>{{event.meta.rakeback}}</td><td>int64</td><td>Monthly rakeback of the level in %</td></tr><tr><td>{{event.meta.image_inactive}}</td><td>string</td><td>The URL of the level inactive icon</td></tr><tr><td>{{event.meta.image_active}}</td><td>string</td><td>The URL of the level active icon</td></tr></tbody></table>

### 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

<table><thead><tr><th width="276">Column</th><th width="163">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the leaderboard</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the leaderboard</td></tr><tr><td>{{event.meta.rules}}</td><td>string</td><td>The rules of the leaderboard (might be a deep link)</td></tr><tr><td>{{event.meta.number_of_rewards_on_board}}</td><td>int64</td><td>How many users get rewarded</td></tr><tr><td>{{event.meta.number_of_users_participated}}</td><td>int64</td><td>Total number of participants in the leaderboard</td></tr><tr><td>{{event.meta.board_started_utc}}</td><td>timestamp</td><td>When the leaderboard will start in UTC</td></tr><tr><td>{{event.meta.board_finalized_utc}}</td><td>timestamp</td><td>When the leaderboard will end in UTC</td></tr></tbody></table>

### Minigames

<div><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2F6cx31E5Tsmv9oMtqASZH%2Fmail-template-minigame-spins-ready-99e7dfed-6751f0.jpg?alt=media" alt="Vibe Studio email template Mini-game: your spins are ready"><figcaption><p>Template for Minigame: spins issued</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2F4WgG9HjYYWI3XvMoikVD%2Fmail-template-minigame-prize-won-b60ba3b5-59beff.jpg?alt=media" alt="Vibe Studio email template Mini-game: you won a prize"><figcaption><p>Template for Minigame: win (with the condition prize type is not No prize)</p></figcaption></figure></div>

**Event: Minigame: view (minigame\_view)**

Event is sent to user when he opens mini-game

<table><thead><tr><th width="280">Column</th><th width="164">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.minigame_name}}</td><td>string</td><td>The name of the minigame</td></tr><tr><td>{{event.meta.minigame_description}}</td><td>string</td><td>The description of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_text}}</td><td>string</td><td>The promo text of the minigame</td></tr><tr><td>{{event.meta.minigame_thumbnail}}</td><td>string</td><td>The thumbnail URL of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_image}}</td><td>string</td><td>The promo image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image}}</td><td>string</td><td>The background image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image_mobile}}</td><td>string</td><td>The background image URL of the minigame for mobile</td></tr></tbody></table>

**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.

<table><thead><tr><th width="282">Column</th><th width="162">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.minigame_name}}</td><td>string</td><td>The name of the minigame</td></tr><tr><td>{{event.meta.minigame_description}}</td><td>string</td><td>The description of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_text}}</td><td>string</td><td>The promo text of the minigame</td></tr><tr><td>{{event.meta.minigame_thumbnail}}</td><td>string</td><td>The thumbnail URL of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_image}}</td><td>string</td><td>The promo image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image}}</td><td>string</td><td>The background image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image_mobile}}</td><td>string</td><td>The background image URL of the minigame for mobile</td></tr></tbody></table>

**Event: Minigame: spins issued (minigame\_spins\_issued)**

Event is sent when spin attempt is given to the user

<table><thead><tr><th width="282">Column</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.minigame_name}}</td><td>string</td><td>The name of the minigame</td></tr><tr><td>{{event.meta.minigame_description}}</td><td>string</td><td>The description of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_text}}</td><td>string</td><td>The promo text of the minigame</td></tr><tr><td>{{event.meta.minigame_thumbnail}}</td><td>string</td><td>The thumbnail URL of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_image}}</td><td>string</td><td>The promo image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image}}</td><td>string</td><td>The background image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image_mobile}}</td><td>string</td><td>The background image URL of the minigame for mobile</td></tr></tbody></table>

**Event: Minigame: win (minigame\_win)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.minigame_name}}</td><td>string</td><td>The name of the minigame</td></tr><tr><td>{{event.meta.minigame_description}}</td><td>string</td><td>The description of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_text}}</td><td>string</td><td>The promo text of the minigame</td></tr><tr><td>{{event.meta.minigame_thumbnail}}</td><td>string</td><td>The thumbnail URL of the minigame</td></tr><tr><td>{{event.meta.minigame_promo_image}}</td><td>string</td><td>The promo image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image}}</td><td>string</td><td>The background image URL of the minigame</td></tr><tr><td>{{event.meta.minigame_background_image_mobile}}</td><td>string</td><td>The background image URL of the minigame for mobile</td></tr><tr><td>{{event.meta.prize_name}}</td><td>string</td><td>The name of the prize</td></tr><tr><td>{{event.meta.prize_icon}}</td><td>string</td><td>The URL of the prize icon</td></tr><tr><td>{{event.meta.prize_aknowledge_message}}</td><td>string</td><td>The prize acknowledge message</td></tr><tr><td>{{event.meta.prize_value}}</td><td>int64</td><td>The prize amount</td></tr></tbody></table>

### Tournaments

<div><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FfeRa7OajCsbm1OObBJv0%2Fmail-template-tournament-registered-0ef6972d-d40107.jpg?alt=media" alt="Vibe Studio email template Tournament: you&#x27;re registered"><figcaption><p>Template for Tournament: user registered</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FvlePfxqRbw2UnFTn85PU%2Fmail-template-tournament-started-c60937dc-0f6054.jpg?alt=media" alt="Vibe Studio email template Tournament: it&#x27;s live"><figcaption><p>Template for Tournament: started</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2F1Q5TCqCE0F8sH8NYCviK%2Fmail-template-tournament-cancelled-b744b922-1f6bab.jpg?alt=media" alt="Vibe Studio email template Tournament: cancelled"><figcaption><p>Template for Tournament: cancelled</p></figcaption></figure></div>

<div><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fz5AHFibziAzOzlVCJB19%2Fmail-template-tournament-lost-0d72d5b4-848d9c.jpg?alt=media" alt="Vibe Studio email template Tournament: not this time"><figcaption><p>Template for Tournament: lose</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2Fcex8PMRxkYJXxcfSv5Hv%2Fmail-template-tournament-won-3cde7f5b-fc05d9.jpg?alt=media" alt="Vibe Studio email template Tournament: you won a prize"><figcaption><p>Template for Tournament: win</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FeOoXnkqdtLOYwaMUE1c4%2Fmail-template-tournament-position-63cbbe99-aea4cd.jpg?alt=media" alt="Vibe Studio email template Tournament: your leaderboard place"><figcaption><p>Template for Tournament: leaderboard update</p></figcaption></figure></div>

**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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**Event: Tournament: user registered (tournament\_user\_registered)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**Event: Tournament: started (tournament\_started)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**Event Tournament: cancelled (tournament\_cancelled)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**Event: Tournament: lose (tournament\_lose)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**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)

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta.image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta.image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta.inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.meta.prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.meta.prize_activity_name}}</td><td>string</td><td>Reward type name. It is filled only for these reward types:<br>Add Points<br>Mini Game<br>Prize drop<br>Give Bonus<br>Raffle Ticket<br>Avatar<br><br>For the other reward types (Funnel Marker, Deduct Points, Reset Points, Change Level, gems &#x26; diamonds) it is empty — use {{event.meta.prize_activity_type_id}} instead.<br><br>Note: Funnel Marker is tangible prize</td></tr><tr><td>{{event.meta.prize_activity_type_id}}</td><td>int64</td><td>Reward type id:<br>8 - Funnel Marker (Tangible prize)<br>12 - Add Points<br>16 - Mini Game<br>21 - Deduct Points<br>22 - Reset Points<br>23 - Change Level<br>24 - Prize drop<br>25 - Add gems &#x26; diamonds<br>26 - Deduct gems and diamonds<br>27 - Reset gems and diamonds<br>100 - Give Bonus<br>103 - Raffle Ticket<br>803 - Avatar</td></tr><tr><td>{{event.meta.prize_place_from}}</td><td>int64</td><td>From which place the users are entitled to receive rewards</td></tr><tr><td>{{event.meta.prize_place_to}}</td><td>int64</td><td>To which place users are entitle to receive rewards</td></tr><tr><td>{{event.meta.prize_name}}</td><td>string</td><td>Won prize name</td></tr><tr><td>{{event.meta.prize_image_url}}</td><td>string</td><td>Prize image url</td></tr><tr><td>{{event.meta.prize_points_won}}</td><td>int64</td><td>The amount of points rewarded to the player.<br>Applicable only for reward type points</td></tr><tr><td>{{event.meta.prize_total_prizes_won}}</td><td>int64</td><td>Total prizes won by the user</td></tr><tr><td>{{event.place}}</td><td>int64</td><td>Place at which the user finished</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td><p>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td><p>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS.</p><p>Note that the time zone is UTC.</p></td></tr></tbody></table>

**Event: Tournament: leaderboard update (tournament\_leaderboard\_update)**

Event is sent by schedule to the players who are in the top positions of a running tournament. It is sent only when the tournament has the setting "Send 'Tournament position' event by schedule" (schedule + number of top players) configured; each scheduled check sends one event to every player inside the configured top.

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.tournament_leaderboard_position}}</td><td>int64</td><td>The current place of the user in the tournament at the moment of the scheduled check (1 = first place)</td></tr><tr><td>{{event.tournament_id}}</td><td>int64</td><td>The id of the tournament</td></tr><tr><td>{{event.tournament_instance_id}}</td><td>int64</td><td>The id of the running tournament instance</td></tr><tr><td>{{event.meta_name}}</td><td>string</td><td>The name of the tournament</td></tr><tr><td>{{event.meta_description}}</td><td>string</td><td>The description of the tournament</td></tr><tr><td>{{event.meta_image_url}}</td><td>string</td><td>URL of the tournament image on the list of the tournaments</td></tr><tr><td>{{event.meta_image_url2}}</td><td>string</td><td>URL of the tournament lobby image for desktop</td></tr><tr><td>{{event.meta_image_url2_mobile}}</td><td>string</td><td>URL of the tournament lobby image for mobile</td></tr><tr><td>{{event.meta_prize_pool_short}}</td><td>string</td><td>The short name of the prize pool</td></tr><tr><td>{{event.meta_inst_reg_count}}</td><td>int64</td><td>Count of the registered users</td></tr><tr><td>{{event.start_time}}</td><td>timestamp</td><td>Date and time when the tournament started in the following format: YYYY-MM-DD HH:MM:SS. Note that the time zone is UTC.</td></tr><tr><td>{{event.end_time}}</td><td>timestamp</td><td>Date and time when the tournament ends in the following format: YYYY-MM-DD HH:MM:SS. Note that the time zone is UTC.</td></tr></tbody></table>

{% hint style="warning" %}

1. For this event the tournament details use an underscore, not a dot: write {{event.meta\_name}}, {{event.meta\_description}} and so on. The {{event.meta.name}} form used by the other tournament events does not work for this event.
2. The texts (name, description, images, prize pool) are taken in the language of the player and with the brand-specific values set in the tournament, the same way as for the other tournament events.
3. Label tags written inside the tournament texts (for example in the tournament name or description) are replaced in the message. State tags ({{state.xxx}}) written inside the tournament texts are NOT replaced for this event and reach the player as written, so do not use state tags in the texts of tournaments that send this event. State tags written directly in the message template itself work as usual.
   {% endhint %}

### Jackpots

<div data-with-frame="true"><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FuhzKpyypSG54br1w1uYe%2Fmail-template-jackpot-won-db5e6cf5-0086ea.jpg?alt=media" alt="Vibe Studio email template Jackpot: you won" width="300"><figcaption><p>Template for Jackpot: win</p></figcaption></figure></div>

**Event: Jackpot: opt-in (jackpot\_opt\_in)**

Event is sent when user is opting in into the jackpot

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the jackpot</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the jackpot</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The jackpot image URL</td></tr><tr><td>{{event.meta.min_amount}}</td><td>float</td><td>Minimum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.max_amount}}</td><td>float</td><td>Maximum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.contribution_value}}</td><td>float</td><td>Jackpot's contribution amount in fixed value or percentage depending on the contribution type.</td></tr><tr><td>{{event.meta.contribution_type}}</td><td>int64</td><td>Jackpot's contribution type:<br>1 - Fixed amount contribution<br>2 - Percentage of the bet amount</td></tr><tr><td>{{event.meta.contribution_player_percentage}}</td><td>float</td><td>Percentage of the contribution amount that will be taken from the player's wallet.<br>Valid only for mixed contribution money source.</td></tr></tbody></table>

**Event: Jackpot: opt-out (jackpot\_opt\_out)**

Event is sent when user is opting out from jackpot

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the jackpot</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the jackpot</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The jackpot image URL</td></tr><tr><td>{{event.meta.min_amount}}</td><td>float</td><td>Minimum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.max_amount}}</td><td>float</td><td>Maximum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.contribution_value}}</td><td>float</td><td>Jackpot's contribution amount in fixed value or percentage depending on the contribution type.</td></tr><tr><td>{{event.meta.contribution_type}}</td><td>int64</td><td>Jackpot's contribution type:<br>1 - Fixed amount contribution<br>2 - Percentage of the bet amount</td></tr><tr><td>{{event.meta.contribution_player_percentage}}</td><td>float</td><td>Percentage of the contribution amount that will be taken from the player's wallet.<br>Valid only for mixed contribution money source.</td></tr></tbody></table>

**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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the jackpot</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the jackpot</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The jackpot image URL</td></tr><tr><td>{{event.meta.min_amount}}</td><td>float</td><td>Minimum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.max_amount}}</td><td>float</td><td>Maximum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.contribution_value}}</td><td>float</td><td>Jackpot's contribution amount in fixed value or percentage depending on the contribution type.</td></tr><tr><td>{{event.meta.contribution_type}}</td><td>int64</td><td>Jackpot's contribution type:<br>1 - Fixed amount contribution<br>2 - Percentage of the bet amount</td></tr><tr><td>{{event.meta.contribution_player_percentage}}</td><td>float</td><td>Percentage of the contribution amount that will be taken from the player's wallet.<br>Valid only for mixed contribution money source.</td></tr><tr><td>{{event.winning_amount_jp_currency}}</td><td>float</td><td>Won amount in jackpot currency</td></tr><tr><td>{{event.jp_currency}}</td><td>string</td><td>Jackpot currency code</td></tr><tr><td>{{event.winning_amount_wallet_currency}}</td><td>float</td><td>Won amount in user's wallet currency</td></tr><tr><td>{{event.winning_game_id}}</td><td>string</td><td>Game id of the winning game</td></tr></tbody></table>

**Event: Jackpot: win (**&#x6A;**ackpot\_user\_win)**

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

<table><thead><tr><th width="283">Field Name</th><th width="165">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>The name of the jackpot</td></tr><tr><td>{{event.meta.description}}</td><td>string</td><td>The description of the jackpot</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>The jackpot image URL</td></tr><tr><td>{{event.meta.min_amount}}</td><td>float</td><td>Minimum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.max_amount}}</td><td>float</td><td>Maximum pot amount at which the jackpot can explode</td></tr><tr><td>{{event.meta.contribution_value}}</td><td>float</td><td>Jackpot's contribution amount in fixed value or percentage depending on the contribution type.</td></tr><tr><td>{{event.meta.contribution_type}}</td><td>int64</td><td>Jackpot's contribution type:<br>1 - Fixed amount contribution<br>2 - Percentage of the bet amount</td></tr><tr><td>{{event.meta.contribution_player_percentage}}</td><td>float</td><td>Percentage of the contribution amount that will be taken from the player's wallet.<br>Valid only for mixed contribution money source.</td></tr><tr><td>{{event.winning_amount_jp_currency}}</td><td>float</td><td>Won amount in jackpot currency</td></tr><tr><td>{{event.jp_currency}}</td><td>string</td><td>Jackpot currency code</td></tr><tr><td>{{event.winning_amount_wallet_currency}}</td><td>float</td><td>Won amount in user's wallet currency</td></tr><tr><td>{{event.winning_game_id}}</td><td>string</td><td>Game id of the winning game</td></tr></tbody></table>

### Raffles

<div><figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2FjyOzcrRxh7QwCfHe25R4%2Fmail-template-raffle-tickets-e235be3e-d1f952.jpg?alt=media" alt="Vibe Studio email template Raffle: new tickets"><figcaption><p>Template for Raffle: Tickets given</p></figcaption></figure> <figure><img src="https://77049817-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfS5hl0PiysHtKAKMsQTe%2Fuploads%2F69jivk61hRVBpemKFPQb%2Fmail-template-raffle-winner-b43cc7a1-9e2ca9.jpg?alt=media" alt="Vibe Studio email template Raffle: your ticket won"><figcaption><p>Template for Raffle: Draw Won</p></figcaption></figure></div>

**Event:** Raffle: Tickets given **(**&#x72;affle\_tickets\_give&#x6E;**)**

Event is sent when tickets for raffle are given

<table><thead><tr><th width="336.48828125">Field name</th><th width="169.55078125">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.raffle_name}}</td><td>string</td><td>Name of raffle</td></tr><tr><td>{{event.meta.raffle_description}}</td><td>string</td><td>Description of raffle</td></tr><tr><td>{{event.meta.raffle_image_url}}</td><td>string</td><td>Image of raffle</td></tr><tr><td>{{event.meta.raffle_image_url_mobile}}</td><td>string</td><td>Mobile image of raffle</td></tr><tr><td>{{event.meta.raffle_hint_text}}</td><td>string</td><td>Terms and conditions of raffle</td></tr></tbody></table>

**Event: Raffle: Draw Won (**&#x72;affle\_draw\_wo&#x6E;**)**

Event is sent do the winners of draw in the raffle

<table><thead><tr><th width="336.48828125">Field name</th><th width="169.55078125">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.raffle_name}}</td><td>string</td><td>Name of raffle</td></tr><tr><td>{{event.meta.raffle_description}}</td><td>string</td><td>Description of raffle</td></tr><tr><td>{{event.meta.prize_description}}</td><td>string</td><td>Description of prize</td></tr><tr><td>{{event.meta.raffle_image_url}}</td><td>string</td><td>Image of raffle</td></tr><tr><td>{{event.meta.raffle_image_url_mobile}}</td><td>string</td><td>Mobile image of raffle</td></tr><tr><td>{{event.meta.raffle_hint_text}}</td><td>string</td><td>Terms and conditions of raffle</td></tr><tr><td>{{event.meta.draw_name}}</td><td>string</td><td>Name of the draw</td></tr><tr><td>{{event.meta.draw_description}}</td><td>string</td><td>Description of the draw</td></tr><tr><td>{{event.meta.draw_image_url}}</td><td>string</td><td>Image for desktop. Note: it currently holds the raffle image (the same value as {{event.meta.raffle_image_url}}), not the image of the draw</td></tr><tr><td>{{event.meta.draw_image_url_mobile}}</td><td>string</td><td>Image for mobile. Note: it currently holds the raffle mobile image (the same value as {{event.meta.raffle_image_url_mobile}}), not the image of the draw</td></tr><tr><td>{{event.meta.prize_name}}</td><td>string</td><td>Name of prize</td></tr><tr><td>{{event.meta.prize_image_url}}</td><td>string</td><td>Image of prize</td></tr></tbody></table>

### Bonuses

**Event: Core: smartico bonus failed (**&#x63;ore\_bonus\_faile&#x64;**)**

Event is sent when sending a bonus fails

<table><thead><tr><th width="336.48828125">Field name</th><th width="169.55078125">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>UI name of the bonus</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>Image of the bonus</td></tr><tr><td>{{event.meta.acknowledge}}</td><td>string</td><td>Acknowledge message of the bonus</td></tr></tbody></table>

**Event: Core: smartico bonus given (**&#x63;ore\_bonus\_give&#x6E;**)**

Event is sent when sending a bonus succeeds

<table><thead><tr><th width="336.48828125">Field name</th><th width="169.55078125">Type</th><th>Note</th></tr></thead><tbody><tr><td>{{event.meta.name}}</td><td>string</td><td>UI name of the bonus</td></tr><tr><td>{{event.meta.image_url}}</td><td>string</td><td>Image of the bonus</td></tr><tr><td>{{event.meta.acknowledge}}</td><td>string</td><td>Acknowledge message of the bonus</td></tr></tbody></table>

## 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.smartico.ai/welcome/products/crm-automation/communication-channels/gamification-activities-in-the-communications.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
