Widget Configuration
Retrieve configuration details such as the main colors and styling for the Gameball widget. This API provides the necessary settings to display a widget that aligns with your program’s branding.
Last updated
Retrieve configuration details such as the main colors and styling for the Gameball widget. This API provides the necessary settings to display a widget that aligns with your program’s branding.
Last updated
Available APIs
This API call retrieves the current widget settings for Gameball, including whether specific features like redemption, cashback, and notifications are enabled.
Security: Requires apiKey header
application/json
gameballEnabled Indicates if the Gameball widget is enabled on the website or platform.
redemptionEnabled Indicates whether the redemption feature is enabled for customers, allowing them to redeem points as discounts or offers. Example: If true, customers can use their accumulated points to receive discounts or rewards through redemption.
cashbackEnabled Indicates whether the cashback program is enabled, allowing customers to earn cashback on their purchases. Example: If true, customers can receive a percentage of their purchase amount as cashback that can be used for future transactions.
visitorProfileEnabled Indicates if the widget is visible to guest customers (unregistered visitors). Example: If true, the widget is displayed to visitors even if they are not signed in, showing limited features such as how to join the loyalty program.
userProfileEnabled Indicates if the widget is visible to signed-up customers (registered users). Example: If true, signed-in users will see their profile within the widget, including their points balance, rewards, and progress.
leaderboardEnabled Indicates whether the leaderboard feature is enabled, allowing customers to see rankings and competition stats. Example: If true, customers can view how they rank against others in terms of points, transactions, or other competitive criteria.
notificationsEnabled Indicates if notifications are enabled in the widget to notify users about their points, rewards, or other updates. Example: If true, customers will receive notifications for actions like points earned, points expiry reminder, or campaigns achievement.
currency The currency used in the widget, such as "USD" (Dollars).
programName The name of the loyalty program as displayed on the widget.
rankPointsName The label used for score displayed on the widget.
walletPointsName The label used for wallet points displayed on the widget.
botMainColor
The primary color of the widget, represented in hexadecimal format (e.g., #E7633F).