Gamified Campaigns
Gamified Campaigns integrations help external apps, websites, kiosks, and customer portals show interactive loyalty experiences after the Customer identity and loyalty context are already connected.
Use this section when the external channel needs to show available games, let Customers play, render challenge progress, show Instant Win results, or explain earned prizes and awards.
Guides
| Guide | Use it for |
|---|---|
| Games | Rendering Scratch & Win and Spin the Wheel, handling play results, and showing prizes or vouchers. |
| Challenges | Showing challenge progress, dates, completion state, and awards in an external channel. |
| Instant Win | Showing available Instant Win campaigns and the win / No Prize result returned by carts, triggers, and custom events. |
Instant Win
Instant Win does not need a play step. The draw runs automatically when the configured event reaches the Streaming API (POST /carts/realtime, POST /trigger, or POST /custom_events), and the result comes back as an instant_win effect in the same response — for a win and for No Prize. The prize (points, Reward, or game participation) is delivered asynchronously after the response.
| Integration step | What to do |
|---|---|
| Show available Instant Wins | Call GET /instant_wins (or GET /instant_wins/{id} for one campaign) with customer_id or customer_code to render the campaigns available to the Customer, including their targeted Instant Wins and remaining_participations. See Instant Win endpoints. |
| Send the event | Send the cart, trigger, or custom event as usual. For a Targeted Instant Win, include the Customer's Voucher code or ["all"] in coupons_desired; otherwise only massive and loyalty promotions are evaluated. |
| Read the result | Find the effect with type: "instant_win" in effects. If it includes prize_name / prize_rule_id, the Customer won that prize; without prize data, the draw returned No Prize; no effect means the Customer did not take part. Do not rely on winned_prize_index alone. Instant Win has no victory/defeat messages, so the app builds the text from the prize data. See How to know if the customer won an Instant Win. |
| Show the prize | Points appear in the wallet, Rewards in the Customer's rewards, and game participations in the Games experience once the asynchronous delivery completes. |