Skip to main content
Gameball provides the flexibility to customize how your customers access the loyalty widget. If the default widget button does not align with your platform’s theme or if space is limited, you can hide or replace the button and use deep links to give customers quick access to specific widget sections from anywhere on your platform. This guide explains how to use deep links effectively and integrate them into your website, emails, or campaigns.
Deep links are URLs or hyperlinks that navigate customers directly to a specific section of the Gameball widget. They enhance the user experience by allowing customers to access the desired content immediately, bypassing unnecessary steps.
Open Gameball widget using menu item

Open Gameball widget using menu item

Gameball supports the following deep links, which can be used across both web and mobile platforms. The section targets remain consistent; only the format changes depending on your platform.
Use the compatibility table below to identify which sections can be reached through browser deep links versus SDK openDetail parameters:
  • Web Deep Link: Navigates an already embedded widget to a specific section by using hash or query parameters.
  • SDK openDetail: Initializes or launches the widget directly into a specific view (for example, a particular campaign or game) using the SDKs.
PurposeSection KeyWeb Deep LinkSDK openDetail
Widget Homehome✅✅
Referralreferral✅✅
FAQfaq✅✅
Levels / Progresslevels✅✅
Redemption (Main)redemption / redeem_main✅✅
Coupon Redemptionredeem_coupons❌✅
Specific Redemption Ruleredeem_rule_{RULE_ID}❌✅
All Reward Campaignsreward_campaign❌✅
Specific Reward Campaignreward_campaign_{CampaignID}❌✅
Spin the Wheel (First)wheel✅✅
Wheels Listwheels_list❌✅
Specific Wheelwheel_{WheelID}❌✅
Slot Machine (First)slot✅✅
Slot Machines Listslot_list❌✅
Specific Slotslot_{SlotID}❌✅
Calendar Campaign (First)calendar✅✅
Calendar Listcalendar_list❌✅
Specific Calendar Campaigncalendar_{CalendarID}❌✅
Scratch and Win (First)scratch❌✅
Specific Scratch and Winscratch_{ScratchId}❌✅
Match Game (First)match❌✅
Specific Match Gamematch_{MatchId}❌✅
Deep links can be added to any element that supports hyperlinks, such as:
  • Text
  • Images
  • Menu items
  • Buttons
They can also be included in automated emails or SMS campaigns. For instance, if a customer clicks on a button labeled “View Your Points” in an email, they will be redirected to your website, and the Gameball widget will automatically display their points section.
Deep links on the web rely on URL formats that the widget listens to. Use either of the following approaches based on how you expose the links to customers.

​
Web-Compatible Section Keys

Use the section keys with either #gameball-[section_key] or ?gameball-deep=[section_key]:

​
Hash Format

Append #gameball-[section_key] to your URL: 
https://your-site.com/#gameball-referral
https://your-site.com/#gameball-wheel

​
Query Parameter Format

Append ?gameball-deep=[section_key] to your URL: 
https://your-site.com/?gameball-deep=referral
https://your-site.com/?gameball-deep=wheel

​
Our SDK

When you are using Gameball SDKs, you can trigger the same sections programmatically. The section keys from the table above still apply; the invocation syntax changes per SDK.

​
Mobile SDKs (iOS / Android / React Native / Flutter)

Pass the section key using the openDetail parameter and prefix it with details_: 
gameballApp.showProfile(this, "customer_id", "details_referral", true)
gameballApp.showProfile(this, "customer_id", "details_slot_123", true)

​
Web SDKs

Pass the section key using the openDetail parameter and prefix it with details_: 
   GbSdk.init({
            APIKey: '{{Your_API_Key}}',
            lang: 'en',
            playerUniqueId: '',
            playerAttributes:{},
            openDetail: "details_referral"
        });

​
Summary

In this tutorial, we’ve covered the various ways to utilize Gameball deep links and SDK functionalities to provide a seamless and personalized experience for your customers:
  1. Hash Format and Query Parameters: Enable direct navigation to specific widget sections from your website, emails, or SMS campaigns.
  2. SDKs Methods: Offer advanced control for mobile apps and programmatically toggle the widget state or navigate to specific sections.
  3. Examples and Supported Sections: Illustrate how to guide customers to areas like referrals, rewards, or wheels.
By combining these methods, you can tailor the Gameball widget’s behavior to fit your platform and create a smoother customer journey.