# How Do I Export My Points Data?
Source: https://docs.gameball.co/product-documentation/analytics/export-your-points-data
Learn how to export your points data from the Gameball dashboard and what fields are included.
Gameball allows you to export your points data directly from the analytics page.
You can apply filters to narrow down the customer inclusions based on tags before exporting or export a broader dataset as needed.
***
## Step-by-Step Instructions
Go to the **Points & Rewards** page from the Gameball dashboard under the *Analytics* section in the left-side menu bar.
Apply filters if you'd like to export a specific tag's points.
Click **Export**.
Your data will be exported as a CSV file.
***
## Exported Fields and Their Descriptions
Here's a description of all the columns included in your exported file:
| Column Header | Description |
| --------------------------- | ------------------------------------------------------------------------------------- |
| `date` | The date for which the points data is reported |
| `earned_points` | Total points earned by customers on that date |
| `redeemed_points` | Points that were used/redeemed for rewards |
| `burned_points` | Points that were lost due to expiry, cancellation, partial refund or manual deduction |
| `cashback_reward_points` | Points earned specifically from purchase rewards |
| `refunded_points` | Points returned to customers after a refund process |
| `redeemed_fixed_points` | Points used in an order directly without coupon creation |
| `expired_points` | Points that expired before being redeemed |
| `cancelled_points` | Points cancelled due to order cancellation or reversal |
| `migrated_points` | Points transferred from a previous system or imported manually |
| `manual_added_points` | Points manually granted by admins |
| `manual_negative_points` | Points manually deducted by admins |
| `partially_refunded_points` | Points adjusted due to partial refunds |
| `campaign_points` | Points earned from campaigns (e.g., challenges, engagement triggers) |
| `referral_points` | Points earned through referral activities |
| `level_points` | Points awarded through tier progress |
| `redemption_rate` | The ratio of redeemed points to earned points, shown as a percentage |
***
## Related Articles
Learn about all customer attributes and how they are populated.
View and manage your full customer list.
Migrate customers from other loyalty programs.
Use tags to manually group and target customers.
# What Is Gameball Analytics?
Source: https://docs.gameball.co/product-documentation/analytics/introduction-to-gameball-analytics
Discover the analytics section, and learn how to use and navigate it to get the needed information.
Keeping track of your business performance helps you make better decisions and achieve your business goals. Tools that give you deep insights into the overall performance through business analytics. Knowing how applying loyalty strategies directly impacts your business performance makes monitoring the performance of the loyalty system equally as important as tracking the business growth itself; this is why Gameball has created an **analytics section**.
Gameball analytics helps you keep track of all loyalty and business-related data. Here are brief examples of some of the information you will find in the analytics sections:
* Track your total sales from Gameball programs.
* Learn how much your customers spend on your store and further details on your customers' placed orders.
* Gain insights into your customers' behavior to better tailor your loyalty and retargeting strategy on Gameball.
* Impact of Gameball on your revenue, business performance, and growth.
***
## Where to Find Gameball's Analytics Section
Go to Gameball **Dashboard**. From the left bar, click **Analytics**.
You will be on the **Members Analytics** page by default.
**There are four analytics sections you can explore:**
Track enrolled member growth, engagement rates, and retention metrics.
Monitor points earned, redeemed, burned, and export raw data as CSV.
Analyze customer spending, order values, and Gameball-attributed revenue.
Measure campaign reach, completion rates, and rewards distribution.
Evaluate referral activity, success rates, and revenue from referrals.
***
## What Do I Need to Know Before Diving Into the Analytics?
When looking straight at numbers and graphs for the first time, it might seem complicated or hard to grasp.
Here are some quick tips that will help you figure out what each number or graph means and how to navigate and assemble them according to your preferences:
When you are on any of the analytics pages, you can display the data from a particular time span or display all the data from the time you activated your program.
Click on the button at the top right of any page to select your preferred time span.
You can manually select a time span to display data between two random dates by clicking **"pick a date.."**
When you apply a time span filter, data that is impacted by this will show the progression or difference of numbers according to the selected period.
If you find yourself uncertain about what specific data refers to precisely, use your cursor to point at the **Information Icon** beside the data title to read a brief explanation about it.
Another way to gain a deeper understanding of what each piece of data reflects is by checking our other help center articles.
You can view more details about each group of customers that shares the same tag by clicking **Choose Tag**.
You can export each report you view on its own to a **SVG, PNG, or CSV file** by clicking on the **Export Icon** on the top right of your data.
***
## What's Next?
Measure campaign reach, engagement, and rewards distribution.
Analyze customer spending, order values, and purchase frequency.
Evaluate referral activity, success rates, and revenue from referrals.
# What Are Member Analytics?
Source: https://docs.gameball.co/product-documentation/analytics/member-analytics
Track enrolled member growth, engagement rates, and retention metrics to understand your loyalty program's performance.
Available on **All** plans.
Available on **All** plans.
Available on **All** plans.
Understanding your customer base is the foundation of making informed, data-driven decisions. The **Member Analytics** section in Gameball offers a comprehensive view of your enrolled customers, enabling you to track growth, engagement, and overall participation in your loyalty program.
***
## Overview Metrics
The **total number of customers currently enrolled** in your Gameball loyalty program.
**Calculation:**
1. **Included customers only**: Counts unique customers who are currently enrolled in the program.
2. **Not affected by time filters** -- always shows the real-time total.
3. **Affected by tag/segment filters**: Adjusts based on any applied filters (e.g., VIP Tier, Holiday2025).
4. **Excludes**: Deleted, opted-out, or excluded customers.
The **total number of customers currently excluded from the program is "profile marked as inactive"** in your Gameball account.
**Calculation:**
1. **Excluded customers only**: Counts all customers currently "excluded" from the program.
2. **Not affected by time filters** -- always shows the current count.
3. **Affected by tag/segment filters**: Adjusts based on any applied filters (e.g., VIP Tier, Holiday2025).
The **number of new customers who joined your program** during the selected time range.
**Calculation:**
1. **Join date first**: Based on the customer's "join date," if available. **Fallback**: If the join date is missing, use the customer's creation date in Gameball.
2. **Impacted by time filters**: Only counts members who joined within the selected date range.
3. **Affected by tag/segment filters**: Adjusts based on any applied filters.
A **line chart** that visualizes **new customer acquisition over time**.
**Calculation:**
1. **New members**: Based on "join date"; if missing, falls back to creation date in Gameball.
2. **Impacted by time filters**: Reflects the selected date range.
3. **Affected by tag/segment filters**.
The **breakdown of enrolled members across different loyalty tiers** in your program -- for example, Bronze, Silver, Gold, etc.
**Calculation:**
1. Count of members grouped by current tier (**based on most recent status**).
2. **Not affected by time filters** -- always shows the current count.
3. **Affected by tag/segment filters**: Will adjust if filters are applied.
***
## Engagement Metrics
A **line chart** showing the **percentage of enrolled members actively engaging** with your loyalty program over time, based on the selected date range.
**Calculation:**
1. Engagement Rate = (Active Members / Total Enrolled Members) x 100
2. **Active members:** Number of unique customers who did any of the following:
* Ordered
* Redeemed points
* Interacted with the widget
* Did an event
3. **Total Enrolled Members:** Counts unique customers who are currently enrolled in the program.
4. **Impacted by time filters** -- shows trends over the selected period.
5. **Affected by tag/segment filters**.
A **line chart** showing the **number of unique customers who engaged** with your loyalty program during the selected timeframe.
**Calculation:**
1. Counts **unique customers** who performed **any of the following actions** during the selected date range:
* Order/transaction
* Redeemed points
* Interacted with the widget
* Did an event
2. **Impacted by time filters** -- shows trends over the selected period.
3. **Affected by tag/segment filters**.
A **line chart** showing the **number of total interactions** with your loyalty program during the selected timeframe, broken down by type.
**Calculation:**
1. Counts the total number of times customers performed **any** of the following actions during the selected date range:
1. Ordered
2. Redeemed points
3. Interacted with the widget
4. Did an event
2. **Impacted by time filters** -- shows trends over the selected period.
3. **Affected by tag/segment filters**.
***
## Retention Metrics
The percentage of **returning customers** -- those who placed an order in the current period **and** also placed an order in the **previous equivalent period**.
**Calculation:**
1. Retention Rate = (Returning Customers in Current Period / Total Customers in Previous Period) x 100
2. A **Returning Customer** is any customer who:
* Placed **at least one order** in the **current period** (week or month), **and**
* Also placed **at least one order** in the **previous equivalent period** (the week or month immediately before).
3. **Examples:**
* In a **monthly view**, a returning customer is someone who ordered this month **and** last month.
* In a **weekly view**, a returning customer is someone who ordered this week **and** last week.
4. **Impacted by time filters**:
1. If you select a **custom time range** (e.g., last 3 months) and break the graph **weekly**, the retention calculation is done **period-by-period**.
2. The graph shows retention for each week within the selected time range.
3. Each week's retention compares customers who ordered that week to those who ordered in the **previous week**.
5. **Affected by tag/segment filters**.
Shows the **average number of unique customers per day** who placed at least one order, with results broken down **weekly or monthly**.
**Calculation:**
1. **Weekly Breakdown:**
1. For each day of the week (Sunday to Saturday), count the **unique customers** who placed at least one order that day.
2. Sum these daily counts for the week.
3. Divide the sum by **7** to get the weekly average of daily unique ordering customers.
2. **Monthly Breakdown:**
1. For each day of the month, count the **unique customers** who placed at least one order.
2. Sum these daily counts for the month.
3. Divide the sum by the **total number of days in the month** to get the monthly average of daily unique ordering customers.
3. **Impacted by time filters** -- shows trends over the selected period.
4. **Affected by tag/segment filters**.
Categorizes customers into **Non-Redeemers**, **One-Time Redeemers**, and **Frequent Redeemers** to help you understand long-term customer behavior and loyalty trends.
**Calculation:**
1. **Identify cohort members:**
* Select **all unique customers** who placed at least one order in the **last 6 months**.
2. **Assign cohorts:**
* Group each customer into a **monthly cohort** based on the **month of their first purchase**.
3. **Track retention per cohort:** For each subsequent month, calculate:
4. **Not affected by time filters** -- always shows the real-time total.
5. **Affected by tag/segment filters**.
# How Do I Track My Campaign Performance Using Gameball Analytics?
Source: https://docs.gameball.co/product-documentation/analytics/track-your-campaign-performance
Measure the success of your reward campaigns by analyzing reach, engagement, and rewards distribution.
The Campaign Performance page in the analytics section gives you visibility into how your reward campaigns are performing. It shows who is being reached, how many customers are completing campaigns, and the rewards they are earning through points and coupons. With this data, you can assess the effectiveness of your campaigns and identify which strategies drive the most engagement. [Learn more](/product-documentation/analytics/introduction-to-gameball-analytics)
The **Customers Behaviour & Engagement** page in the analytics will give you insights into your customers' behavior to better tailor your loyalty and retargeting strategy on Gameball.
***
## Where to Find the Campaign Performance Analytics Page
Go to **Gameball Dashboard**, and click **Analytics** from the left bar.
Click on the **Campaign Performance** page.
***
## What Is the Campaign Performance Analytics Page About?
The Customer Behaviour & Engagement analytics section gives you a detailed insight into how your customers are interacting with the deployed engagement programs using Gameball. It, therefore, leaves you with more knowledge of how Gameball is impacting your business and how it is contributing to achieving your targets and business goals.
Campaign Performance analytics provides you with insights into the reach and success of your reward campaigns. You can track how many customers interact with your campaigns, measure completion rates, monitor reward costs, and identify which campaigns drive the highest engagement.
***
## Campaign Performance Metrics
Number of members targeted by reward campaigns.
This shows the size of your audience for each campaign. A higher reach indicates campaigns are widely visible, but effectiveness depends on how many of these members actually participate and complete the campaign.
Number of members who completed reward campaigns.
This measures how many customers successfully fulfilled the requirements of your campaigns. Tracking this helps you understand actual engagement levels and whether campaign goals are realistic and motivating.
Total points spent on reward campaigns.
This tracks how many loyalty points have been distributed through campaigns over time. Monitoring this trend ensures your reward costs remain sustainable while still providing enough incentives to drive participation.
Tracks the campaign number of coupons over time.
This shows the volume of coupons issued through campaigns. A rising trend might indicate growing adoption of coupon-based rewards, while a decline could highlight a need to adjust coupon appeal.
Most successful campaigns are based on completion rates.
This identifies which campaigns resonated most with your customers, based on how many participants reached the finish line. Studying these campaigns can help you replicate success in future campaigns.
Top campaigns that give the most number of points.
This highlights the campaigns that are most generous with points. It helps you evaluate whether points-heavy campaigns are driving meaningful engagement or if adjustments are needed to balance cost and impact.
Top campaigns that give the most number of coupons.
This shows which campaigns issued the most coupons to customers. Reviewing these results allows you to assess if coupon-based rewards are effectively motivating customers to complete campaigns.
***
## What's Next?
Learn how to navigate and use the analytics section.
Analyze customer spending, order values, and purchase frequency.
# How Do I Track My Purchase Behaviour Using Gameball Analytics?
Source: https://docs.gameball.co/product-documentation/analytics/track-your-purchase-behaviour
Understand how your customers are behaving on your platform when it comes to placing orders and taking consecutive actions.
Having explained how to generally understand, use, and navigate through the analytics section on Gameball to learn about the performance of Gameball as a program and its influence on your business. [Learn more](/product-documentation/analytics/introduction-to-gameball-analytics)
The **Purchase Behaviour** page in the analytics section focuses on how much your customers spend on your store and provides further details on your customers' placed orders information.
***
## Where to Find the Purchase Behaviour Analytics Page
Go to Gameball **Dashboard**, and click **Analytics** from the left bar.
Click **Purchase Behavior** from the analytics navigation.
***
## What Is the Purchase Behaviour Analytics Page About?
Purchase Behaviour analytics gives you insights into customer purchase habits and how Gameball directly influences their spending. You'll find detailed data about order values, purchase frequency, lifetime value, and attributed revenue.
***
## Purchase Behaviour Metrics
Total number of purchases directly influenced by Gameball.
Shows the total number of purchases that were directly influenced by Gameball campaigns and activities. This helps you measure how much of your sales are driven by Gameball rather than organic or external sources.
Total revenue generated from purchases directly influenced by Gameball.
Reflects the total amount of revenue generated from purchases where Gameball had a direct impact. It quantifies Gameball's contribution to your business growth in terms of monetary value.
Tracks the revenue directly influenced by Gameball over time.
Displays how attributed revenue changes over time. Tracking this trend allows you to understand whether Gameball's influence is increasing, decreasing, or staying consistent during specific periods.
A comparison of your store's overall sales versus the portion of revenue directly influenced by Gameball.
Compares your overall store revenue with the portion of revenue directly influenced by Gameball. This view makes it easy to see how much of your total income comes from Gameball-driven actions.
The average amount spent per order by customers.
Calculates the average amount customers spend per order. Monitoring AOV helps you evaluate whether Gameball is encouraging higher-value purchases and whether customers are spending more in each transaction.
The number of purchases made per member over a given period.
Shows how many times a customer typically purchases within a certain period. High order frequency often signals strong customer loyalty and engagement, while lower frequency may highlight opportunities to re-engage.
The average number of items in each purchase.
Measures the average number of items customers include in each purchase. A larger basket size can indicate effective bundling strategies, cross-sell efforts, or the success of Gameball incentives in encouraging customers to add more items.
Compares customer lifetime value across different groups, such as one-time buyers, frequent buyers, and non-redeemers.
Compares customer lifetime value across different groups such as one-time buyers, frequent buyers, and non-redeemers. This breakdown helps you identify which groups contribute most to your long-term revenue and where you may need to focus retention strategies.
Shows how the average order value varies across different customer segments.
Highlights differences in spending behavior across customer groups. For example, frequent buyers may have a higher or lower average order value compared to one-time buyers, helping you tailor promotions for each group.
Breakdown of purchase frequency by different customer segments.
Breaks down purchase frequency across different customer segments. This shows whether certain groups are buying regularly, occasionally, or rarely, and supports strategies for encouraging repeat purchases.
Compares average basket size across one-time buyers, frequent buyers, and non-redeemers.
Compares average basket size across different customer groups (one-time, frequent, non-redeemers). Understanding these differences can help optimize upsell or cross-sell strategies for each segment.
Total number of orders or payments recorded over time.
Displays the total number of orders or payments recorded over time, regardless of their value. This helps you spot overall purchasing activity trends and assess whether engagement campaigns are driving more transactions.
***
## What's Next?
Learn how to navigate and use the analytics section.
Measure campaign reach, engagement, and rewards distribution.
# How Do I Track My Referral Performance Using Gameball Analytics?
Source: https://docs.gameball.co/product-documentation/analytics/track-your-referral-performance
Understand how the referral program is performing by tracking referral activity, success rates, and revenue generated from referrals.
The Referral Analytics page in the analytics section helps you evaluate the performance of your referral program. It shows how many referrals are being initiated, how many convert successfully, and the revenue impact from referred customers. With this data, you can measure how effective referrals are as a growth channel and identify your top advocates. [Learn more](/product-documentation/analytics/introduction-to-gameball-analytics)
***
## Where to Find the Referral Analytics Page
Go to **Gameball Dashboard**, and click **Analytics** from the left bar.
Click on the **Referral Analytics** page.
***
## What Is the Referral Analytics Page About?
Referral Analytics provides you with insights into how customers are inviting others to join your platform, how successful these invitations are, and how much revenue your referred customers are contributing.
***
## Referral Performance Metrics
Total referrals initiated but not yet converted.
This shows how many customers have been referred but have not yet completed the required referral action (such as signing up or placing their first order). A high number of pending referrals may suggest a gap in the referral funnel that needs optimization.
Total referrals that successfully converted after completing the required referral action.
This metric tells you how many referrals turned into actual new customers. Tracking successful referrals helps you measure the true effectiveness of your referral program.
Percentage of referrals that resulted in new customers.
This percentage indicates how efficient your referral program is at converting referred leads. A higher rate means your program is appealing and easy for customers to complete, while a lower rate may point to friction in the process.
Total revenue granted from referred customers.
This shows how much revenue was generated specifically from customers who joined through referrals. It helps you measure the direct financial return of your referral program.
The total revenue contribution of all referred customers.
This reflects the long-term value of referred customers by showing the overall revenue they contribute, not just their initial purchase. It helps you understand if referred customers are more valuable compared to non-referred ones.
Customers who granted the highest number of successful referrals.
This highlights your strongest brand advocates, the customers who bring in the most new business. Identifying these top referrers allows you to reward and retain them as loyal promoters of your brand.
To look up referral activity for a specific customer — including the names, emails, and status of every friend they referred — use the [Get Customer Referrals API](/api-reference/customers/progress/get-customer-referrals). The response includes each referred friend's status: `Active` (referral completed) or `Pending` (friend hasn't completed the required action yet).
You can also segment customers by referral status using the `referral_status` attribute — available in Segmentation, Automation Campaigns, Reward Campaigns, and Conditional Splits.
***
## What's Next?
Learn how to navigate and use the analytics section.
Analyze customer spending, order values, and purchase frequency.
Measure campaign reach, engagement, and rewards distribution.
Set up and configure your referral program.
# How Do I Create and Configure Email Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/create-and-configure-email-campaigns
A Step-by-Step guide to create and configure an Email Communication Campaign with Gameball.
Email marketing remains a cornerstone strategy for businesses, especially in e-commerce, offering a direct line of communication with customers. It's a vital tool for sharing updates on new products, collections, promo codes, and flash sales, fostering lasting relationships with buyers.
***
## Utilizing Gameball's Email Communication Campaigns
Gameball empowers you to customize email communication campaigns, including Guest emails, to enhance the customers' journey and drive engagement. With Gameball's Email Communication Campaign feature, you can create personalized emails for various scenarios, such as:
Announce new product lines and collections to keep customers informed and excited.
Highlight featured or top-selling products to drive customer interest.
Deliver exclusive discount codes directly to customers' inboxes.
Send thank-you messages to strengthen customer relationships and loyalty.
***
## Configuring an Email Campaign
To set up an email communication campaign from scratch in Gameball, follow these steps:
Navigate to the **Gameball Dashboard**.
Click on **Campaigns**.
Choose **Communication**, then click on the **Create Communication Campaign** button.
From the **Start from Scratch** section, choose **Emails**.
Now you have created a new Email communication campaign. Follow these steps to customize it based on your preferences:
***
### Step 1: Rules
In the **Audience** section, choose who will receive this email:
* **All Customers** (Registered & Unregistered)
* **Guest customers** (Unregistered Customer)
* **Registered Customers** (Customers with Accounts)
* **Specific Customers** based on:
* Segments
* RFM Segments
* Tags
* Customer Attributes
* Combination for Segments, Tags, or Customer Attributes
Define what **Triggers** sending this email to your audience. You can choose between:
* **Scheduled Based:** All your audience will receive this email at a scheduled time. You can decide between:
* **One-time:** Email will be sent only once
* **Recurring:** Email will be sent more than once
* **Action Based:** All of your audience will receive this email once they complete a specific action. All you have to do is select the event from the drop-down and add its filters.
Click **Save and Continue**.
***
### Step 2: Scheduling
Now let's set the timing for sending the email, based on the trigger that you chose in the previous step.
Choose one of these options:
* **Now**: The email will be sent once the campaign is set live
* **Later**: The email will be sent on the Start Date that you choose
Set up the following:
* **Start Date:** The date that we will start sending the emails
* **Repetition:** The number of times that the email should be sent, and the duration between each one.
* **End Date:** The date when we should stop sending the emails. You can choose:
* **Never**: the emails will always be sent out
* **Till**: A certain date after which the emails will stop being sent out.
* **Configure frequency:** Specify how often customers will receive the email:
* Unlimited number of messages per customer (Default)
* Limit the Number of messages per customer (Choose the Maximum number)
Set up the following:
* **Start Date:** The date that we will start sending the emails
* **End Date:** The date when we should stop sending the emails. You can choose:
* **Never**: the emails will always be sent out
* **Till**: A certain date after which the emails will stop being sent out.
* **Configure frequency:** Specify how often customers will receive the email:
* **Default**: Each customer will keep receiving messages without any capping until the end of the campaign
* **Custom**: Choose the number of times the email should be sent out, the duration between each email, and the maximum number of times the email should be sent.
Click **Save and Continue**.
***
### Step 3: Compose
Customize the email header with sender information, subject line, and domain.
Design the email body using a range of customization options, including text, images, buttons, links, dividers, menus, and HTML.
Ensure the email content aligns with the campaign goals and resonates with the target audience.
Click **Save and Continue**.
***
### Step 4: Goal
Define the goal of the email campaign, such as increasing sales or driving traffic to specific product pages.
Set event triggers and timeframes to monitor customer actions in response to the email.
Include strong calls-to-action in the email content to encourage desired customer behavior.
Click **Save and Continue**.
***
### Step 5: Preview
Review and edit configurations as needed.
Send a test message to preview the email before sending it to customers.
Finalize and send the email communication campaign to the target audience.
Lastly, click **Set live**.
***
## Viewing and Managing Configured Emails
* Access the **Communication Campaigns** section in the **Gameball Dashboard** to view all configured campaigns.
* Monitor key metrics such as triggers, audience, state, number of sent campaigns, clicks, and goal achievement percentage.
***
## Tracking Email Performance and Customer Interaction
* Gain insights into email performance and customer interaction by **selecting a specific campaign** and viewing details.
* Check the list of customers who received the email and track their engagement, including clicks and goal achievements.
***
## Deactivating or Deleting Email Communication Campaigns
* From the Communication Campaigns section in the Gameball Dashboard, select the desired email campaign.
* Click on the **three dots icon** to choose between **deactivating/activating** or **deleting** the campaign.
***
Set up web message campaigns to reach customers during their platform journey.
Set up push notification campaigns to engage customers on mobile devices.
Set up SMS campaigns for high-visibility, time-sensitive communications.
# How Do I Create and Configure Mobile Push Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/create-and-configure-mobile-push-campaigns
A Step-by-Step guide to create and configure a Mobile Push Notification Communication Campaign with Gameball.
Mobile push notifications serve as a powerful tool for engaging users and driving key actions within your mobile application. With Gameball's Mobile Push Communication Campaign feature, you can deliver targeted messages directly to their customers' devices, even when they're not actively using the app.
**Prerequisites:** Firebase Integration is required to send push notifications.
***
## Understanding Mobile Push Notifications
Mobile push notifications are brief, timely messages that appear on users' mobile device screens, allowing businesses to communicate with their audience in real-time. Unlike other forms of communication, mobile push notifications are highly visible and are less likely to be overlooked by users.
Here are some **ideas** for campaigns that you can send out:
Prompt loyal customers to share their referral link and earn rewards for bringing in new users.
Encourage customers to follow, share, or interact with your brand on social platforms.
Greet new customers with a push notification offering a welcome reward to boost early engagement.
Ask customers to subscribe to your newsletter for exclusive updates and offers.
***
## Configuring a Mobile Push Communication Campaign
To set up a Mobile Push communication campaign from scratch in Gameball, follow these steps:
Navigate to the **Gameball Dashboard**.
Click on **Campaigns**.
Choose **Communication Campaigns**, then click on the **Create Campaign** button.
From the **Start from Scratch** section, choose **Mobile Push**.
***
### Step 1: Rules
In the **Audience** section, choose who will receive this mobile push:
* **All Customers** (Registered & Unregistered)
* **Guest customers** (Unregistered Customer)
* **Registered Customers** (Customers with Accounts)
* **Specific Customers** based on:
* Segments
* RFM Segments
* Tags
* Customer Attributes
* Combination for Segments, Tags, or Customers Attributes
Define what **Triggers** sending this mobile push to your audience. You can choose between:
* **Scheduled Based:** All your audience will receive this mobile push at a scheduled time. You can decide between:
* **One-time:** Mobile Push will be sent only once
* **Recurring:** Mobile Push will be sent more than once
* **Action Based:** All of your audience will receive this mobile push once they complete a specific action. All you have to do is select the event from the drop-down and add its filters.
Click **Save and Continue**.
***
### Step 2: Scheduling
Now let's set the timing for sending the push notification, based on the trigger that you chose in the previous step.
Choose one of these options:
* **Now**: The mobile push will be sent once the campaign is set live
* **Later**: The mobile push will be sent on the Start Date that you choose
Set up the following:
* **Start Date:** The date that we will start sending the mobile push
* **Repetition:** The number of times that the mobile push should be sent, and the duration between each one.
* **End Date:** The date when we should stop sending the mobile push. You can choose:
* **Never**: the mobile push will always be sent out
* **Till**: A certain date that the mobile push will stop being sent out after.
* **Configure frequency:** Specify how often customers will receive the mobile push:
* An unlimited number of messages per customer (Default)
* Limit the Number of messages per customer (Choose the Maximum number)
Set up the following:
* **Start Date:** The date that we will start sending the mobile push
* **End Date:** The date when we should stop sending the mobile push. You can choose:
* **Never**: the mobile push will always be sent out
* **Till**: A certain date that the mobile push will stop being sent out after.
* **Configure frequency:** Specify how often customers will receive the mobile push:
* **Default**: Each customer will keep receiving messages without any capping until the end of the campaign
* **Custom**: Choose the number of times the mobile push should be sent out, the duration between each mobile push, and the maximum number of times the mobile push should be sent.
Click **Save and Continue**.
***
### Step 3: Compose
Customize the content and design of the communication campaign, including the message title and body text.
Craft a compelling message that grabs users' attention and encourages action, such as promoting new collections, products, sales, or promo codes.
Click **Save and Continue**.
***
### Step 4: Goal
Define the goal of the communication campaign, such as increasing product views, driving conversions, or boosting engagement.
Set event triggers and timeframes to monitor user actions in response to the communication campaign.
Click **Save and Continue**.
***
### Step 5: Preview
Review and edit the configured settings to ensure alignment with campaign objectives and user preferences.
Send a test message to preview the communication campaign before sending it to users.
Lastly, click **Set live**.
***
## Viewing and Managing Communication Campaigns
* Access the Communication Campaign section in the Gameball Dashboard to view all configured campaigns, including mobile push.
* Monitor key metrics such as triggers, audience, state, number of sent campaigns, clicks, and goal achievement percentage.
***
## Tracking User Interaction and Performance
* Gain insights into user interaction with communication campaigns by **selecting a specific campaign** and viewing details.
* Identify users who received the notification and track their engagement, including clicks and goal achievements.
***
## Deactivating or Deleting Communication Campaigns
* From the Communication Campaign section in the Gameball Dashboard, select the desired communication campaign.
* Choose to **deactivate/activate** or **delete** the campaign from the options menu.
***
Set up email campaigns to reach customers with personalized messages.
Set up web message campaigns to engage customers during their platform journey.
Set up SMS campaigns for fast, high-visibility mobile communications.
# How Do I Create and Configure SMS Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/create-and-configure-sms-campaigns
A Step-by-Step guide to create and configure an SMS Communication Campaign with Gameball.
SMS campaigns are an effective and immediate way to connect with customers through their mobile devices. With high open and response rates, SMS serves as a valuable communication channel for time-sensitive promotions, transactional updates, and personalized offers that drive real-time engagement.
***
## Utilizing Gameball's SMS Communication Campaigns
Gameball's SMS Communication Campaign feature allows businesses to craft and send tailored messages to customers based on behavior, segmentation, or specific triggers.
Share limited-time promo codes directly to customers' phones for instant redemption.
Notify customers about flash sales and time-sensitive offers they cannot miss.
Remind customers about their abandoned carts to recover lost sales.
Send thank-you messages or order status updates to keep customers informed.
SMS campaigns provide a concise and direct way to reach your audience, keeping them informed and engaged at the right moment.
***
## Configuring an SMS Communication Campaign
To set up an SMS communication campaign from scratch in Gameball, follow these steps:
Navigate to the **Gameball Dashboard**.
Click on **Campaigns**.
Choose **Create Communication Campaigns**, then click on the **Create Campaign** button.
From the **Start from Scratch** section, choose **SMS**.
***
### Step 1: Rules
In the **Audience** section, choose who will receive this SMS:
* **All Customers** (Registered & Unregistered)
* **Guest customers** (Unregistered Customer)
* **Registered Customers** (Customers with Accounts)
* **Specific Customers** based on:
* Segments
* RFM Segments
* Tags
* Customer Attributes
* Combination for Segments, Tags, or Customer Attributes
Define what **Triggers** sending this SMS to your audience. You can choose between:
* **Scheduled Based:** All your audience will receive this SMS at a scheduled time. You can decide between:
* **One-time:** SMS will be sent only once
* **Recurring:** SMS will be sent more than once
* **Action Based:** All of your audience will receive this SMS once they complete a specific action. All you have to do is select the event from the drop-down and add its filters.
Click **Save and Continue**.
***
### Step 2: Scheduling
Now let's set the timing for sending the SMS, based on the trigger that you chose in the previous step.
Choose one of these options:
* **Now**: The SMS will be sent once the campaign is set live
* **Later**: The SMS will be sent on the Start Date that you choose
Set up the following:
* **Start Date:** The date that we will start sending the SMS
* **Repetition:** The number of times that the SMS should be sent, and the duration between each one.
* **End Date:** The date when we should stop sending the SMS. You can choose:
* **Never**: the SMS will always be sent out
* **Till**: A certain date that the SMS will stop being sent out after.
* **Configure frequency:** Specify how often customers will receive the SMS:
* An unlimited number of messages per customer (Default)
* Limit the Number of messages per customer (Choose the Maximum number)
Set up the following:
* **Start Date:** The date that we will start sending the SMS
* **End Date:** The date when we should stop sending the SMS. You can choose:
* **Never**: the SMS will always be sent out
* **Till**: A certain date that the SMS will stop being sent out after.
* **Configure frequency:** Specify how often customers will receive the SMS:
* **Default**: Each customer will keep receiving messages without any capping until the end of the campaign
* **Custom**: Choose the number of times the SMS should be sent out, the duration between each SMS, and the maximum number of times the SMS should be sent.
Click **Save and Continue**.
***
### Step 3: Compose
Customize the content and design of the communication campaign, including the message title and body text.
Craft a compelling message that grabs users' attention and encourages action, such as promoting new collections, products, sales, or promo codes.
Click **Save and Continue**.
***
### Step 4: Goal
Define the goal of the communication campaign, such as increasing product views, driving conversions, or boosting engagement.
Set event triggers and timeframes to monitor user actions in response to the communication campaign.
***
### Step 5: Preview
Review and edit the configured settings to ensure alignment with campaign objectives and user preferences.
Send a test message to preview the communication campaign before sending it to users.
Lastly, click **Set live**.
***
## Viewing and Managing Communication Campaigns
* Access the Communication Campaign section in the Gameball Dashboard to view all configured campaigns, including SMS.
* Monitor key metrics such as triggers, audience, state, number of sent campaigns, clicks, and goal achievement percentage.
***
## Tracking User Interaction and Performance
* Gain insights into user interaction with communication campaigns by **selecting a specific campaign** and viewing details.
* Identify users who received the notification and track their engagement, including clicks and goal achievements.
***
## Deactivating or Deleting Communication Campaigns
* From the Communication Campaign section in the Gameball Dashboard, select the desired communication campaign.
* Choose to **deactivate/activate** or **delete** the campaign from the options menu.
***
Set up email campaigns to reach customers with personalized messages.
Set up web message campaigns to engage customers during their platform journey.
Set up push notification campaigns to reach customers directly on their devices.
# How Do I Create and Configure Web Message Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/create-and-configure-web-message-campaigns
A Step-by-Step guide to create and configure a Web Message Communication Campaign with Gameball.
Web messages play a crucial role in engaging customers, whether it's for up-selling, alerting, or spurring them into action on your platform. These **web-based** messages pop up at strategic moments during a customer's journey, encouraging them to take specific actions or explore new opportunities. Leveraging web messages effectively can significantly boost your platform's conversion rate and enhance overall customer engagement.
***
## Utilizing Gameball's Web Messages Communication Campaigns
Gameball's Web Messages Communication Campaigns feature enables businesses to deliver targeted and personalized messages to customers.
Display timely offers and deals as customers browse to drive immediate purchases.
Introduce customers to new arrivals and collections at the right moment in their journey.
Encourage customers to take action and finish reward campaigns for greater engagement.
These web messages offer a dynamic way to interact with your audience and drive desired behaviors.
***
## Configuring a Web Messages Communication Campaign
To set up a web message communication campaign from scratch in Gameball, follow these steps:
Navigate to the **Gameball Dashboard**.
Click on **Campaigns**.
Choose **Create Communication Campaigns**, then click on the **Create Campaign** button.
From the **Start from Scratch** section, choose **Web Message**.
Now you have created a new Web Message communication campaign. Follow these steps to customize it based on your preferences:
***
### Step 1: Rules
In the **Audience** section, choose who will receive this message:
* **All Customers** (Registered & Unregistered)
* **Guest customers** (Unregistered Customer)
* **Registered Customers** (Customers with Accounts)
* **Specific Customers** based on:
* Segments
* RFM Segments
* Tags
* Customer Attributes
* Combination for Segments, Tags, or Customer Attributes
Define what **triggers** are sending this web message to your audience. You can choose between:
* **Action Based:** All of your audience will receive this web message once they complete a specific action. All you have to do is select the event from the drop-down and add its filters.
* **Page Visit Based:** Each of your audience will receive this message when they visit a specific page on your website.
Click **Save and Continue**.
***
### Step 2: Scheduling
Now let's set the timing for sending the web message, based on the trigger that you chose in the previous step.
Set up the following:
* **Start Date:** The date that we will start sending the web messages
* **Repetition:** The number of times that the web message should be sent, and the duration between each one.
* **End Date:** The date when we should stop sending the web messages. You can choose:
* **Never**: the web messages will always be sent out
* **Till**: A certain date after which the web messages will stop being sent out.
* **Configure frequency:** Specify how often customers will receive the web message:
* An unlimited number of messages per customer (Default)
* Limit the Number of messages per customer (Choose the Maximum number)
Set up the following:
* **Start Date:** The date that we will start sending the web messages
* **End Date:** The date when we should stop sending the web messages. You can choose:
* **Never**: the web messages will always be sent out
* **Till**: A certain date after which the web messages will stop being sent out.
* **Configure frequency:** Specify how often customers will receive the web message:
* **Default**: Each customer will keep receiving messages without any capping until the end of the campaign
* **Custom**: Choose the number of times the web message should be sent out, the duration between each web message, and the maximum number of times the web message should be sent.
Click **Save and Continue**.
***
### Step 3: Compose
Customize the content and design of the web message, including the message title, body text, and optional message redirection.
Choose icons from Gameball's library or upload custom images to enhance the message's visual appeal.
Click **Save and Continue**.
***
### Step 4: Goal
Define the goal of the web message campaign, such as increasing product views or driving conversions.
Set event triggers and timeframes to monitor customer actions in response to the message.
Click **Save and Continue**.
***
### Step 5: Preview
Review and edit configurations as needed, ensuring the message aligns with campaign goals and customer preferences.
Send a test message to preview the web message before sending it to customers.
Lastly, click **Set live**.
***
## Viewing and Managing Configured Web Messages
* Access the Communication Campaigns section in the Gameball Dashboard to view all configured campaigns.
* Monitor key metrics such as triggers, audience, state, number of sent campaigns, clicks, and goal achievement percentage.
***
## Tracking Web Message Performance and Customer Interaction
* Gain insights into message performance and customer interaction by selecting a specific campaign and viewing details.
* Check the list of customers who received the message and track their engagement, including clicks and goal achievements.
***
## Deactivating or Deleting Web Messages Communication Campaigns
* From the Communication Campaigns section in the Gameball Dashboard, **select the desired web message campaign**.
* Click on the **three dots icon** to choose between **deactivating/activating** or **deleting** the campaign.
***
Set up email campaigns to reach customers with personalized messages.
Set up push notification campaigns to engage customers on their devices.
Set up SMS campaigns for fast, high-visibility mobile communications.
# What Are Dynamic Variables in Communication Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/dynamic-variables-in-communication-campaigns
Learn how to effectively use the dynamic variable for relevant communication after a completed transactional action from your customers.
Through Gameball, you can always create any sort of communication campaign such as emails, Web messages, Mobile Push, or SMS. In these messages' content, you can always use variables to personalize the message and make it more relevant.
For example, you can use info such as customer name, tier, referral line, etc. These communication campaigns could be triggered by actions a customer does.
Now, with every transactional-related action a customer takes, you can use a new set of dynamic action-related variables in your message based on the type of event that took place. For example, if a customer just completed an order, a triggered message could be sent that includes details of the order like the price and order id.
***
## What to Use the Dynamic Variables For
By allowing event-triggered messages to dynamically incorporate event properties into their content. Whether you're sending an email, web message, push notification, or SMS, you can now use event-specific data as variables within the message body.
This update is particularly useful for **transactional messages**, ensuring that every communication is relevant, personalized, and **context-aware**.
***
## Use Cases
Send an **automated renewal thank you message** via email, push, or SMS, including **customer-specific details** like the **subscription plan name, ID, and the amount charged**.
Example: *"Hey \[Customer Name], your \[Gold Membership] subscription was renewed successfully for \[Amount] and your payment ID is \[Payment ID]. Enjoy our uninterrupted benefits!"*
For e-commerce stores, dynamically **insert tracking numbers, estimated delivery dates, and tracking links** in emails and SMS.
Example: *"Your order \[#Order ID] has been shipped! Track your package here: \[Tracking Link]. Expected delivery: \[Delivery Date]."*
***
## How to Set Up and Trigger Transactional Communication Campaigns Using Dynamic Variables
From the left bar, go to **Campaigns** then **Communication**, then click **Create Communication Campaign**.
Choose the type of campaign.
Follow the normal configuration steps for creating a communication campaign.
Under **Triggers**, you must choose **Action based**.
Choose the type of transactional action you want to set as a trigger for the message. You can choose actions.
Proceed with the scheduling step. Afterwards, you will move to the **Composing** part.
In the **Composing** part, while composing the **Head** and **Body** of your message, you can integrate some variables into the message.
To use the event-related **Dynamic Variables**, scroll down the list to find them under **Event Variables**.
***
## How to Set Up and Trigger Transactional Email Campaigns Using Dynamic Variables
Emails usually have a slightly different configuration process. To create an email using dynamic variables, follow the first steps of creating an **action-based communication campaign**, then when you reach the step for writing the content or body of the email, click **Merge Tags** to use the event-related variables.
***
Learn how to build and configure email communication campaigns step by step.
Learn how to build and configure web message campaigns for real-time customer engagement.
# What Is Communication Campaigns?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/introduction-to-communication-campaigns
Discover Gameball's Communication Campaigns, formerly known as Outbound, to tailor messages for various purposes.
Gameball's Communication Campaigns, formerly known as Outbound, empower you to tailor messages for various purposes, including acquisition, retention, customer journey facilitation, and engagement. This feature serves as a versatile tool to complement campaigns and enhance program performance.
***
## Types of Communication Campaigns
Reach customers directly with personalized email messages for promotions, new collections, promo codes, and more.
Pop up timely messages during the customer's platform journey to upsell, alert, and drive action.
Send targeted push notifications directly to customers' mobile devices to boost retention and engagement.
Deliver fast, high-visibility text messages for time-sensitive promotions, updates, and personalized offers.
Send personalized WhatsApp messages to customers for promotions, loyalty updates, and engagement. Available as an add-on — contact [support@gameball.co](mailto:support@gameball.co) to enable it.
### Emails
Email marketing is a ubiquitous strategy across industries to boost sales, conversion rates, and retention. Unlike other channels, emails are always accessible by customers, ensuring message permanence. Emails are sent to registered customers and guests who have previously made at least one order. Segmentation and triggers enable personalized email delivery based on customer information or actions. [Learn how to set up an Email campaign](/product-documentation/communication-campaigns/create-and-configure-email-campaigns).
Gameball also offers [pre-designed email templates](/product-documentation/communication-campaigns/templates/email-campaigns-templates) for quick campaign setup.
### Web Messages
Web messages enable real-time communication with customers during their platform journey. Ideal for upselling, alerts, and motivating customers to take action or complete and win reward campaigns. Pop-up messages prompt customers to engage with campaigns, daily deals, or offers, driving conversion rates. Customizable triggers ensure the timely delivery of web messages tailored to customer behavior. [Learn how to set up a Web Message campaign](/product-documentation/communication-campaigns/create-and-configure-web-message-campaigns).
Leverage a variety of [ready-made web message](/product-documentation/communication-campaigns/templates/web-messages-campaigns-templates) templates to streamline campaign creation.
### Mobile Push
Mobile push notifications provide a direct channel to reach customers at any time. Effective for promoting hot deals and encouraging platform revisits to boost customer retention and sales. Configurable triggers allow targeted push notifications based on customer behavior or segments. [Learn how to set up a Mobile Push campaign](/product-documentation/communication-campaigns/create-and-configure-mobile-push-campaigns).
Leverage a variety of [ready-made mobile push notification templates](/product-documentation/communication-campaigns/templates/push-notification-campaigns-templates) to streamline campaign creation.
### SMS
SMS campaigns offer a fast and highly effective way to reach customers directly on their mobile devices. With high open rates and immediate visibility, SMS is ideal for time-sensitive promotions, order updates, or important announcements. Messages can be tailored based on customer segments or triggered by specific actions to ensure timely and relevant communication. [Learn how to set up an SMS campaign](/product-documentation/communication-campaigns/create-and-configure-sms-campaigns).
### WhatsApp
WhatsApp messaging lets you reach customers on the world's most widely used messaging platform. Available as an **add-on** for any plan — contact [support@gameball.co](mailto:support@gameball.co) to enable it.
***
## Creating a New Communication Campaign
Navigate to the **Gameball Dashboard** and click on **Campaigns**.
Choose **Communication**, then click on the **Create Campaign** button.
Choose the desired type of campaign if you want to start from scratch: **Emails**, **Mobile Push**, **Web Messages**, or **SMS**.
Or choose from the [ready-made templates](/product-documentation/communication-campaigns/templates/email-campaigns-templates) for each type.
Follow the intuitive setup process to customize the campaign based on your objectives and audience, or check out these articles to learn how to configure a communication campaign from scratch.
***
## Monthly Contacted Customers (MCC)
MCC stands for **Monthly Contacted Customers** — the number of unique customers you contact via non-transactional communication in a given month. It is the base unit for measuring your outbound messaging usage.
**How MCC is counted**: If you send a customer 3 push notifications and 2 emails in the same month, they count as **1 MCC** — not 5. Only unique customers contacted per month are counted, regardless of how many messages they receive.
MCC includes all three outbound channels:
| Channel | Counted toward MCC? |
| --------------------- | ------------------- |
| Email | Yes |
| Mobile Push | Yes |
| Web Messages (In-app) | Yes |
| SMS | Yes |
| WhatsApp | Yes |
**Channel sending limits relative to your MCC quota:**
| Channel | Max messages per MCC unit |
| ------------ | ------------------------------- |
| Email | Up to **10x** your MCC quota |
| Mobile Push | Up to **100x** your MCC quota |
| Web Messages | Up to **1,000x** your MCC quota |
For example, if your plan includes 1,000 MCC, you can send up to 10,000 emails, 100,000 push notifications, or 1,000,000 web messages per month — or any combination across channels.
Shopify plans (PRO and Guru) include a flat email limit of 10,000 emails per billing cycle, independent of MCC. [Learn more about tracking email consumption on Shopify](/product-documentation/guides-strategies-faqs/shopify-guides/track-email-consumption).
***
## Filtering Your Communication Campaigns
Use filters to quickly find and manage campaigns in your list.
| Filter | Description |
| ------------ | -------------------------------------------------------------------- |
| **Audience** | Filter campaigns by their target audience or segment. |
| **Triggers** | Filter by the trigger type used to activate the campaign. |
| **Channel** | Filter by delivery channel: Email, Web Message, Mobile Push, or SMS. |
| **Status** | Filter by campaign status: Active, Scheduled, Draft, or Archived. |
***
Learn about Gameball's Rewards Campaigns and how to set up challenges and rewards for customers.
Learn about Gameball's Automation Campaigns to trigger personalized messages and rewards automatically.
# How to Segment Customers?
Source: https://docs.gameball.co/product-documentation/customer-segmentation/how-to-segment-customers
Understand how to create and manage customer segments using Gameball's segmentation to personalize your campaigns and enhance targeting.
| Platform | Plan |
| -------------------- | ---------------------------------------------- |
| Shopify | Starter (create up to 3 Segments), Pro, & Guru |
| Salla | Pro, & Guru |
| Non-platform clients | Growth & Enterprise |
When creating segments with specific conditions and rules, you gain valuable insights into your customer base and their behavior. This allows you to plan more efficient, data-driven marketing strategies that improve overall performance.
***
## How to Create Segments
Creating a new segment is simple. Begin by identifying the criteria you want to target from your wide customer base. For instance, you can create a segment for female customers who have been active within the past 30 days and frequently visit a specific product category. Once these rules are configured, Gameball automatically identifies any customer who meets the criteria and adds them to the segment.
Go to the **Gameball dashboard**.
Navigate to **Customers** > **Segments** tab.
Click **Create New Segment**.
Fill in the segment's general information:
* **Segment Name:** Use a descriptive name, e.g., *Engaged Customers*.
* **Segment Tag Name:** Provide a short label, e.g., *Engaged*.
* **Color:** Choose a color for the tag.
Proceed to add segmentation rules using the rule engine described below.
***
## How to Use the Segmentation Rule Engine
You can create a segment using a single or multiple conditions. Begin by creating the first rule.
When selecting **Customer Attribute**, choose the customer profile data that will determine segment membership.
| Category | Attributes |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Customer Info** | Customer Email, Mobile Number, Gender, Date Of Birth, Customer Creation Date, Customer Join Date, Is Guest Customer, Is Referred, Country, City, Zip Code |
| **Engagement** | Score, Points, Tier, Channel, Merchant, Branch, Last Login Date |
| **Order Data** | Total Orders Count, Total Amount Spent, Last Order Date, Average Order Value |
| **Gameball Tracked** | Last Captured Order Date, Average Captured Order Value, Total Captured Orders, Total Captured Amount Spent |
| **Redemption** | Total Redeemed Amount, Total Redemptions, Last Redemption Date, Last Coupon Usage, Last Gameball Coupon Usage |
| **Referral** | Total Referrals, Last Referral Date |
| **Communication** | Last Message Sent Date, Last Email Sent Date |
| **UTM Tracking** | UTM Campaign, UTM Source, UTM Medium, UTM Content, UTM Term |
| **Device Info** | Device, Browser, Operating System |
| **Product Data** | Product ID, SKU, Category, Collection, Product Title, Quantity Purchased (per product), Price (per line item) |
| **Spending** | Total Spent, Orders Count |
After choosing the attribute, define its metadata values accordingly.
1. "Total captured orders" is calculated via Gameball, which counts the number of orders sent via the Order API. However, "total amount spent" relies on you sending the total orders of every customer via the API. Choose the correct attribute based on whether you need data from your side or data counted by Gameball.
2. All attributes automatically calculated and maintained by Gameball are visually prefixed with **"Gameball"** so you can recognize them amongst your custom attributes sent through API.
Events represent actions customers perform on your platform.
To create an event-based segment rule:
1. Select the relevant **Customer Event**.
2. Define the **event metadata**.
For example, if the event is "viewing a product," you can filter it to include customers who viewed a product in the *Accessories* category at least three times.
You can also:
* Click **Add Event Filter** to add more metadata filters to a single event.
* Click **Add Condition** to include multiple conditions under the same rule.
You can create customer segments based on **actual order data**, providing more accurate, real-time customer targeting.
Available order data includes:
* Count
* First Occurrence
* Last Occurrence
* Total Order Value (excluding fully refunded orders)
* Order Date Range
* Average Order Value
* Specific Order Value Ranges
Fully refunded orders are excluded by default from the calculations.
***
## Common Questions
Yes. You can combine both customer profile attributes and behavior-based events in one segment. For example:
* Female customers
* Under 50 years old
* Recently active on your platform
* Made at least one purchase or added an item to the cart within the past month
This allows for precise targeting using detailed, multi-criteria rules.
After adding the first rule:
1. Click **Add Rule**.
2. Choose the correlation type between rules:
* **AND:** Customers must meet all rules.
* **OR:** Customers must meet at least one rule.
3. Repeat the rule setup process for each additional rule.
You can add **unlimited rules** to a segment — there is no cap on the number of conditions.
A single operator (AND or OR) applies uniformly across all rules in a segment. You cannot mix AND and OR within the same segment, and nested groupings with brackets (e.g., `(A AND B) OR C`) are not currently supported.
To view details about an existing segment:
1. Go to the **Segments** tab on the Gameball dashboard.
2. Scroll to the list of created segments.
3. Click on the name of the segment you want to explore.
You will be directed to the segment details page, which includes:
* The rules that define the segment
* The number and types of communication campaigns sent to customers in the segment
* A chart displaying how many customers joined the segment per day
* A full list of customers in the segment
Date-based attributes like **Customer Creation Date** support **After** and **Before** operators, but not a single "between" operator.
To define a date range, combine two rules using **AND** logic:
* Rule 1: `Customer Creation Date` **After** `31/12/2024`
* Rule 2: `Customer Creation Date` **Before** `01/01/2026`
This returns all customers whose creation date falls within the year 2025.
Quick filters by year, quarter, or month are not currently available. Use the After + Before combination to achieve the same result.
**Advanced Filters**
A **Filter** option is available in the Segments table header, allowing you to refine your segment list using:
* **Status / Tag** (e.g., active, inactive, draft)
* **Creation Date** (date range selection)
* **Customer Count Range**
Multiple filters can be applied together and updated instantly. A **Clear Filters** control restores the full segment list with one click.
**Table Sorting**
You can sort segments directly from the table by selecting column headers:
| Column | Sort Options |
| ------------------ | ------------------------- |
| **Segment Name** | A-Z / Z-A |
| **Creation Date** | Newest / Oldest |
| **Customer Count** | High to Low / Low to High |
The chosen sorting order remains active until manually reset.
# What Is Segmentation?
Source: https://docs.gameball.co/product-documentation/customer-segmentation/introduction-to-segmentation
Use dynamic segmentation to automatically group and target customers based on their behavior and profile attributes.
| Platform | Plan |
| -------------------- | -------------------------- |
| Shopify | Free, Starter, Pro, & Guru |
| Salla | Starter, Pro, & Guru |
| Non-platform clients | Growth & Enterprise |
Customer segmentation enables you to target specific groups of customers for personalized communication, reward campaigns, and more. With Gameball, segmentation is dynamic and automatic, saving you the time and effort of manually grouping customers and keeping your segments up to date.
***
## The Problem Segmentation Solves
Have you ever wanted to create a challenge, send a message, or apply a redemption rule that only applies to a specific group of customers — but could not figure out how to isolate and target them accurately? Even when you managed to identify these customers, applying manual tags became time-consuming and inaccurate, especially since customers' behavior changes frequently. By the time you have tagged a customer, they may no longer belong to the intended group.
To solve this challenge, Gameball introduced **Customer Segmentation** — a feature that creates dynamic lists of customers who automatically qualify based on the criteria you set.
***
## How Customer Segmentation Works
Customer segmentation automatically groups your customers based on their behavior and profile data. Unlike manual tags, segments are dynamic: Gameball evaluates your customer base daily and automatically adds or removes customers based on whether they meet the defined conditions.
When a customer meets all the conditions of a segment, they are automatically added to it. If their data changes and no longer matches those conditions, they are automatically removed.
***
## Why Segment Customers?
Segmentation helps you gain valuable insights and execute targeted marketing strategies. With Gameball, you can:
* Gain deeper insights into customer behavior.
* Build dynamic, data-driven, and personalized marketing strategies.
* Target specific customer groups across various Gameball features.
Reward only specific segments with tailored challenges and incentives.
Apply rules like free shipping to customers within certain segments.
Launch targeted campaigns or send messages to selected segments.
***
## Existing Segments vs. Custom Segments
Gameball provides two built-in segments that help you monitor essential customer behaviors:
* Last login: within the last 30 days
* OR last order date: within the last 30 days
* **Color:** Green
* **Segment Tag:** Active
* Last login: more than 60 days ago OR login is empty
* Last order date: more than 90 days ago
* **Color:** Orange
* **Segment Tag:** Inactive
In addition, you can create, edit, or delete your own segments based on your business needs.
***
## How to Create Segments
Go to the **Gameball Admin Dashboard**.
Navigate to **Customers** > **Segments**.
Click **Create New Segment**.
Define the conditions for your segment. For example:
* Female customers
* Active in the past 30 days
* Frequently visit a specific product category
Once the segment is saved, Gameball automatically identifies and groups customers who meet all of these criteria.
For more details on how to use the segmentation engine and understand the available operators, refer to [How to Segment Customers](/product-documentation/customer-segmentation/how-to-segment-customers).
***
## Segment Usage in Automations
Each segment shows which automation campaigns use it as a trigger — specifically whether it's used as an **Entered Segment** or **Exited Segment** trigger — along with each automation's live status.
This gives you full visibility before making changes, so you can avoid accidentally breaking active automations when editing or deleting a segment.
If a segment is used by one or more active automations, you'll see them listed directly on the segment's page. Review these dependencies before making any structural changes to your segment conditions.
***
## Common Questions
Yes, segments can be used with challenges, messages, and redemption rules.
Yes. Segments are evaluated daily — if a customer's data changes and they meet the criteria again, they will be added back in the next daily refresh.
Yes, you can modify or delete both system-generated and custom segments at any time.
Tags are added manually and stay fixed. Segments are dynamic — Gameball constantly checks if customers meet the conditions and updates the list automatically.
It means the segment updates automatically. Customers can enter or leave a segment based on their current data — Gameball evaluates all segments on a daily basis.
***
## Related Articles
Learn how to create and manage customer segments using the segmentation engine.
Explore practical use cases for customer segmentation combined with other Gameball features.
Understand RFM analysis and how Gameball automatically segments customers.
# What Is Gameball's RFM Segments?
Source: https://docs.gameball.co/product-documentation/customer-segmentation/rfm-segments/introduction-to-rfm-segments
Understand the concept of RFM analysis and segmentation and how to use them to reach your business goals.
| Platform | Plan |
| ------------ | ------------------- |
| Shopify | Start, Pro, & Guru |
| Salla | Pro, & Guru |
| Non-Platform | Growth & Enterprise |
***
Segmenting customers is the first step toward making your marketing efforts more effective. By targeting customers based on similar behaviors and spending habits, you can create personalized campaigns and build stronger customer loyalty. In this article, learn how Gameball automatically segments customers using the RFM model.
RFM customer segmentation focuses on purchasing behavior rather than demographic or psychographic data. This model allows you to identify high-value customers and tailor your retention and engagement strategies accordingly.
***
## What Is RFM?
**RFM** stands for **Recency**, **Frequency**, and **Monetary Value** — a data-driven segmentation technique based on:
| Dimension | Definition |
| ------------------ | ------------------------------------------------------ |
| **Recency** | When the customer last made a purchase from your store |
| **Frequency** | How often the customer makes purchases |
| **Monetary Value** | The amount of money the customer spends |
Businesses that use RFM analysis gain a clearer picture of their customers' lifetime value, helping them decide which customers to retain and how to allocate marketing resources efficiently.
***
## What Is an RFM Analysis?
To conduct an RFM analysis, you assign scores to customers based on their recency, frequency, and monetary value. These scores, when combined, categorize customers into actionable segments.
**With Gameball, there is no need to manually assign scores or build these segments yourself.** Gameball performs the RFM analysis for you and automatically creates seven pre-defined customer segments.
***
## Gameball's RFM Segments
The following segments are created automatically by Gameball based on RFM data:
| Segment | Description |
| ----------------- | ------------------------------------------------------------------------------------------ |
| **Best Buyers** | Customers with the highest purchase frequency, most recent activity, and highest spend. |
| **Loyal** | Customers with high recency and monetary value who purchase frequently. |
| **New Customers** | Customers who have just joined your store. |
| **Promising** | Customers who are moderately active, make occasional purchases, and respond to promotions. |
| **Can't Lose** | Customers who previously made large purchases but have not returned in a long time. |
| **About to Lose** | Inactive customers with low frequency and low spend. |
| **Lost** | Customers with the lowest scores in recency, frequency, and monetary value. |
* Gameball does not remove outliers; however, RFM works on percentiles, not absolute numbers.
* RFM is refreshed once a day.
Use these segments to craft personalized campaigns that suit each customer group's behavior and needs. RFM segmentation is a powerful tool to guide your customer acquisition and retention strategies. [Learn more](/product-documentation/customer-segmentation/rfm-segments/using-rfm-segments-to-serve-your-goals).
***
## Understanding a Customer's RFM Score
You can view the exact R, F, and M values behind any customer's segment assignment, along with a plain-language explanation of why they were placed in that segment.
This explainability helps you:
* Understand what drove a customer into a specific segment
* Spot customers who are close to moving into a higher-value segment
* Make more informed decisions about who to target and how
To view a customer's RFM breakdown, navigate to **Customers > RFM Segments**, select a segment, then click on any customer to see their individual Recency, Frequency, and Monetary scores alongside the explanation behind their assignment.
***
## Where to Find RFM Segments on Gameball
Go to the **Gameball dashboard**.
From the left-hand bar, click **Customers**, then **RFM Segments**.
***
## Related Articles
Learn how to use RFM segments to retain, engage, and grow customer loyalty.
Understand how dynamic segmentation works in Gameball.
# How Do I Use RFM Segments to Serve My Goals?
Source: https://docs.gameball.co/product-documentation/customer-segmentation/rfm-segments/using-rfm-segments-to-serve-your-goals
Learn more about the RFM segments Gameball has created, and how to use them to help retain, engage, and make players more loyal.
| Platform | Plan |
| ------------ | ------------------- |
| Shopify | Start, Pro, & Guru |
| Salla | Pro, & Guru |
| Non-Platform | Growth & Enterprise |
***
RFM segmentation allows you to divide your customer base into clear groups based on their purchasing habits. You can use these segments to better understand your audience and take tailored actions that enhance engagement, retention, and loyalty. [Learn more about RFM segmentation](/product-documentation/customer-segmentation/rfm-segments/introduction-to-rfm-segments).
This article guides you through how to use RFM segments effectively to support your business goals, whether you are focused on customer acquisition, retention, or reactivation.
***
## How to Know More Details About RFM Segments
On the **RFM Segments** page, hover over any segment to view key details, including:
* Segment description
* Last order date
* Number of orders
* Average amount spent
* Gameball does not remove outliers; however, RFM works on percentiles, not absolute numbers.
* RFM is refreshed once a day.
To explore the full customer list within a specific segment, scroll down and click **View Customers** under the segment description. You will be taken to that segment's details page, where you can see all customers and apply various bulk actions.
***
## Available Actions for RFM Segments
For each RFM segment, you can:
* Filter & Sort the Customer lists
* Add or deduct points
* Reward a Campaign
* Apply tags
* Include or exclude customers from the loyalty program
* Update or migrate customer information
* Extract the list
You can also view how many outbound messages were sent to customers under each segment, as well as a summary of the segment's sales.
***
## Applying Retention Strategies Using RFM Segments
Segmenting your customers using RFM is a crucial step toward delivering more personalized and effective engagement. Once your customers are categorized, you can tailor campaigns and strategies that match the unique behavior of each segment.
For example, with the **Best Buyers** segment, you may want to reward these high-value customers with exclusive offers to ensure they remain active and loyal. For customers in segments like **About to Lose** or **Lost**, focus on reactivation tactics such as time-limited discounts or reminders.
Gameball supports you with recommended actions and ready-made templates for each segment, helping you build strategies that align with your goals.
***
## Where to Find the Suggested Retention Strategies
Beside each segment on the **RFM Segments** page, click **Retention Strategy for Your Customers**. A list of suggested actions will appear — choose the action that best fits your goal.
***
## What Happens When You Choose to Create a Campaign
You will be redirected to the configuration page of a Communication or Rewards campaign that is targeting the exact segment you initially chose. Complete the rest of the campaign's details, such as composing the message, and then set it live.
Learn more about creating a Communication or Reward Campaign in the relevant sections of the documentation.
***
## Related Articles
Understand the concept of RFM analysis and how Gameball uses it to segment customers.
Learn how to create and manage customer segments using the segmentation engine.
# What Are Some Use Cases for Segmentation?
Source: https://docs.gameball.co/product-documentation/customer-segmentation/segmentation-use-cases
Use cases on how to fully utilize Customer Segmentation combined with other Gameball features.
| Platform | Plan |
| -------------------- | -------------------- |
| Shopify | Starter, Pro, & Guru |
| Salla | Pro, & Guru |
| Non-platform clients | Growth & Enterprise |
Segmentation is one of the most impactful tools you can use to personalize your marketing efforts and increase return on investment (ROI). With Gameball's segmentation feature, you can identify and act on specific customer behaviors, interests, and engagement levels to optimize your communication and retention tactics.
Targeting the mass market without distinction is no longer an effective approach. Instead, focusing on well-defined customer segments allows you to deliver the right message to the right audience.
***
## Customer Segments and Tactics
Gameball enables you to identify and engage with multiple customer segments. Below are four common and highly valuable segments, along with tactics to improve their engagement:
| Segment | Description |
| --------------------------- | --------------------------------------------------------------------------------------- |
| **The Champions** | Your top-performing VIP customers who contribute a significant portion of your revenue. |
| **Product Viewers** | Customers who explore your products but do not proceed to checkout. |
| **Slipping Away Customers** | Customers who are showing signs of churn and disengagement. |
| **The Buyer** | Segments customers into groups based on different purchasing behavior. |
***
## The Champions (VIP Customers)
### Identify Bases for Segmentation
A VIP customer could be someone who:
* Made a purchase within the last 30 days
* Spent over \$5,000 in total
### Create a New Segment
Select **Customer Attribute** as the segmentation type.
Use **Last Order Date** as the filter attribute, set the operator to **less than**, and set the time frame to **30 days**.
Add another filter: **Total Amount Spent** with the operator **greater than** and the value set to **\$5,000**.
### Alternative Segment Criteria
You may also define VIP customers as those who:
* Placed more than 5 orders
* Referred more than 3 friends
* Redeemed points recently
Select **Event** as the segmentation attribute and choose **Place Order**, with **Count greater than 5**.
Add a **Customer Attribute** for **Total Referrals greater than 3**.
Optionally, filter by **Last Redemption Date less than 3 days**.
**Use Other Gameball Features**
* Create a **custom reward campaign** for this segment to earn extra points.
* Visit the configured segment, click **Reward a Challenge**, and assign a pre-configured challenge with tailored rewards.
***
## The Product Viewers
### Identify Bases for Segmentation
For instance, if your **jeans product page** is frequently visited but sees low conversions:
### Create a New Segment
Choose **Event** as the segmentation type. Select **View Product Page**, and use the **First Occurrence greater than 30 days**.
Add a second filter:
* Event: **View Product Page**
* Add an **Event Filter:** Product Title **contains** "jeans"
**Use Other Gameball Features**
* Create a special **redemption rule** for this segment under **Points Redemption Settings**.
* Offer promotional discounts specific to the product category.
***
## The Slipping Away Customers
### Identify Bases for Segmentation
Disengaged customers are at high risk of churn. You may consider a customer as slipping away if:
* No orders in the last 90 days
* No website visits in the last 60 days
* No point redemptions in the last 90 days
### Create a New Segment
Use **Customer Attribute: Last Order Date More than 90 days**.
Add **Customer Attribute: Last Login Date greater than 60 days**.
Add **Customer Attribute: Last Redemption Date greater than 90 days**.
**Use Other Gameball Features**
* Create a **scheduled challenge** for this segment with an **achievement reward**.
* Set up an **email notification** to communicate the reward and encourage re-engagement.
***
## The Buyer: Product-Level Order Segmentation
You can create **highly targeted and personalized campaigns** by analyzing **specific product purchase behavior**. Segment customers based on the exact products and quantities purchased in actual orders.
For example:
* Target customers who purchased a specific SKU.
* Segment customers buying a particular category or high-quantity product.
**Product Line Item Filters:**
| Filter | Description |
| ---------------------- | ------------------------------------------------- |
| **Product ID** | Target customers who purchased a specific product |
| **SKU** | Filter by stock-keeping unit |
| **Category** | Segment by product category |
| **Collection** | Target purchasers from a specific collection |
| **Product Title** | Filter by product name |
| **Quantity Purchased** | Filter by the quantity purchased per product |
| **Price** | Filter by price per line item |
***
## Customers with High Return Rates
In industries like fashion, high return rates eat into margins and signal potential program abuse. You can segment customers by how many returns they've made using the `order_refunded` event.
### Create a New Segment
Choose **Event** as the segmentation type. Select **order\_refunded**.
Set the operator to **Count greater than** and enter your threshold (e.g., **3**) to target customers with 3 or more refunds.
**Use Other Gameball Features**
* Exclude high-return customers from bonus point campaigns to reduce liability.
* Create a dedicated segment for low-return, high-spend customers and reward them for their behavior.
***
* All segments in Gameball are dynamic. The system continuously updates customer groupings based on real-time behavior and data.
* Avoid static segmentation to ensure the ongoing relevance and effectiveness of your campaigns.
***
## Related Articles
Learn how to create and manage customer segments using the segmentation engine.
Understand RFM analysis and how Gameball automatically segments customers.
# How Do I Enable Customer Account Creation on Shopify?
Source: https://docs.gameball.co/product-documentation/getting-started/faqs/enable-customer-account-creation-on-shopify
A mandatory step to start rewarding your customers using Gameball.
In order to start rewarding your customers, you need to enable account creation on Shopify. If your customers are not able to create an account for your Shopify website, they will not be able to enroll in Gameball rewards experience.
## How to Enable Account Creation on Shopify?
To enable account creation, please follow the below steps:
Sign in to your Shopify admin and click **Settings** in the bottom left corner of the page.
Click **Checkout** from the settings options.
Under "Customer Accounts", make sure that you have customer accounts set to either **"optional"** or **"required"**.
When you have made the change, click **Save** in order to allow your customers to set up accounts and join Gameball rewards experience.
***
## What's Next?
Launch the Gameball experience and widget on your store.
Let customers redeem their points as discounts at checkout.
Transfer your existing customers to Gameball on Shopify.
# What Are Gameball Plans and Subscriptions?
Source: https://docs.gameball.co/product-documentation/getting-started/faqs/gameball-plans-and-subscriptions
Learn how your rewarded players are calculated and check what happens when you uninstall or downgrade your Gameball plan.
Below are the most commonly asked questions and answers about Gameball subscription plans.
If you are on the new Gameball plans (joined after the 4th of March, 2024), this article might be irrelevant. [Please check this article for relevant information](/product-documentation/guides-strategies-faqs/shopify-guides/calculate-monthly-rewarded-customers).
Gameball charges you based on the actual rewarded customers. Your rewarded customers are the users that are enrolled in the rewards programs and have points.
Rewarded players that do not have any points do not take part in the calculations.
Each pricing plan is restricted to a limited number of rewarded users and when this number is exceeded, you will be additionally charged per each rewarded customer. Check the rate per extra rewarded customer [here](https://app.gameball.co/signup).
For example, the **Pro** plan supports up to 5000 rewarded customers a month. When the number of rewarded customers exceeds 5000, a charge of \$0.02 will be added per each extra customer above 5000.
When uninstalling Gameball, all program configurations are going to be deleted instantly without possible reverse, consequently, this cancels your subscription.
Each pricing plan has a limited set of features. When you downgrade from one plan to another, you lose all the extra features you had in your previous plan, however, you will still have access to all configurations done within your plan.
For example, if you downgraded from Pro to Free. The Free plan allows four challenges and two levels only, when downgrading, all other configurations that exceed the four challenges and two levels will be deleted.
***
## Related Articles
Understand how Gameball calculates monthly rewarded customers on Shopify.
# How Do I Get Started with Gameball?
Source: https://docs.gameball.co/product-documentation/getting-started/launch-checklist
A quick walk-through on the essential steps to take before launching your loyalty experience.
Follow these essential steps to build and launch your loyalty experience on Gameball.
If you installed Gameball on Shopify before April 29, your setup experience looks different. See the **Shopify (Installed Before Apr 29)** tab for your setup guide.
When you first access Gameball on Shopify, you're guided through a quick setup that launches a fully configured loyalty program in just a few minutes. Based on your inputs, Gameball automatically prepares your program and suggests campaigns aligned with your business goals — no technical setup required.
***
### Setting Up Your Loyalty Program
#### Step 1: Meet Sarah
You'll be greeted by Sarah, who walks you through the setup step by step. Click **Let's get started** to begin.
#### Step 2: Answer a Few Questions
Sarah asks for a few key inputs to tailor the experience to your business:
Sarah uses your industry to set earn rates and tier structure as a starting point. You can adjust everything after setup.
This tells Sarah the price range of your products so she can calibrate reward values that feel meaningful to your customers.
Sarah uses your goals to decide which features to prioritize — for example, if increasing retention is your main focus, she'll configure the program accordingly.
Choose how the loyalty widget looks to your customers. This is what they'll see when they interact with their rewards.
Confirm you're ready to go. Sarah finalizes your program and hands off to Adam for campaign suggestions.
#### Step 3: Your Program Is Ready
Based on your answers, Gameball automatically:
* Sets up your loyalty structure
* Configures your points and rewards logic
* Prepares your customer-facing widget
* Aligns everything with your stated business goals
From here, you can review your setup, make any adjustments, and launch your program. You don't need to handle any technical configuration.
***
### Revenue Risks & Opportunities
Once your program is ready, Adam analyzes your Shopify store — order history, customer behavior, and revenue patterns — and surfaces two types of insights on your homepage:
* **Risk** — A customer segment performing below expected benchmarks on a specific metric, such as AOV, purchase frequency, or basket size. A risk is always tied to a defined segment, not a general signal about overall store performance.
* **Opportunity** — A segment performing at or above the expected benchmark, or showing clear untapped revenue growth potential based on behavioral signals.
Each card shows a **revenue impact** figure — the dollar amount you stand to gain (opportunities, marked **+**) or lose (risks, marked **−**). This reflects the gap between what the segment generates today and what it could generate if the targeted metric improved, or what you stand to lose if the trend continues (e.g., declining frequency, falling AOV, or customer churn).
Unactioned risks and opportunities stay at the top of your homepage. Once you launch a campaign against one, it moves to **In Progress Campaigns** — keeping what still needs attention front and center.
For each risk or opportunity, Adam recommends a campaign with the segment, reward, and budget pre-configured. You can view the full configuration summary, launch directly from the card, or regenerate an alternative. AI-generated segments and campaign recommendations are labeled with an **AI** badge so you can identify them at a glance.
***
### Re-generating a Campaign
If a campaign doesn't feel right for your store, click **Re-generate** on any card.
When you do this:
* The risk / opportunity stays the same
* A new variation is created with adjusted reward amounts and campaign structure
You can re-generate as many times as you need before launching. This lets you quickly explore different approaches without building a campaign from scratch.
***
### Launching a Campaign
When you're happy with a campaign, click **Launch** on its card to open the campaign detail view. Here you can review everything before it goes live:
* **Audience** — which customers qualify and the estimated ROI
* **Budget** — the total spend cap for the campaign
* **Trigger** — the condition a customer must meet to earn the reward (e.g., place an order of 100 AED or more)
* **Rewards** — the reward type, value, minimum order, expiry, and usage limit
If the recommended campaign is a game, you'll also see a preview of the game experience before going live.
Click **Launch Campaign** to activate it. The campaign starts tracking customer activity immediately, and customers who meet the conditions will see the reward automatically.
Once live, the campaign appears under **In Progress Campaigns** while Adam finalizes the setup.
No further action is needed. You can also rate any suggestion using the thumbs up / thumbs down on each card — your feedback helps improve future recommendations.
***
### What You Get With This Onboarding
**Loyalty program setup without expertise** — Gameball generates a complete loyalty program from your Shopify store data, including earning rules, point values, and tier structure. No manual configuration required.
**Revenue risks and opportunities** — Your homepage surfaces active revenue leakage risks and growth opportunities based on your store's data, with projected revenue impact for each. Unactioned items stay at the top; launched campaigns move to In Progress.
**AI-recommended campaigns** — For each identified risk or opportunity, Adam recommends a campaign with segment, reward, and budget pre-configured. You can view the full configuration summary, regenerate alternatives, or launch directly.
**Projected ROI before launch** — Each campaign recommendation includes an estimated revenue impact so you know what to expect before approving.
**AI-generated campaign visuals** — Generate campaign images using a text prompt directly from the dashboard — no design skills or external tools needed.
***
### Good to Know
* You can re-generate campaigns as many times as needed before launching
* You can edit any campaign after launch from your dashboard
* Adam's recommendations are based on your store's actual order history, customer behavior, and revenue patterns
Enable account creation on Shopify to give your customers the ability to create accounts and enroll in your Gameball rewards experience. [Learn more](/product-documentation/getting-started/faqs/enable-customer-account-creation-on-shopify)
You can also make sure that your customers' points and tiers are updated by following the steps in [this article](/product-documentation/understanding-your-customers/your-customers/migrate-your-customers-to-gameball-from-other-loyalty-programs-on-shopify).
Gameball offers programs that help you reach your loyalty goals — whether that's acquisition, activation, engagement, or retention. Configure and activate any of the following:
Set up your earning rules and cashback configuration.
Configure how customers redeem their earned points.
Launch a referral program to grow your customer base.
Create targeted campaigns to reward specific behaviors.
Gamify your experience with tiered loyalty levels.
After setting up your loyalty programs, configure the right methods and rules for how your customers can redeem their points — whether as discount percentages, coupons, free shipping, or other rewards.
[Learn more](/product-documentation/programs/loyalty-points-redeem/launch-and-configure-your-redeem-pointing-system)
* Create a widget profile and configure general settings such as language, program name, tab visibility, and icons. [Learn more](/product-documentation/customer-widget/introduction-to-customer-widget)
* Style Gameball's widget to match your store's theme, making it feel like a seamless extension of your brand. [Learn more](/product-documentation/customer-widget/start-configuring-profile/customize-your-gameball-customer-widget-to-match-your-brand)
Once you've configured the essentials, publish the Gameball widget so your customers can enroll in your reward experience. Follow "Stage 1" in the widget visibility guide to go live.
[Publish Your Widget](/product-documentation/customer-widget/start-configuring-profile/control-gameball-widget-visibility-on-your-platform)
If you have been using other loyalty programs and want your customers' profiles migrated, follow the steps in [this article](/product-documentation/guides-strategies-faqs/supportive-guides/import-customers-csv) to import customer data to Gameball.
Gameball offers programs that help you reach your loyalty goals — whether that's acquisition, activation, engagement, or retention. Configure and activate any of the following:
Set up your earning rules and cashback configuration.
Configure how customers redeem their earned points.
Launch a referral program to grow your customer base.
Create targeted campaigns to reward specific behaviors.
Gamify your experience with tiered loyalty levels.
After setting up your loyalty programs, configure the right methods and rules for how your customers can redeem their points — whether as discount percentages, coupons, free shipping, or other rewards.
[Learn more](/product-documentation/programs/loyalty-points-redeem/launch-and-configure-your-redeem-pointing-system)
* Create a widget profile and configure general settings such as language, program name, tab visibility, and icons. [Learn more](/product-documentation/customer-widget/introduction-to-customer-widget)
* Style Gameball's widget to match your store's theme, making it feel like a seamless extension of your brand. [Learn more](/product-documentation/customer-widget/start-configuring-profile/customize-your-gameball-customer-widget-to-match-your-brand)
Once you've configured the essentials, publish the Gameball widget so your customers can enroll in your reward experience. Follow "Stage 1" in the widget visibility guide to go live.
[Publish Your Widget](/product-documentation/customer-widget/start-configuring-profile/control-gameball-widget-visibility-on-your-platform)
***
## More Features to Explore
Send real-time notifications to keep your customers engaged.
Create targeted email and in-app campaigns.
Enable cross-merchant reward programs for your customers.
# What Is Gameball?
Source: https://docs.gameball.co/product-documentation/getting-started/what-is-gameball
Gameball is a customer loyalty and gamification platform that helps brands turn one-time buyers into loyal customers who spend 3x more.
Gameball is a customer loyalty and gamification platform that helps brands turn one-time buyers into loyal customers who spend 3x more. Instead of building engagement features from scratch, Gameball provides ready-to-deploy infrastructure for loyalty programs, gamification, referrals, and promotions — all manageable from a single dashboard.
Trusted by **3,000+ brands** across **70+ countries**, Gameball processes over **15M API calls daily** and has handled **\$7B+ in orders** through our platform.
***
## Core Modules
Gameball provides six core modules that work together to drive customer engagement and retention:
Manage points, cashback, and tier-based programs across your app, website, and stores. Set earning and redemption rules for any customer action, with one unified experience across all channels.
Engage users with challenges, missions, streaks, badges, and leaderboards. Our gamification features create habit loops that keep customers coming back — with ready-made UI that requires no development time.
Run targeted promotions at scale with secure discount and coupon management. Segment customers based on behavior and trigger personalized offers automatically.
Turn your customer base into your best marketing channel. Create referral programs in minutes with shareable links, built-in tracking, and rewards for both sender and receiver.
Build loyalty and marketing workflows visually with our no-code campaign builder. Trigger emails, push notifications, and in-app messages based on real-time customer behavior.
Predict customer behavior with actionable insights. Segment users by their actions and characteristics to deliver personalized experiences that drive results.
***
## Why Developers Choose Gameball
Building loyalty and gamification features in-house can take **20,000+ development hours**. Gameball provides plug-and-play infrastructure that lets your team focus on your core product while we handle engagement.
Native SDKs for Web, iOS, Android, React Native, and Flutter — plus a comprehensive REST API for custom integrations.
Pre-built widgets and components mean you can go live quickly. Configure everything through the dashboard without code changes.
Our infrastructure handles 100M+ requests weekly with less than 300ms latency. Enterprise-grade hosting with regional data residency options available.
Marketing teams can update campaigns, rules, and rewards through the dashboard — no developer involvement required for day-to-day changes.
***
## Platform Support
Gameball integrates seamlessly with your existing stack:
* **E-commerce Platforms** — Direct apps for Shopify and Salla, plus integrations with WooCommerce, Magento, and Salesforce Commerce Cloud.
* **Mobile & Web** — Native SDKs and JavaScript SDK for custom applications, with full API access for headless implementations.
* **POS & Retail** — Connect in-store transactions with online loyalty for a unified omnichannel experience.
* **Marketing Tools** — Pre-built integrations with MoEngage, Braze, Segment, and other CDP/engagement platforms.
***
## What's Next?
Step-by-step guide to get your loyalty program live.
Learn how customers work in Gameball.
Set up your earn and redeem pointing system.
Configure tier-based programs for your customers.
Launch a referral program to grow your customer base.
Connect Gameball with your marketing stack.
# What Are Collection-Based Earning Rules?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/collection-based-earning-rules
Customize your cashback program so that each collection you have in your store offers a different cashback value to your customers.
| Platform | Plan |
| -------------------- | ---------------------- |
| Shopify | Guru |
| Salla | Guru |
| Non-platform Clients | Growth (Add-on) & Guru |
Customize your cashback system on Gameball to offer different cashback values for each collection in your store. This flexibility allows you to incentivize purchases from specific collections and enhance customer engagement.
## Prerequisites
* Ensure that you have activated the **Cashback** feature on your Gameball account.
* Confirm that your store collections are properly set up.
***
## Configuring Collection-Based Earning
Navigate to **Earn Points** under **Programs** from your Gameball dashboard.
Under **Settings**, click the **Edit Icon** beside **Collection-based Earning Rule**.
A pop-up window will appear. Under **Cashback Options**, you will find four choices:
The default cashback rule applies to all products. You can add extra cashback rules for different levels.
Cashback will only apply to the selected collections. Purchases from other collections will not be eligible for cashback.
Cashback applies to all collections except the ones you exclude. Purchases from excluded collections will not earn cashback.
You can define different cashback values for different collections. After saving, further configuration is required.
After choosing your preferred cashback system, click **Save**.
* If you select **All Products**, **Selected Collections**, or **All Products Except Some Collections**, no further configuration is needed. Just ensure your default cashback rule is correctly set.
* If you choose **Custom Cashback**, you deactivate the **Merchant** feature on the system. Cashback based on collections and crossover cashback cannot work simultaneously.
***
## Create Different Cashback Values for Different Collections
After selecting **Custom Cashback** and clicking **Save**, a new tab called **Collection Rules** will appear.
Click **View Collections**, then **Add Collection Rule**.
Configure your cashback rule:
* **Select Collection/s:** Mark the collections for this rule.
* **Collection Rule Name:** Name the rule for easy identification.
* **Cashback Method:** Choose between:
State the percentage of the cashback you want to grant for orders from that collection.
State the amount of points you want to give for every dollar they spend buying from the specified collection.
Ideal if you want to offer **consistent point rewards per collection**, regardless of the product's price.
**Fixed Cashback Value** is perfect for exclusive items. For example, if you want to reward 100 points per product in the "New Arrivals" collection, regardless of whether an item costs $20 or $200.
To enable fixed cashback, you must send the following details **per item** in the Order API: Collection ID(s), Price, Discount, Taxes, and Product ID.
**Fixed Cashback Key Rules:**
* If an item belongs to multiple collections, Gameball will reward based on the **highest fixed point value**.
* If multiple different items from the same collection are purchased, the fixed points reward applies per item.
* The **fixed points reward will still respect active Points Multiplier Campaigns** (e.g., Double Points: 200 becomes 400).
Enter the cashback value.
Click **Save**. Customers will now enjoy collection-specific cashback rates. The newly created rules will be visible under the **Collection Rules** tab.
* To add more rules for different collections, click **Add Collection Rule** and repeat the process.
* To edit a rule, click the **Edit Icon**.
* To delete a rule, click the **Bin Icon**.
***
## Common Questions
Yes. After creating a cashback rule for specific collections, you can modify the cashback value based on the customer's tier:
1. Under the configured cashback rule, click **Add tier rule**.
2. Select the customer **tier**.
3. Change the cashback value accordingly.
4. Click **Save**.
Gameball will reward based on the **highest cashback point value**.
The points reward applies per item.
***
## Related Articles
Configure your default cashback points rules.
# How Do I Create a New Merchant for Every Brand and Store You Own?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/crossover-reward-program/creating-a-new-merchant
Learn how to unify your loyalty experience by creating a new merchant for every brand and store you own on the Gameball dashboard.
| Platform | Plan |
| -------------------- | ---- |
| Shopify | Guru |
| Salla | Guru |
| Non-platform Clients | Guru |
As a multi-brand company, you might be facing some difficulties with unifying your customer engagement under one loyalty experience. Gameball has now made that possible with its [Merchants feature](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/gameball-merchants-crossover-rewards-experience).
You can easily create a crossover rewards experience where your customers can redeem and use cashback points with every purchase they make at any of your brands or stores. They can also receive a different cashback value depending on the brand.
This article tackles the first step, which is creating a new merchant for your brand or store.
***
## Prerequisites
* Ensure your subscription plan is **Guru**.
* Contact Gameball support to enable the Merchants feature.
***
## How to Create a New Merchant
On the Gameball Admin Dashboard, go to **Admin Settings > Merchants**.
Click **Create New Merchant**.
Enter the brand ID and name under **Merchant Unique ID** and **Merchant Name**.
If you want to add different branches to the brand, click **Add Branches**. Enter the branch ID and name under **Branch Unique ID** and **Branch Name**.
Once all details are filled in, click **Create**.
***
## Important Notes
* Merchant ID and Branch ID must be **unique**. They are used by Gameball APIs to identify the merchant/brand and branch.
* If you have completed the integration process using Gameball APIs and a transaction is made with a brand or branch that does not exist in Gameball, the system will automatically create a new merchant name and ID to complete the transaction.
* After adding all the brands to your platform, you must configure the cashback rules for each brand.
***
## Common Questions
Yes, you can add different branches under the same merchant by clicking **Add Branches** during the merchant creation process.
Gameball will automatically create a new merchant and ID to complete the transaction if it does not exist.
***
## Related Articles
Set up different cashback values for each brand or store.
# What Is the Gameball Merchants Crossover Rewards Experience?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/crossover-reward-program/gameball-merchants-crossover-rewards-experience
Learn about Gameball's crossover rewards feature called Merchants, enabling a unified loyalty experience across multiple brands and stores.
| Platform | Plan |
| -------------------- | ------------------- |
| Non-platform Clients | Growth & Enterprise |
| Shopify | Guru |
| Salla | Guru |
As a multi-brand company, unifying your customer engagement under one cohesive loyalty experience can be challenging. Gameball has simplified this with its **Merchants** feature.
***
## Introducing Merchants: A Unified Loyalty Experience
With Merchants, you can create a seamless rewards experience where customers earn cashback points with every purchase across any of your brands or stores. They can then redeem these points at any participating brand or store, enhancing their overall shopping experience.
***
## Flexible Cashback Rewards
Merchants allow you to offer varying cashback values depending on the brand or store. This flexibility means customers can receive different cashback percentages based on where they shop, making the rewards system more dynamic and tailored.
***
## How Does Merchants Work?
Understanding the Merchants feature requires knowledge of the two types of redemption processes:
Customers redeem points directly from your platform. At checkout, they create a coupon code to transfer points for redemption.
Customers can redeem rewards across different channels, not limited to the origin of the points. This is the core of the Merchants feature.
With Merchants, you decide whether to offer the same cashback value across all stores or differentiate the rewards by brand or store.
***
## Example Scenarios
If you operate three stores with a uniform cashback value:
* A customer buys a $100 product from Store A, earning 5% cashback ($5).
* Later, they buy a $20 product from Store B, using their $5 cashback balance and paying \$15 in cash.
* They earn 5% cashback on this new purchase (\$1), usable at any store.
If you have three brands selling different products:
* Brand A (clothes) offers 3% cashback. A customer buys $50 pants, earning $1.50 cashback.
* Brand C (furniture) offers 10% cashback. The same customer buys a $300 couch, earning $30 cashback.
* They use their $31.50 cashback at Brand B (electronics) to purchase a $75 headset, paying \$43.50 in cash.
This flexibility lets you create endless scenarios for a customized rewards experience.
***
## Activating the Merchants Feature
To use this feature, you must be on the **Guru** plan and request activation from customer support. Follow these steps to get started:
Add each brand or store to the Gameball dashboard. [Learn more](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/creating-a-new-merchant)
Set up the cashback values for each brand or store after recognition by Gameball. [Learn more](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/reward-customers-with-different-cashback-per-brand)
Unify your customer loyalty experience effortlessly with Gameball's Merchants feature, offering a tailored and dynamic rewards program across all your brands and stores.
***
## What's Next?
Add each brand or store to the Gameball dashboard.
Set up different cashback values for each brand.
# How Do I Reward Customers with Different Cashback Based on the Brand?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/crossover-reward-program/reward-customers-with-different-cashback-per-brand
Learn how to configure a different cashback rule for every different brand you have using the Merchants feature.
| Platform | Plan |
| -------------------- | ---------- |
| Shopify | Guru |
| Salla | Guru |
| Non-platform Clients | Enterprise |
***
## Prerequisites
* Make sure to create a merchant ID for each of your brands/stores on the Gameball dashboard before configuring cashback rules.
* Ensure the Merchants feature is activated on your account.
* To activate this feature on your dashboard, you must request it from our customer support team.
If you have configured different cashback rules for different collections using the **custom cashback** feature, the **merchant cashback** option will no longer be available. [Learn more about collection-based cashback rules](/product-documentation/programs/loyalty-points-earn/collection-based-earning-rules).
***
## How to Configure a Cashback Rule for Different Brands
After creating an ID for each of your brands and stores, follow these steps to configure a cashback rule for any of these recognized brands or stores:
On the Gameball dashboard, go to **Programs > Earn Points > Merchants** tab.
You will find all merchants listed. [Learn how to create a Merchant](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/creating-a-new-merchant)
Fill in the required information:
* **Choose Merchant:** Select the brand you want to create the new cashback rule for.
* **Configuration Method:** Choose between:
Set a cashback percentage based on the customer's paid amount. Example: If you offer 5% cashback and a customer pays $100, they will receive $5 cashback worth of points.
Set a fixed number of points per currency unit regardless of the cashback percentage. Example: If a customer pays \$100, they could receive 1000 points based on your configuration.
Set a fixed cashback value for the customer to earn based on their purchase.
Click **Save Changes**.
If your cashback program is active, your customers will now receive the specified cashback once they place and pay for an order from the brands you have added and configured a cashback rule for.
***
## Important Notes
* By default, every newly created merchant will fall under your default cashback rules unless a specific rule is configured.
* You can create different cashback rules based on each merchant's level.
* Merchant-specific cashback rules override the default cashback rules if the customer purchases from a recognized merchant.
**Example:** If you have different cashback rules per level under your default cashback settings, but only one general cashback rule for a specific merchant, the merchant rule will apply to the customer regardless of their level.
***
## Common Questions
No, if you use collection-based cashback rules, you cannot activate merchant-based cashback at the same time.
The default cashback rule will apply.
***
## Related Articles
Set up different cashback values for different collections.
Learn how Gameball prioritizes and applies different earning configurations.
Add merchants for each brand and store you own.
# How Do I Give Different Point Earning Rules for Different Order Types?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/custom-earning-rules
Create customized point-earning rules based on order attributes to reward customers differently depending on how and what they buy.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Guru |
| Salla | Guru |
| Non-Platform | Enterprise |
Gameball lets you create custom point-earning rules based on any order attribute. Rather than applying a single flat earning rate across all purchases, you can define specific conditions — such as order value, payment method, or product category — and assign different point rewards to each scenario.
***
## How to Set Up Custom Earning Rules
Go to **Programs > Earn Points** in your Gameball dashboard.
Click on the **Custom** tab.
Click **Add Rule**, then define your conditions. You can filter by any order attribute, such as:
* Order total price
* Product collection or category
* SKU
* Payment method
* Custom order metadata
When **SKU** is selected as the condition field, an **Upload CSV** option appears alongside the text input. Upload a CSV file to populate multiple SKUs at once instead of typing them individually. SKUs are automatically added to the field after upload and remain editable.
CSV uploads support up to 100 SKUs per file. Clear validation messages are shown for any file type, size, or format issues.
Conditions can be set at the order level or the line-item level. See the [Condition Attributes Reference](#condition-attributes-reference) section below for the full list of available attributes.
Select how points are calculated for orders that match your conditions:
Award a percentage of the order total as points. For example, give 5% cashback for orders from a specific collection.
Award a fixed number of points per currency unit spent. For example, give 2 points for every 1 EGP spent on orders paid by credit card.
Award a set number of points regardless of the order value. For example, give 10 points for any order above \$50.
Click **Save** to activate the rule. The rule will apply when all specified conditions are met.
***
## Combining Multiple Conditions
You can stack multiple conditions within a single rule. All conditions must be met for the rule to apply.
**Examples:**
* Reward 10 points for orders where `total_price` **greater than** `50`
* Give 5 points per \$1 for `product_category` **equals** `Electronics`, versus 2 points per \$1 for `product_category` **equals** `Accessories`
* Award bonus points for high-value purchases from the Summer Collection paid by credit card
***
## Condition Attributes Reference
Beyond standard attributes like order total, payment method, and product category, the rule builder supports additional order-level and line-item-level attributes. These let you build more precise earning rules — including tier-specific ones. Each rule can be scoped to a specific **customer tier**, so Gold customers earn at a different rate than Silver customers for the exact same order condition. For example, a Gold tier customer who places an order with 5 or more items could earn 3× points, while a Silver tier customer earns 2× on the same order.
### Order-Level Attributes
These attributes apply to the order as a whole. Combine them with a customer tier and a point assignment method to reward customers differently based on both their loyalty status and how they shop.
| Attribute | Description |
| ----------------------------- | ------------------------------------------------------ |
| **Redeemed amount in points** | The number of points the customer burned on this order |
| **Coupon codes** | The coupon code applied to the order |
| **Total items** | Total quantity of all line items in the order |
| **Total unique items** | Number of distinct products in the order |
| **has\_points\_redemption** | True if points were redeemed on this order |
| **has\_coupon\_redemption** | True if a coupon was burned on this order |
For example, you can set separate rules for each tier — giving Gold customers a 3× multiplier when their order contains 5 or more items, Silver customers a 2× multiplier for the same condition, and standard customers the default rate. You can also award a bonus earn rate to customers on any tier who purchase without applying a coupon code.
### Line-Item-Level Attributes
These attributes apply to individual products within the order. Use them when you want to adjust earning based on what happened to a specific item — for example, awarding a higher earn rate on full-price items or giving bonus points on taxed line items.
| Attribute | Description |
| ------------ | ----------------------------------------------------- |
| **Discount** | The discount amount applied to the specific line item |
| **Tax** | The tax amount on the line item |
***
## How Custom Rules Interact with Other Earn Rules
When multiple earning rules could apply to the same order, Gameball evaluates them based on rule priority. Custom rules take precedence over the default earn rule when their conditions are matched.
Custom cashback rules and collection-based cashback rules cannot be active simultaneously. Enabling custom cashback deactivates the Merchant feature on the system.
***
## Related Articles
Set up your base earn rule and pointing system configuration.
Customize earning rates by product collection.
Learn how Gameball prioritizes and calculates points across different rules.
# How Do I Set Which Orders Are Eligible for Points Earning?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/eligible-orders-for-earning
Learn how to use order attributes and conditions to control which orders qualify for loyalty points in Gameball.
Gameball lets you define exactly which orders qualify for points earning. Rather than rewarding all orders equally, you can build rules based on any order attribute — such as price, payment method, product category, or custom metadata.
***
## How to Configure Eligible Orders
Go to **Programs > Earn Points** in your Gameball dashboard.
Click **Settings**, then find the **Earn Points Applies On** section.
Click **Add Rule** and choose the order attribute you want to filter by (e.g., `total_price`, `payment_method`, `product_category`, `sku`).
When **SKU** is selected as the condition field, an **Upload CSV** option appears alongside the text input. Upload a CSV file to populate multiple SKUs at once instead of typing them individually. SKUs are automatically added to the field after upload and remain editable. CSV uploads support up to 100 SKUs per file.
Select the appropriate operator and enter your target value (e.g., `total_price` **greater than** `50`).
Click **Save** to apply the rule.
***
## Extra Attributes
Beyond standard fields like product names and SKUs, you can use custom order data for more advanced targeting:
* Payment methods (e.g., reward only credit card orders)
* Regional zones or store locations
* Subscription tier or membership level
* Product classifications or custom tags
These can be passed via the Order API inside the order metadata.
***
## Understanding the Path Field
For **nested attributes**, use **dot notation** to navigate to the value you need.
**Example:** To target a specific card type within a payment method:
```
payment_methods.credit_card.card_type
```
For **line-item attributes**, the path starts directly from the extra field without additional nesting.
***
## Available Operators
| Operator | Description |
| ---------------------------- | ------------------------------------------ |
| **Equals** | Exact match |
| **Not Equals** | Excludes exact match |
| **Contains** | Value includes the specified string |
| **Does Not Contain** | Value excludes the specified string |
| **Starts With** | Value begins with the specified string |
| **Ends With** | Value ends with the specified string |
| **Is Empty** | Field has no value |
| **Is Not Empty** | Field has a value |
| **Greater Than** | Numeric value above threshold |
| **Greater Than or Equal To** | Numeric value at or above threshold |
| **Less Than** | Numeric value below threshold |
| **Less Than or Equal To** | Numeric value at or below threshold |
| **Exists** | Field is present in the order data |
| **Does Not Exist** | Field is absent from the order data |
| **Between** | Numeric value falls within a defined range |
***
## Combining Multiple Conditions
You can combine multiple attribute rules using **AND** or **OR** logic:
* **AND**: All conditions must be true for the order to qualify.
* **OR**: Any one condition being true makes the order eligible.
**Example:** Reward only orders where `total_price > 50` **AND** `payment_method = credit_card`.
***
## Rewarding All Orders Except Certain Ones
To reward all orders except those matching specific conditions, choose the **"All except some attributes"** option. This inverts your rule — all orders qualify unless they match the defined exclusion criteria.
**Shopify merchants** can use this to exclude specific types of purchases:
* **Discounted items**: If discounted products are identifiable by a product ID, SKU, or product category, use exclusion mode with the corresponding attribute to prevent points from being awarded on those purchases.
* **Gift card purchases**: If gift cards are listed as products in your Shopify store, you can exclude them by targeting their product ID or SKU in exclusion mode.
Gameball does not automatically detect discounts or gift cards — exclusions work by matching order attributes you define. Make sure the products you want to exclude are identifiable by a consistent attribute (e.g., a specific SKU, product ID, or category).
***
## Common Examples
| Goal | Rule |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Reward orders above a minimum value | `total_price` **greater than** `50` |
| Reward only online orders, not POS | `channel_type` **equals** `online` |
| Exclude a specific collection | Use exclusion mode, `collection_id` **equals** `[collection]` |
| Reward a specific payment method | `payment_method` **equals** `paypal` |
| Target a product category | `product_category` **equals** `electronics` |
| Target specific products by SKU | `sku` **equals** one or more SKU values (upload via CSV for bulk) |
| Exclude discounted items | Use exclusion mode, `product_id`, `sku`, or `product_category` **equals** the discounted product identifier |
| Exclude gift card purchases (Shopify) | Use exclusion mode, `product_id` or `sku` **equals** the gift card's product ID — works when gift cards are listed as products in Shopify |
***
## Related Articles
Set up your base earn rule and pointing system configuration.
Learn how Gameball prioritizes and calculates points across different rules.
# How Do I Launch and Configure My Earn Pointing System?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system
Learn how to activate and configure Gameball's Earn Pointing System to reward your customers with points based on their purchases.
| Platform | Plan |
| -------------------- | ------------------------- |
| Shopify | Free, Starter, Pro & Guru |
| Salla | Starter, Pro & Guru |
| Non-platform Clients | Growth & Enterprise |
Rewarding your customers with points is a powerful strategy to foster loyalty and encourage repeat purchases. With **Gameball's Earn Pointing System**, you can activate and fully customize how customers earn points based on their spending behavior.
***
## Step-by-Step Instructions
From the left-side menu, go to **Programs** and click **Earn Points**. You will be directed to the **Points Earn** configuration page.
Locate the **Active** toggle at the top right of the page and switch it on to activate the system.
In the **Order Reward** section, click the **Place an order** card. A settings drawer will slide in from the right. Set:
* **Your customers will get** — the number of points per transaction
* **For every** — the currency amount that earns those points (e.g., 2 points for every 1 USD spent)
A preview shows the equivalent cashback percentage based on your current redemption value.
If you use **score** as your tiering-up method, you will see an additional field to assign the score customers will earn per amount spent. [Learn more about Score](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods).
***
## Custom Rules
The **Custom** section lets you define different earning rules for different order attributes. Click **View Custom Rules** to configure rules based on order properties such as total price, payment method, or product category.
[Learn more about Custom Earning Rules](/product-documentation/programs/loyalty-points-earn/custom-earning-rules)
***
## Merchant Rules
Set custom earning and redemption rules per merchant or brand, based on your business needs.
[Learn more about Merchants' Rules](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/gameball-merchants-crossover-rewards-experience)
***
## Settings
The **Settings** section lets you configure how points are issued and which orders qualify. Click any settings card to open a drawer and update it.
Define when earned points will expire. Click the **Points Expiry** card to open the settings drawer, then set the expiry duration and unit (days, months, or years).
Points expiry is calculated from the exact moment points are earned. For example, with a 3-day expiry, points earned at 2:00 PM on January 1st expire at exactly 2:00 PM on January 4th (72 hours later).
**How expiry is enforced:**
* Customers **cannot redeem** expired points from the moment the expiry time passes — even before the system has processed the expiry.
* Expiry status is updated by a background job that runs **multiple times per day**. The dashboard may briefly show points as still active until the next job run, but redemption is blocked from the exact expiry moment.
Points expiry and the return window interact: if a return window is configured, the expiry countdown starts only after points become active (i.e., after the return window ends), not from when they were earned.
Define which collections or products qualify for earning points. Click **Edit** next to **Earn points applies on** to choose from:
* All Products
* Selected Collections
* All Products except some collections
Specify a time gap between when an order is placed and when points are issued. This helps manage potential product returns and ensures proper point issuance.
***
## Cashback Return Window API
You can control when cashback points become active using the `returnWindow` attribute.
**Available in:**
* **Order API:** under `cashbackConfigurations`
* **Cashback API:** under `configurations`
**Key Details:**
* `returnWindow` accepts values from 0 to 7300 days.
* Points remain pending for the set duration, then activate automatically.
* If not provided, the default duration from your Gameball settings applies.
***
## Insights and Analytics
Access in-depth analytics on how your Earn Points System is performing by clicking the **Insights** tab at the top of the page. Track total earned rewards, total rewarded points, and how reward trends evolve over time.
***
## Common Questions
Use the **Return Window Duration** setting to delay point issuance, helping avoid rewarding points for refunded purchases.
Yes, use the **Earn Points Applies On** setting to filter by collection, or use the **Custom** section to set rules based on any order attribute.
Yes, you can set a return window at the order level.
To do this, include the `returnWindow` attribute inside the `cashbackConfigurations` object when creating the order using the **Order API**. This allows you to specify a custom return window per order — for example, 7 days for Order A and 10 days for Order B.
If `returnWindow` is not set in the API request, the default duration from your Gameball settings will apply.
***
## Related Articles
Set different point values for different order types and attributes.
Set up how customers can redeem their earned points.
# How Does Gameball Calculate Loyalty Points?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-earn/understanding-loyalty-points-calculations-and-rules
Learn how Gameball prioritizes and applies different types of loyalty points configurations to reward your customers.
| Platform | Plan |
| -------------------- | ------------------------- |
| Shopify | Free, Starter, Pro & Guru |
| Salla | Starter, Pro & Guru |
| Non-platform Clients | Growth & Enterprise |
Gameball provides several loyalty points earning configurations, each with specific conditions and priority rules. This ensures customers earn the correct amount of points based on their level, the collection or merchant they are purchasing from, and any active campaigns.
Custom loyalty points per merchant cannot be used in combination with custom loyalty points per collection.
***
## Default Loyalty Points Earning
This is the basic loyalty points earning rule that applies if no other rule has been set up. If no specific configurations are in place for collections, merchants, or tiers, the system will apply the default Loyalty Points earning rate. [Learn more](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system)
**Example:**
| Loyalty Points Earning Type | Value | Points Earned |
| ------------------------------ | ----- | ----------------- |
| Default Loyalty Points Earning | 1 pts | **1 pts** per \$1 |
***
## Loyalty Points Earning per Tier
This rule overrides the default earning rate. When a customer qualifies for a tier-based earning configuration, points will be granted according to their level rate.
If an item has custom loyalty points for a collection or merchant, this rule is ignored.
**Example:**
| Loyalty Points Earning Type | Points Value |
| ------------------------------- | ----------------- |
| Default Loyalty Points Earning | 3 pts |
| Loyalty Points Earning per Tier | 2 pts |
| **Points Earned** | **2 pts** per \$1 |
In this case, the customer earns **2 points** per \$1 based on their tier.
***
## Custom Loyalty Points Earning per Collection or Merchant
This rule takes precedence over both the default rate and tier-based earnings.
If an item belongs to multiple collections, the system compares all configured values and applies the highest.
**Example:**
| Collection Name | Custom Loyalty Points Earning |
| -------------------- | ----------------------------- |
| Collection Breakfast | 4 pts |
| Collection Cheese | 2 pts |
| **Points Earned** | **4 pts** |
If an item belongs to both collections, the customer receives the highest value (4 pts).
***
## Custom Loyalty Points per Tier per Collection or Merchant
This rule overrides all previous configurations. Gameball compares the loyalty points set at the collection or merchant tier with the customer tier, and the higher value is applied.
**Example 1:**
| Collection | Custom Loyalty Points | Loyalty Points per Tier 2 |
| -------------------- | ------------------------ | ------------------------- |
| Collection Breakfast | 4 pts | 6 pts |
| Collection Cheese | 3 pts | 2 pts |
| **Points Earned** | **6 pts** from Breakfast | **3 pts** from Cheese |
In this case, the customer earns **6 points** for items in Collection Breakfast and **3 points** for items in Collection Cheese, as these are the higher values.
**Example 2:**
| Collection | Custom Loyalty Points | Loyalty Points per Tier 2 |
| -------------------- | --------------------- | ------------------------- |
| Collection Breakfast | 4 pts | 5 pts |
| Collection Cheese | 2 pts | 6 pts |
| **Points Earned** | **6 pts** | |
In this case, 6 points are awarded based on the highest applicable rule.
***
## Multiplier Campaign
Multiplier campaigns are applied **after** all earning rules. [Learn more](/product-documentation/programs/rewards-campaigns/create-a-point-multiplier-reward-campaign).
The system calculates points per item and then applies the multiplier, rounding down the result per item before summing.
**Example:**
| Item | Points Before Multiplier | Multiplier | Earned Points |
| ----------------- | ------------------------ | ---------- | ------------- |
| Item 1 | 2.3 pts | 2x | 4 pts |
| Item 2 | 3.1 pts | 3x | 9 pts |
| **Points Earned** | | | **13 pts** |
If an item is affected by two multiplier campaigns, Gameball will apply the one with the **higher** multiplier.
**Example:**
| Campaign Type | Multiplier |
| ---------------------- | ---------------------------------------------- |
| Whole order | 3x |
| Campaign on Collection | 5x (on cheese) |
| **Points Earned** | Earned points from the first four rules **x5** |
If the customer purchases an item from the Cheese collection, the 5x multiplier will be applied.
***
## Refund Rules
Gameball deducts points proportionally based on the refunded item's value.
**Example:** If an item worth \$12.50 is refunded, 12 points will be deducted.
All points earned from the order will be removed, including points from campaigns.
To correctly deduct both base and campaign points, the product ID and quantity must be submitted during the refund process. If this data is not provided, Gameball will only deduct the base points value.
***
## General Notes
* Orders with custom loyalty points must be submitted using the **Order API**.
* Include all line items with details like price, taxes, discounts, and points values.
* If not applicable, these values must be set to "0".
* Shipping rewards follow the same rules as general, campaign, or tier-based rewards. However, **shipping refunds are not supported**.
* If the returned item is the **last item** in the order, all points (except shipping) will be deducted.
***
## Related Articles
Activate and configure how customers earn points.
Learn about the different types of reward campaigns.
Set up how customers can redeem their earned points.
# How Do I Launch and Configure My Redeem Pointing System?
Source: https://docs.gameball.co/product-documentation/programs/loyalty-points-redeem/launch-and-configure-your-redeem-pointing-system
Learn how to set ways for your customer to redeem the points that they have earned with your program.
| Platform | Plan |
| -------------------- | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-platform Clients | All Plans |
Offering customers multiple ways to redeem their points is crucial for enhancing gamification and their loyalty to your brand. With Gameball's versatile redemption system, you can create a seamless and rewarding experience for your customers. By setting up various redemption options, you empower your customers to choose how they want to utilize their points.
***
## Navigating to Redeem Points
From the left-side menu, go to **Programs** and click **Redeem Points**. The page opens on the **Configuration** tab, where all your redemption options are listed.
***
## Default Redemption Rule
The **Redemption Options** section always includes a default dynamic rule displayed as **"USD X discount for every Y point"**. This rule defines the base conversion rate between points and currency — how much monetary value a single point is worth when customers redeem.
To edit it, click the **⋮** menu on the default rule card and select **Edit**. This opens the **Flexible Redemption Option** page where you can configure:
**Redemption Configuration**
* **Redemption Type** — locked as Amount-based Discount (cannot be changed)
* **Value of 1 point** — the monetary equivalent of a single point (e.g., 0.1 USD)
**Rule**
* **Applies to** — Entire order or Specific Rule
**Advanced Options** (optional) — same options as custom redemption options (prefix, expiry, minimum purchase amount, etc.)
Click **Save** to apply your changes.
The cashback percentage shown on the earn rule edit panel is calculated based on this value. Changing the **Value of 1 point** here will update that percentage automatically.
***
## Managing Redemption Options
All configured redemption options appear in the **Redemption Options** section. You can toggle between a **card view** and a **list view** using the icons at the top right of the section.
Each option displays its redemption type, the points required to redeem it, and a toggle to enable or disable it directly.
### Adding a New Redemption Option
On the **Redeem Points** page, click **Add Redemption Option**.
You will be taken to the **Custom Redemption Option** page.
Fill in the following:
**Rule**
* **Audience** — choose whether this option applies to All Customers or Specific Customers
* **Applies to** — select Entire order or Specific Rule
**Redemption Type**
* Select a redemption type from the dropdown (e.g., Fixed Amount-based Discount, Percentage-based Discount, Free Shipping, Free Product)
**Reward Name**
* Enter the reward name in English (EN) and Arabic (AR) — up to 50 characters each
**Redemption Value**
* **Points Amount** — the number of points required to redeem this option
* **Discount Value** — the value of the discount awarded
**Image**
* Choose **Default** or **Upload Image** to set a custom icon for this redemption option
**Advanced Options** (optional)
| Option | Description |
| ------------------------------------------------ | ------------------------------------------------------------------------ |
| **Prefix** | Add a custom prefix to the generated coupon code |
| **Reward expires after specific amount of time** | Set an expiry window for the issued coupon |
| **Minimum purchase amount** | Require a minimum order value for the coupon to apply |
| **Number of reward uses per customer** | Limit how many times a customer can redeem this option (default: 1 time) |
| **Reward combined with other coupons** | Allow this coupon to be stacked with other active coupons |
| **Show "How to redeem" instructions** | Display redemption instructions to customers |
Click **Create** to save the redemption option. It will appear in your Redemption Options list.
Learn more about setting up each type:
* [Set Online Only Redemption Types](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types)
* [Set POS Redemption Types](/product-documentation/guides-strategies-faqs/shopify-guides/spend-points-on-pos)
***
## Available Reward Types
1. **Percentage-Based Discount:** Customers can exchange their points for a coupon that provides a percentage discount on their next purchase.
2. **Fixed Amount Discount:** Customers can redeem their points for a coupon that offers a fixed-value discount on their purchase.
3. **Free Shipping:** Customers can use their points to get free shipping on their order.
4. **Free Product:** Customers can redeem their points to receive specific products at no cost.
5. **Percentage-Based Cashback (Non-Platform Only):** Customers can use a coupon to receive a percentage of their purchase amount back as cashback, credited to their wallet in points or store credit.
6. **Fixed Amount Cashback (Non-Platform Only):** Customers can use a coupon to receive a fixed amount of cashback, credited to their wallet in points or store credit — regardless of the total purchase amount.
7. **Percentage-Based Fees Discount (Non-Platform Only):** Customers can receive a coupon that applies a percentage discount to transaction fees.
1. **POS Fixed Amount Coupon:** Redeem points for a specific amount off at point-of-sale.
2. **POS Percentage Coupon:** Redeem points for a percentage discount at point-of-sale.
***
## Settings
### Points Holding Duration
Set the duration that holds the redemption request until your customer completes the payment process — for example, when using points as partial payment alongside another payment method.
Click **Edit** next to **Points Holding Duration (Through APIs only)** to configure:
* **Holding Duration Value** — enter a number
* **Points Holding Time** — choose the unit: Minutes, Hours, or Days
***
## Insights and Analytics
Click the **Insights** tab at the top of the page to analyze the performance of each redemption option.
| Metric | Description |
| ------------ | ----------------------------------------- |
| Issued | Number of coupons generated |
| Burned | Coupons redeemed or used |
| Expired | Coupons that expired unused |
| Burn Rate | % of issued coupons that were used |
| Expiry Rate | % of issued coupons that expired unused |
| Total Points | Total points redeemed to generate coupons |
* **Time Range Filter** allows analysis for specific date ranges (e.g., last 30 days).
* **Export Option** lets you download filtered insights in CSV/XLSX format.
* **Default Sorting** is by Total Points (descending), customizable across all columns.
***
## Related Articles
Configure how customers earn points for their purchases.
# How Do I Launch Referral Program?
Source: https://docs.gameball.co/product-documentation/programs/referral-program/launching-referral-program
Boost your customer engagement, and increase your base with Gameball's Referral Program
| Platform | Plan |
| -------------------- | ------------------- |
| Shopify | Starter, Pro & Guru |
| Salla | Starter, Pro & Guru |
| Non-platform Clients | Growth & Enterprise |
Gameball's referral program allows you to reward both existing customers and their referred friends based on customizable conditions and actions. This article explains how to activate and configure your referral program through the Gameball dashboard.
***
## Activating Gameball's Referral Program
Log in to the **Gameball dashboard**.
From the left-side menu under **Programs**, click **Referrals**.
On the Referrals setup page, toggle the **activation switch** to enable the referral program on your platform.
Now that the referral program is active, follow the steps below to configure it.
***
## Referral Program Configuration
### 1. Referral Reward
Gameball allows you to decide who gets rewarded in your referral program. You can choose to reward:
* **Both the customer and their friend**
* **Only the customer**
To configure the referral reward:
Click **Edit** in the **Referral Reward** section.
Under **Friend's Action**, choose what qualifies a referral as successful:
* The friend completes their first purchase (account creation not required).
* The friend creates an account and completes a specific action, such as:
* Completing their first purchase
* Triggering a custom event that you have configured
#### Set Up the Rewards
1. Click **Change** under **Customer Reward**.
2. Choose the type of reward from the **Rewards** section. [Learn more about Rewards Types](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types).
3. \[Optional] Add an **extra reward** for every X successful referrals. For example, reward the customer with 100 extra points for every 5 successful referrals.
1. Click **Change** under **Friend Reward**.
2. Choose the type of reward from the **Rewards** section.
3. Select the **notification style** you want to use.
***
### 2. Settings
Choose the page you want referred friends to be directed to:
1. Enter your desired **URL** (by default, it redirects to your homepage).
2. Press **Save**.
To customize the content of the referral module displayed on the widget:
* Click the **redirection link** in the **Referral Content** section
**Or**
* From the left-side menu, go to **Widget Display > Content**, then select the **Referral** tab
***
## Multi-Step Rewards \[Add-on]
Multi-step rewards allow you to incentivize both your customers and their friends at different stages of the referral journey.
For example, you can reward a customer when their friend:
* Creates an account
* Completes an order
To configure multi-step rewards:
Click **Add New Step**.
Set the **friend's action** for this step.
Choose the **rewards** for both the customer and the friend.
You can now configure multi-step referral flows to mark an event as **"Happens One Time"**, without needing to define additional metadata or complex custom rules.
***
## Common Questions
You can use Branch.io and Adjust to generate and track referral links for your customers.
**Branch.io** and **Adjust** are tools used to create dynamic referral links, **primarily for clients with mobile apps** who want to redirect users to their app. Both platforms offer free plans, but these come with limits based on the number of Monthly Active Users (MAUs) or attributions.
* [Read about how to integrate **Branch.io** with Gameball](/product-documentation/apps-integrations/branch-io-integration)
* [Read about how to integrate **Adjust** with Gameball](/product-documentation/apps-integrations/adjust-integration)
For web-only clients (those without a mobile app), there is no need to use Branch or Adjust.
The referral process can be completed without using a deep link generator like Branch or Adjust. In such cases, you will need to provide your own referral link. Gameball will simply append the referral code to it.
Deep link generators are only responsible for generating the link that appears in the referral widget. If you're not using one, the referral link will follow this format:
* `{referralLink}?GbReferral={referralCode}`
You will then need to handle the referral logic manually, including capturing the referral code and passing it in the *create customer* request.
You can choose to display a customer's **referral code** instead of the full referral link, making it easier for customers to copy, share, and use referrals during sign-up especially in offline or manual flows.
From the dashboard, navigate to **Widget > General > Visibility > Referral Page**.
You can choose whether referral experiences display the full referral link or only the customer's unique referral code.
This is supported across both web and mobile, ensuring a unified experience wherever customers engage.
***
## Related Articles
See how customers experience referrals on the Gameball widget.
Generate and track deep referral links with Branch.io.
Generate and track deep referral links with Adjust.
# How Do Referrals Work on the Gameball Widget?
Source: https://docs.gameball.co/product-documentation/programs/referral-program/referrals-on-gameball-widget
This simple guide shows how your customers can use their unique referral link to share it and refer others.
| Platform | Plan |
| -------------------- | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-platform Clients | All Plans |
Unlock the power of referrals with Gameball's intuitive widget. Customers can easily refer friends and earn rewards by sharing their unique referral links. This guide outlines how customers can use the Gameball widget to access, share, and track referrals, while also highlighting the experience of referred guests.
Once the referral program is activated on your platform, customers can access the referral tab within the Gameball customer widget to begin referring friends.
***
## Customer Experience: Referring Friends
After opening the Gameball widget, customers will find a dedicated **Referral** section. This section highlights the benefits of the program for both the customer and the referred friend.
Each customer has a unique referral link/code located within the referral section. Customers can simply click to copy this link/code and share it with friends across their preferred platforms.
Customers can also view the coupons or rewards they can receive for their successful referrals. These appear clearly within the referral section of the widget and can be accessed at any time to check reward details and usage status.
Customers can monitor how their referral link performs by viewing the number of completed referrals and the corresponding rewards earned. This transparent tracking encourages continued participation in the program.
The referral section also displays referral history, allowing customers to view both completed and pending referrals. This helps them understand their current status and progress.
Pending referrals are invitations sent to friends who have not yet responded or completed the required actions for the referral to be considered successful.
Customers can refer to the **How It Works?** section within the widget to get a clear understanding of the steps involved in the referral process and the conditions needed for rewards to be granted.
***
## Guest Experience: Referred Friends
When referred, guests immediately receive a notification containing a coupon or voucher applicable to their first purchase, encouraging them to engage right away.
In addition to the instant widget notification, referred friends also receive an email with the reward coupon, ensuring they can easily retrieve and use their reward.
If a coupon is valid only for specific categories or collections, the guest is informed within the notification. This helps avoid confusion and ensures clarity when redeeming the coupon.
***
## Important Notes
* Customers must access the referral tab through the Gameball widget in order to view and share their referral links.
* Rewards are only granted once the referred friend completes the required conditions defined in your referral program settings.
***
## Common Questions
Inside the Gameball widget under the **Referral** tab.
Yes, referral progress and history are visible in the same widget section.
Through an instant widget notification and a confirmation email with the reward.
***
## Related Articles
Set up and configure your referral program on the Gameball dashboard.
Configure how customers earn points for their purchases.
# How Do I Configure Gameball VIP Tiers?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/configuring-gameball-vip-tiers
Create VIP tiers for your customers to gamify your user experience based on their engagement on your platform.
## Plan Availability
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Points | Yes |
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Points | Yes |
| Orders Completed | Yes |
| Friends Referred | Yes |
| Score | Yes |
Gamify your user experience and reward your customers for their engagement on your platform. With our VIP Tiers feature, you can create tiers and tier up your customers, turning their interaction with your platform into an exciting game.
***
## Configuring VIP Tiers
Log in to **Gameball's Dashboard**, head to the **Programs** section from the left side menu, then click **VIP Tiers.** View your current tiers to make any necessary adjustments.
Click on **Add New Tier**. In the Add New Tier page, you have three sections to fill in:
* **Tier Name** — Enter the name that will appear to your customers in the customer widget. You can choose something like bronze, silver, gold, or something that matches the theme of your platform.
* **Tier Icon** — Select or upload an image that will appear in the customer widget. Pick an icon that matches your tier name and your platform theme.
* Choose an Icon from our library
* **OR** Upload an image from your device
Enter the value that you want your customers to achieve so they can enter this tier based on your tiering-up method.
[Learn more about Tiering-up methods.](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods)
* **Entry and Lifetime Rewards** — Reward your customers for reaching new tiers with points, free products, discounts, and exclusive offers to incentivize continued engagement.
* **Earning Points Configuration** — Customize the earning points system per tier. For example, customers on tier 2 could get 10 points for every dollar they spend instead of the default setup. [Learn more about the default Earn Points system.](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system)
* **Custom Benefits** — Go beyond traditional rewards and offer custom benefits to customers on specific tiers. Whether it's access to VIP products or exclusive events, unleash your creativity to enhance the customer experience. [Learn more about Tier Benefits.](/product-documentation/programs/vip-tiers/tier-settings/customizing-benefits-for-different-tiers)
**Return Window Duration for Tier Entry Reward Points** — Prevent temporary reward abuse by locking tier-entry points until the return window expires. This ensures customers cannot instantly redeem tier-upgrade rewards and then refund their qualifying orders. [Learn more](/product-documentation/programs/vip-tiers/tier-settings/customizing-benefits-for-different-tiers).
After creating your tiers, configure the global VIP Tier settings:
Choose how customers advance through tiers:
* Amount Spent
* Points Earned
* Orders Completed
* Friends Referred
* Score
[Learn more](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods)
Set an expiry date to keep progression dynamic. Choose from no expiry or based on the last 3, 6, 12, or 24 months.
[Learn more](/product-documentation/programs/vip-tiers/tier-settings/understanding-tier-expiry)
Choose whether refunded orders contribute to customers' tier advancement, ensuring your loyalty logic stays aligned with your business rules.
Control when the tiering program goes live. Set it to **Active** or **Inactive** and configure a **Start Date** for when tier evaluation begins.
***
## Tiering Method Banner
The VIP Tiers page shows a banner stating how customers currently tier up — Amount Spent, Points Earned, Orders Completed, Friends Referred, or Score — with an **Edit** action that opens the tiering configuration directly, skipping the nested Settings hunt. The banner updates instantly on save.
The **Score** method is a non-redeemable progression metric, distinct from the RFM segmentation score.
***
## Refunded Orders Behavior
When **Refunded Orders** setting is enabled:
| Scenario | Behavior |
| -------- | ---------------------------------------------------------------------------------- |
| Enabled | Refunded orders **do not** count toward tier progress; earned progress is deducted |
| Disabled | Refunded orders remain included (default) |
Tier progress in both the **dashboard** and **widget** automatically reflects the updated calculation. Progress reductions from refunds are shown in real time.
If a refund lowers a customer's total spending below their current tier threshold, they will be downgraded accordingly. If downgraded, any entry reward given as points will be removed, while coupon rewards will remain. Customers can reclaim entry rewards each time they requalify. The system tracks tier changes, reward adjustments, and refund impacts while maintaining logs for auditing and fraud detection.
***
## Program Activation and Start Date
The tiering program includes an **Active / Inactive** toggle in the VIP Tier settings. If you are new to Gameball, the program is set to **Inactive** by default, giving you time to fully configure your tiers, benefits, and rules before going live.
When you activate the program, you are required to set a **Start Date**. Tier evaluation begins from this date — orders and events that occurred before it do not count toward customers' tier progression.
| Setting | Behavior |
| -------------- | --------------------------------------------------------------------------------------------------------- |
| **Inactive** | Tiers are hidden from customers in the widget. No tier progress is tracked. |
| **Active** | Tiers are visible in the widget. Tier progress is tracked from the configured start date onward. |
| **Start Date** | Only orders and events on or after this date contribute to tier advancement. Earlier activity is ignored. |
Activation and any changes to the start date are logged in the **Audit Trail** for tracking and accountability.
Use the inactive state to configure everything in advance — tiers, milestones, and benefits — then set a start date and activate when you're ready to launch. Customers will only see tiers once the program is active.
***
## Related Articles
Understand the different methods for advancing customers through your VIP tiers.
Configure entry rewards, lifetime rewards, and custom benefits for each tier.
# What Are Manually Updating Customers' Tiers?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/manually-updating-customers-tiers
Learn how to manually relocate a customer to a specific tier and how Gameball treats this change.
| Platform | Plan |
| -------------------------- | --------- |
| Available on all Platforms | All Plans |
If you want to put certain customers on specific tiers regardless of where the system's calculations are putting them, you can manually relocate any of your customers to different tiers with a few steps.
***
## How to Manually Update a Customer's Tier
You can change the tier of a single customer or multiple customers.
1. Go to the **Gameball Admin Dashboard**, click **Customers**, and then choose or search for the customer you want to apply the manual change to.
2. When you are on the customer's profile, click **More**, then **Adjust Tier**, found on the top right of the page.
1. Go to **Gameball Admin Dashboard**, then click **Customers**.
2. Filter the customers' list to include only the customers you want to apply the manual change to.
3. Click **More**, then **Export**.
4. Update the CSV file with the customers' tiers, then upload it back again to Gameball.
### Applying the Tier Adjustment
The following steps are the same for both single and multiple customer adjustments:
Choose the tier you want to relocate the customer to.
Choose the behavior of the new tier you want Gameball to apply to the customer:
* The customer will be placed into the manual tier, and the system will depend on the customer's progress later according to the chosen tiering method.
* The customer will be placed into the manual tier forever with no later evaluation.
* The customer will be placed into the manual tier temporarily with no evaluation till a specific date.
Choose the expiry date if you have chosen to apply the temporary behavior.
Type down the reason for the manual tier adjustment.
Click **Adjust Tier**.
***
## What Happens When You Manually Update a Customer's Tier?
Below is a list of all rules for manually changing the tier of a customer:
* You will be able to see if the customer resides on a tier because of manual intervention. You will also be able to see the type of tier behavior you set and the reason for the manual adjustment if you have written any.
* When extracting a CSV file of the customers' data, you will find a column that includes information about whether there was a manual tier adjustment for each customer.
* If a customer is manually added to a tier, they will be able to see that and will see the expiry date for staying on that tier (if it exists).
* Gameball integrated apps will be updated with the new tier of the customer.
* When manually adjusting the tier for single or multiple customers, they will receive the tier welcome reward that you have assigned to each tier. They will also receive an email if they were relocated to a higher tier and if the tier email achievement is **on**.
***
## Tier Behavior Details
Gameball will place the customer on the new tier and count the progress starting from the moment the adjustment is applied.
* Any customer added to a tier manually will be excluded from any evaluation that is done on their tier.
* In case of changing the tiering-up method or the tier expiry, the customer will still stay on the manual tier.
* Any customer added to a tier manually will be excluded from any evaluation that is done on their tier.
* Once the expiry date of the manual tier arrives, Gameball will start applying the evaluation according to the current tiering-up method and expiry.
* In case of changing the tiering-up method or tier expiry, the customer will stay on the manual tier until the manual expiry date arrives, then Gameball evaluation will start taking place.
***
## How to Reset a Manual Tier Adjustment
If you want to reset the manually adjusted tier for a customer, go to the customer's profile and click **reset** under the customer's tier.
* When resetting the manual tier, Gameball will evaluate the customer tier according to the chosen tiering-up method/expiry and relocate the customer accordingly.
* If, after resetting the customer's tier, they tiered up according to the evaluation, a tier welcome reward will be given, and an email will be sent to the customer if the tier achievement notification is on.
***
## Related Articles
Set up and manage your VIP tiers structure.
Learn how tier expiry works in different scenarios.
# How Do I Customize Benefits for Different Tiers?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/tier-settings/customizing-benefits-for-different-tiers
Elevate the experience for your most dedicated customers with different benefits for each tier.
| Platform | Plan |
| -------------------------- | --------- |
| Available on all Platforms | All Plans |
Unlock the potential of your customer loyalty program by tailoring exclusive benefits for each tier they reach. When creating or editing tiers, take advantage of the opportunity to design unique benefits specifically for each tier. These benefits can range from discounts, points, different cashback calculations, and free products to brand perks such as free samples and special treatments.
In this article, you will learn more about Gameball's **Tiers Benefits** and how to set them up. But first, [learn how to configure a new tier](/product-documentation/programs/vip-tiers/configuring-gameball-vip-tiers).
***
## Gameball's Tiers Benefits
Choose the reward customers will receive upon reaching this tier. This reward is a one-time offer to incentivize tier progression. To set it up:
**Add** a new tier, or **edit** an existing one.
In the **Benefits** section, click on **Add/Change Reward** beside the **Entry Reward**.
Choose the **Reward Type** you want from the drop-down.
Set up the reward type accordingly. [Learn more about Reward Types and how to set them up](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types).
Press **Save**.
Determine how many points customers earn in this tier for every dollar spent. This feature overrides the default earning points system and allows for personalized point accumulation based on tier. [Learn more about the Earning points system](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system).
To configure:
**Add** a new tier, or **edit** an existing one.
In the **Benefits** section, click on **Add/Change Reward** beside the **Loyalty Points Earning Custom Configuration**.
Enter both the number of points that you want the customers to earn when they spend a certain amount of dollars.
A cashback calculation of the rule that you set will be shown for your reference. [Learn more about how the redemption works](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system).
Grant customers on this tier a recurring benefit that they can enjoy as long as they remain on the tier. To set it up:
**Add** a new tier, or **edit** an existing one.
In the **Benefits** section, click on **Add/Change Reward** beside the **Lifetime Reward**.
Specify the reward type, **excluding points** that cannot be given as a lifetime reward. Set up the reward type accordingly. [Learn more about Reward Types and how to set them up](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types).
Press **Save**.
Offer additional brand perks or benefits beyond the standard loyalty rewards provided by Gameball.
* Write a descriptive text explaining the extra benefits associated with this tier.
* Optionally, add a URL to redirect customers to a page providing more details about the benefits.
***
## Return Window Duration for Tier Entry Reward Points
**Prevent temporary reward abuse** by locking tier-entry points until the return window expires. This ensures customers cannot instantly redeem tier-upgrade rewards and then refund their qualifying orders to gain unfair benefits.
With this update, tier-entry points can be temporarily **locked (pending)** until the configured window expires, improving reward integrity and reducing fraudulent behavior.
### Configuration
A new field is now available inside each **Tier Entry Reward** setup:
* **Return Window Duration (days)**
* Accepts numeric values greater than or equal to 0
* Default value: **0 days** (points activate immediately)
This gives you full control over how long tier-reward points stay locked before becoming usable.
### Updated Reward Logic
When a customer levels up to a new tier:
* Entry reward points are issued with **status = pending**.
* Pending duration matches the configured Return Window Duration.
* Points automatically switch to **status = active** once the window expires.
This ensures points cannot be redeemed during the waiting period.
### Refund and Downgrade Behavior
The system now handles return-window scenarios more intelligently:
| Scenario | Behavior |
| ---------------------------------------------- | ----------------------------------------------- |
| Refund or Tier Downgrade **before** activation | Pending points are **revoked automatically** |
| Refund **after** activation | Standard refund deduction rules apply, as usual |
This eliminates the temporary gain loophole that customers could previously exploit.
***
## Customers Discovering Tier Benefits
Once you've configured the benefits through the Gameball dashboard, customers will see the details prominently displayed in the tier tab of their widget. This ensures that they are aware of the exclusive benefits associated with their tier, enhancing their overall experience and incentivizing continued engagement.
***
## Related Articles
Understand the different methods for advancing customers through tiers.
Learn how Gameball manages tier expiry in various scenarios.
# What Are Tiering-Up Methods?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods
Learn more about the different ways to let customers tier up and choose one that resonates with your customers' preferences.
## Plan Availability
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Points | Yes |
| Tiering-Up Method | Available |
| ----------------- | --------- |
| Amount Spent | Yes |
| Points | Yes |
| Orders Completed | Yes |
| Friends Referred | Yes |
| Score | Yes |
Discover the various pathways to empower your customers to progress through tiers and unlock exclusive benefits tailored to their engagement. Motivate them to spend more time on your platform and become more active participants in your community.
***
## Understanding Tier Progression Methods
At the core of Gameball's tier system lies the ability to define how customers ascend through tiers. By default, all customers start at the initial tier, which serves as the foundation for their journey. While this tier cannot be removed, its attributes can be adjusted to align with your strategy. [Learn more about setting up tiers](/product-documentation/programs/vip-tiers/configuring-gameball-vip-tiers).
***
## Enhancing Tier Advantages
As customers progress to higher tiers, they gain access to enhanced benefits such as fixed discounts and increased point earnings. These rewards incentivize continued engagement and foster a sense of value for loyal customers. [Learn more about tier benefits](/product-documentation/programs/vip-tiers/tier-settings/customizing-benefits-for-different-tiers).
***
## Choosing a Tier Progression Method
To select a tier progression method that aligns with your objectives, consider the following approaches:
Base tier progression on customers' spending habits. The more they invest in purchases, the quicker they ascend through tiers.
The amount spent is calculated using the actual amount paid by the customer. Amount spent using saved points is not calculated or considered part of the tiering up system.
Reward customers with points for their engagement and activity on your platform. Points serve as a universal metric reflecting achievements and can be redeemed for various rewards. Earning more points helps them progress to different tiers.
Prioritize tier advancement based on the number of orders customers fulfill. Each completed order contributes to their progression, regardless of the order value.
Encourage customers to expand your community by referring friends. Tier progression is tied to the number of successful referrals, incentivizing customers to grow your user base.
Introduce a holistic tier progression system that rewards customers for a range of actions beneficial to your platform. Score complements points by recognizing non-monetary contributions, such as referrals and reviews.
With Score, you can design a comprehensive rewards system that encompasses various elements beyond monetary value. Assign scores to specific tasks and achievements, allowing customers to accumulate points based on their contributions to your platform. Score serves as a reflection of their status and tier, distinct from the monetary value of points.
***
## Changing the Tiering-Up Method
When you change the tiering-up method, the following happens:
* All customers will keep their collected data/points.
* Gameball will recalculate the tiers of the customers based on the newly chosen method from the beginning.
* All customers' data will be updated accordingly.
* In the case of downgrading, and the current chosen method is not available in the new plan, the system will switch to **Amount Spent** and will recalculate the tiers of the customers accordingly.
**Example Case of 6, 12, or 24 Months Expiry:** Every time the user changes the tiering-up method, Gameball goes through two steps:
1. **Calculating customers' tiers based on the new method's key value:** Gameball will first calculate every customer's tier based on the new tiering-up method. For example, if the old tiering-up method was based on "amount spent" and then changed to be based on "points," Gameball will check each customer's points and relocate them accordingly; however, this will not necessarily be the customers' final tiers, as it might change during the second step.
2. **Calculating each customer's tier based on their activity during the last 6 or 12 months:** After having known where every customer should be based on the new tiering-up method, Gameball then calculates where they should be according to their last 6 or 12 months' activity. As per the last example, this means if a customer has enough points to get them on tier 3; however, during the last 6 months, their activity was not high enough to keep them on that tier, they might be relocated to a lower tier.
* If a user changed the tiering-up method and the expiry plan on the same day, when changing the tiering-up method, some customers will get relocated to different tiers based on their newly calculated score value. Once they resettle, Gameball will start counting a new 6 or 12 months from the day the tier expiry system has been changed.
* **In case of a lifetime:** If the tiering expiry system was set to lifetime, and you only changed the tiering-up method, Gameball will only calculate every customer's tier based on the new tiering-up method and will measure their progress from the day they joined your platform till today. In other words, Gameball will only apply the first step mentioned above.
***
## Related Articles
Learn how Gameball manages tier expiry in various scenarios.
Configure entry rewards, lifetime rewards, and custom benefits for each tier.
# How Does Tier Expiry Work in Gameball?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/tier-settings/understanding-tier-expiry
Explore how Gameball manages tier expiry in various scenarios.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| --------------------- | --------- |
| Growth (as an Add-On) | Yes |
| Enterprise | Yes |
Tier expiry is a crucial aspect of Gameball's loyalty program, influencing how customers maintain their status and access privileges. By adjusting the expiry system, you can encourage continuous engagement and ensure customers strive to maintain their tiers.
***
## Available Options
Customers retain their tier indefinitely once achieved, enjoying associated benefits until they progress to a higher tier.
Gameball evaluates customer activity over the past 3 months. Customers who meet tier requirements remain, and customers who do not meet the current level of activity will be enrolled in lower tiers that correspond to their activity.
Gameball evaluates customer activity over the past 6 months. Customers who meet tier requirements remain, and customers who do not meet the current level of activity will be enrolled in lower tiers that correspond to their activity in the past 6 months.
Similar to the 6-month/3-month system, but with a year-long evaluation period.
Evaluate customer activity over the past 2 years to determine tier status.
Tiering up is instant while tiering down is re-evaluated every given period (3, 6, 12, 24 months).
***
## Configuring Tier Expiry
Login to **Gameball's Dashboard** and click on **Programs**, then **VIP Tiers** from the left side menu.
In the **Settings** section, click the **Tier Expiry** card. A settings drawer will slide in from the right with your current saved values pre-filled.
Select the expiry option that fits your program, then click **Save**.
***
## Impact of Changes
| Change Type | Behavior |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Switching Expiry Systems | Customers are reassessed based on the new expiry system. Their activity within the specified timeframe determines tier status. |
| Changing Tiering Methods | Gameball recalculates customer tiers based on the new method, considering both current activity and historical data. |
| Adjusting Achievement Ranges | Altering tier requirements affects customer placements. Expiry dates remain unchanged, continuing from the last update. |
| Adding or Removing Tiers | Customers may move to higher or lower tiers without affecting expiry dates. Gameball maintains the existing countdown from the last system update. |
| Manual Tier Assignments | When manually assigning a tier, the expiry date resets for that customer, initiating a new countdown from the assignment date. |
| Plan Changes | Downgrading from Pro or Guru plans shifts the system to lifetime expiry. Customers are relocated based on their historical activity up to the downgrade date. Upgrading or switching plans maintains the current expiry system. |
***
## How to View Tier Evaluation Dates
A **"Tier Evaluation Date"** field appears under the **Tier Information** section on each **customer's profile**.
Displays when the customer's current tier will reset or be re-evaluated.
Customers can now see a clear message like:
* "Your tier will reset on: Jan 1, 2026"
* A countdown (e.g., "7 days left till evaluation") appears one week before the reset date.
* Fully supports **LTR and RTL languages**.
Evaluation dates recalculate automatically when tier settings change (e.g., from 12 months to 6 months).
***
## Related Articles
Understand the different methods for advancing customers through tiers.
Configure entry rewards, lifetime rewards, and custom benefits for each tier.
# How Do Tiers Work on the Gameball Widget?
Source: https://docs.gameball.co/product-documentation/programs/vip-tiers/tiers-on-gameball-widget
A quick guide on your customers' experience with tiers through the Gameball Customer Profile widget.
## How Will Customers View Their Tier Experience?
Customers can easily track their progress and learn about available tiers directly through the **Tiers card** displayed on the **home page of the Gameball widget**. This card shows their **current tier status** at a glance. When customers click on the card, they are taken to a detailed view where they can explore:
View the next tier they can upgrade to and understand what it takes to get there.
See exactly what milestones or spending amounts are needed to reach the next tier.
Explore the exclusive benefits and rewards associated with each tier level.
Track progress in real time and see how close they are to the next tier.
This interactive experience ensures customers are always aware of their current tier, how they can progress, and the value they'll receive as they move up.
The tiers card is only visible to customers when the tiering program is set to **Active**. While the program is inactive, tiers are hidden from the widget entirely. [Learn more about Program Activation](/product-documentation/programs/vip-tiers/configuring-gameball-vip-tiers#program-activation-and-start-date).
***
## What's Next?
Set up and manage your VIP tiers structure.
Configure entry rewards, lifetime rewards, and custom benefits for each tier.
# How Do I Configure Different Reward Campaigns for My Customers Based on Tags?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/faqs/configure-reward-campaigns-based-on-tags
Simulate different rewards through reward campaigns for your customers based on tags.
Through tags, you can simulate endless rewards to be automatically granted to a group of your customers based on their applied tags. You will be able to add tag(s) to your reward campaigns; [customers who have that same tag applied](/product-documentation/understanding-your-customers/gameball-customers) will be the only ones able to participate in and enroll in these campaigns.
To let you understand this more and how you can do magic through tags, check the illustration below.
***
## How to Add Tag(s) on a Reward Campaign
During the [reward campaign creation](/product-documentation/rewards-campaigns/reward-campaign-general-setup-guide) or editing of a campaign template, add a tag at the first step under the **Audience**.
On your **Gameball dashboard**, navigate to **Campaigns > Rewards**.
Click the **three-dot icon** at any campaign, then click **Edit**.
Repeat the same step as if you are adding a tag to a campaign that is being created.
You can remove tags from the reward campaign from the same place.
***
## What Else?
Learn how to apply and manage tags on customer profiles in Gameball.
Customer tags automatically sync with Gameball customers' tags for Shopify stores.
# Stamps, Milestone, and Mission Campaigns: When Should You Use Each?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/faqs/stamps-milestone-mission-campaigns
Learn the differences between Streak, Milestone, and Mission Campaigns.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Milestone | Add-on |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
Gameball provides multiple reward campaign types that can help you engage and retain your customers in different ways. Among them, **Stamps**, **Milestone**, and **Mission** campaigns may seem similar at first glance, but each serves a unique purpose and works differently.
This article highlights the differences between these campaign types in terms of functionality, objectives, and best use cases, so you can choose the right one for your business needs.
***
## Campaign Types
A **Stamp campaign** rewards customers when they complete a specific action repeatedly within a set timeframe without interruption.
* **How it works:** Customers must perform the same action a number of times over a defined period (for example, logging in 7 times within 10 days) or (for example, completing 5 purchases or referring 3 friends within the next month). If they do not log in that many times within 10 days, they will not be rewarded.
* **Objective:** To encourage consistency and regular engagement with your brand.
* **Best use cases:**
* Daily check-ins or app logins
* Regular purchases
* Maintaining weekly activity
[Learn more about Stamps campaign](/product-documentation/rewards-campaigns/templates/engagement-gamification/stamps)
A **Milestone campaign** rewards customers after they reach a specific achievement point or threshold.
* **How it works:** Customers perform an action repeatedly until they hit a predefined target (For example, reach a specific amount of spendings, or completing 10 orders). Unlike streaks, milestones do not require consecutive actions.
* **Objective:** To motivate customers to achieve larger goals over time.
* **Best use cases:**
* Accumulated purchases
* Total referrals
* Reaching a spending target
[Learn more about Milestone campaigns](/product-documentation/rewards-campaigns/templates/engagement-gamification/milestone)
A **Mission campaign** is a more flexible type of campaign that allows you to combine different actions into one reward journey.
* **How it works:** Customers need to complete a set of actions, either in sequence or within a defined timeframe, to earn a reward. Actions can be diverse, such as completing a purchase, leaving a review, and visiting a specific page.
* **Objective:** To create engaging customer journeys that highlight different behaviors you want to promote.
* **Best use cases:**
* Multi-step onboarding journeys
* Seasonal campaigns with varied actions
* Gamified experiences with diverse challenges
* **Example:** You want to run a seasonal campaign for Black Friday. A customer earns a reward after completing these three actions:
1. Add an item to the cart
2. Make a purchase
3. Share the offer on social media
[Learn more about Mission campaigns](/product-documentation/rewards-campaigns/templates/engagement-gamification/mission)
***
## Key Differences at a Glance
| Feature | Stamp | Milestone | Mission |
| ---------------------- | ---------------------------- | ------------------------------- | ---------------------------------- |
| **Action requirement** | Repeated action, Sequential | Repeated action, accumulated | Multiple different actions |
| **Time dependency** | Must be within a time frame | Flexible, no time dependency | Can include deadlines or sequences |
| **Objective** | Build habits and consistency | Motivate long-term achievements | Encourage varied engagement |
| **Best for** | Daily/weekly engagement | Long-term accumulation | Gamified customer journeys |
***
## Important Notes
* Always align your campaign choice with the customer behavior you want to drive.
* Streaks are strict but highly effective for building habits.
* Milestones are easier to achieve since they don't require consecutive actions.
* Missions are the most flexible and engaging but require more setup effort.
***
## Common Questions
Yes, you can run multiple campaigns simultaneously, but make sure they don't overlap or confuse your customers.
It depends on your objective. Streaks are best for daily engagement, milestones for long-term loyalty, and missions for immersive customer experiences.
***
## Related Articles
Set up a stamp campaign to reward customers for repeated consecutive actions.
Configure milestone campaigns that reward customers when they hit cumulative targets.
Build multi-step mission campaigns that combine diverse customer actions into one journey.
# What Is Rewards Types in Gameball?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/faqs/understanding-rewards-types
Let's dive deeper into each reward type that you can offer your customers and how you can set them up.
Rewarding customers is a key strategy to gamify their experience and foster loyalty. Gameball offers a variety of reward types that enable you to incentivize your customers effectively, whether they complete a specific campaign or redeem rewards for points they've collected.
***
## Types of Rewards Offered by Gameball
Gameball provides several reward types across various platforms, each designed to enhance the customer experience.
| Reward Type | Subcategories | Platform |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| **Online Only Rewards** | Points, Free Product, Free Shipping, Fixed Amount-based Discount (Available in Dynamic mode), Percentage-based Discount, Custom Rewards (Third-party), External Reward, Coupon Engine Rewards (Third-party redemption, External Reward API call, Percentage-based cashback coupon, Fixed Amount-based cashback coupon, Percentage-based fee discount) | All platforms |
| **POS Rewards** | POS Fixed Amount-based Discount, POS Percentage-based Discount | Shopify |
| **Shopify-Specific Rewards** | Store Credit, Recharge Fixed Amount-based Discount, Recharge Percentage-based Discount | Shopify |
| **Recharge Rewards** | Fixed Amount-based Discount, Percentage-based Discount | Shopify - Recharge Subscription Users |
***
## Setting Up Each Reward Type
This reward is available as a campaign reward only.
| Platform | Plan |
| -------- | ---- |
| All | All |
* **Add Points**: Specify the number of points to award customers.
* **Tiering Up Method**: If you are using Gameball's score feature for tiering, you can reward customers with scores in addition to points. [Learn more about Score](/product-documentation/programs/vip-tiers/tier-settings).
* **Points Expiry Options**:
* **Default Expiry**: Uses the platform's default points expiration setting. [Learn how to configure your default expiry settings](/product-documentation/programs/loyalty-points-earn)
* **Custom Expiry**: Override the default by setting a specific expiration for that particular reward.
* **Duration Type**: Choose from Days, Months, or Years.
* **Duration**: Define the duration based on the selected type.
This reward is available as a campaign reward as well as a redemption option.
| Platform | Plan |
| -------- | ------------------------- |
| All | All except for free plans |
**Reward Campaign:**
* **Reward Image**: Select the product's image.
* **Advanced Options:**
* **Prefix:** Add Coupon Prefix.
* **Reward expires after a specific amount of time:** Set the expiry for the reward.
* **Minimum purchase amount:** The amount required for usage. (Default: 1)
**Minimum Purchase Applies to the Product Price Only**
When you set a minimum purchase amount on a Free Product reward, Shopify and Salla validate the minimum against the price of the discounted product — not the customer's total cart value. For example, if the free product costs \$22.50 and your minimum is \$50, the coupon will be rejected even if the customer's cart totals \$100 or more.
This is a platform-level limitation on both Shopify and Salla. Set the minimum purchase amount based on the product's price, not the expected cart total.
* **Reward combined with other coupons:** Compatibility with other coupons or to be won alongside other coupons.
* **Show "How to redeem" instructions.**
**Custom Redemption Rule:**
* Follow the same steps as the Reward Campaign setup.
* Add the points needed to redeem this reward in the Redemption Value section.
**How free product coupons work at checkout:** Gameball does not automatically add the free product to the customer's cart. The customer must manually add the product to their cart first, then apply the coupon code. The coupon applies a 100% discount on that product, making it free.
This reward is available as a campaign reward as well as a redemption option.
| Platform | Plan |
| -------- | ------------------------- |
| All | All except for free plans |
**Reward Campaign:**
* **Reward Name:** Choose a name for the reward.
* **Reward Image**: Choose to have the default or upload an image for display.
* **Advanced Options:**
* **Prefix:** Add Coupon Prefix.
* **Reward expires after a specific amount of time:** Set the expiry for the reward.
* **Minimum purchase amount:** The amount required for usage. (Default: 1)
* **Reward combined with other coupons:** Compatibility with other coupons, or to be won alongside other coupons.
* **Show "How to redeem" instructions.**
**Custom Redemption Rule:**
* Follow the same steps as the Reward Campaign setup.
* Add the points needed to redeem this reward in the Redemption Value section.
This reward is available as a campaign reward as well as a redemption option.
| Platform | Plan |
| -------- | ---- |
| All | All |
**Reward Campaign:**
* **Reward Image**: Choose an image.
* **Reward Value**: Set the value (e.g., \$100).
* **Applicability**: Specify if it applies to all purchases or specific **Collections** and/or specific **Merchants.**
* **Advanced Options:**
* **Prefix:** Add Coupon Prefix.
* **Reward expires after a specific amount of time:** Set the expiry for the reward.
* **Minimum purchase amount:** The amount required for usage. (Default: 1)
* **Reward combined with other coupons:** Compatibility with other coupons, or to be won alongside other coupons.
* **Show "How to redeem" instructions.**
**Custom Redemption Rule:**
* Follow the same steps as the Reward Campaign setup.
* Add the points needed to redeem this reward in the Redemption Value section.
This reward is available as a campaign reward as well as a redemption option.
| Platform | Plan |
| -------- | ---- |
| All | All |
**Reward Campaign:**
* **Reward Image**: Choose an image.
* **Discount Value**: Set the discount (e.g., 20% off).
* **Applicability**: Specify if it applies to all purchases or specific **Collections** and/or specific **Merchants.**
* **Advanced Options:**
* **Prefix:** Add Coupon Prefix.
* **Reward expires after a specific amount of time:** Set the expiry for the reward.
* **Minimum purchase amount:** The amount required for usage. (Default: 1)
* **Reward combined with other coupons:** Compatibility with other coupons, or to be won alongside other coupons.
* **Show "How to redeem" instructions.**
**Custom Redemption Rule:**
* Follow the same steps as the Reward Campaign setup.
* Add the points needed to redeem this reward in the Redemption Value section.
This reward is available as a campaign reward only.
| Platform | Plan |
| ------------ | -------------------------------------- |
| Shopify only | Starter, Pro and Guru (Newly enrolled) |
**Reward Campaign:**
* **Credit Value:** Set the Credit value (e.g., \$100).
* **Bonus Expiry**: Set a specific expiry for this reward, overriding the default expiry.
To reward your customers with store credit, you need to complete the following steps:
Enable the Shopify store credit feature and Shopify new accounts from Shopify's Customer Accounts Settings.
Grant Gameball permission to use Shopify's store credit APIs.
***
## Dynamic Value for "Fixed Coupon Rewards"
**Fixed Coupon Rewards** has a **Dynamic Value option**. Instead of being limited to a static reward (e.g., $10 off), you can now configure fixed coupons to dynamically calculate their value based on a percentage of a chosen variable (e.g., **15% of Value X**). In short, instead of always giving $10 off, a merchant can now set the coupon to equal **15% of the customer's cart total or a specific metadata value**, making offers more personalized and impactful.
Configure a fixed coupon with a specific value (e.g., \$10 off) that never changes.
Set the coupon to calculate dynamically as a percentage of a chosen metric, such as the cart total or an order value.
No changes are required in your workflow when switching to dynamic mode — just configure the value type when setting up your fixed coupon rewards. Offers adapt to cart totals, order values, or metadata-driven actions automatically.
***
## Extra Reward Types
In addition to the online rewards, Gameball supports special rewards for Shopify POS systems and Recharge-enabled subscriptions.
This reward is available as a redemption option only.
Read about how to [Enable Customers to Spend Their Gameball Points on Shopify POS](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types).
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | All |
| Salla | Starter, Pro, Guru |
| Non-platform | Contact Support |
* **POS Amount-based Discount**: Reward customers with a fixed discount (e.g., \$10 off) when they purchase in-store.
* **POS Percentage-based Discount**: Offer a percentage discount (e.g., 10% off) for in-store purchases.
Setting up these rewards follows the same steps as the online rewards, ensuring you have integrated your POS system with Gameball.
* **Recharge Amount-based Discount**: Provide customers with a fixed discount on their Recharge subscription orders.
* **Recharge Percentage-based Discount**: Offer a percentage discount on recurring Recharge subscription orders.
Both Recharge rewards work similarly to the online discount rewards but require your store to be integrated with Recharge for subscriptions.
***
## Customizing Your Reward Campaign
[Learn how to set up a customized reward campaign](/product-documentation/rewards-campaigns/reward-campaign-general-setup-guide).
For all rewards, you can adjust the following advanced options to suit your business needs:
* **Prefix:** Add Coupon Prefix.
* **Reward expires after a specific amount of time:** Set the expiry for the reward.
* **Minimum purchase amount:** The amount required for usage. (Default: 1)
* **Reward combined with other coupons:** Compatibility with other coupons or to be won alongside other coupons.
* **Show "How to redeem" instructions.**
Ensure your coupon configuration is compatible with the reward type and platform.
* A **"Check Coupons Details"** button will be displayed on the **success screen** of any game **only if the reward type is a coupon**.
* The button **will not** appear for any other reward types (e.g., points, badges, items).
* When the player clicks **"Check Coupons Details"**, they will be redirected to the **Coupon Details Page** inside the widget.
***
## Related Articles
Build a reward campaign triggered by specific customer actions from scratch.
Set up a reward campaign that fires on a scheduled date or instantly.
Configure custom redemption rules so customers can exchange points for specific rewards.
# How Do I Use the Event Engine?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/faqs/using-the-event-engine
Learn how to use the event engine when creating a reward campaign, referral program, or communication campaign.
Gameball Events Engine helps you set the reward campaign for one or more events your customer needs to complete. You can also add one or more rules per event with this engine.
The events engine is used in multiple cases, like creating communication campaigns, a referral program, or a reward campaign. You will need to use the event engine to set the events that a customer needs to do to trigger a campaign or achieve any of the mentioned programs.
For additional information about events, see [Understand your customers' events](/product-documentation/understanding-your-customers/customer-profile), and [Manage your customers' events](/product-documentation/understanding-your-customers/customer-profile).
***
## Key Operators
For every chosen key in the case of using the event rule, you will find multiple operators based on the data type, which can be either numeric or string:
The received data from the customer for this key should equal a specific value (not case sensitive).
**Use case: Buy from a specific collection or product**
You can specify which product or collection a customer must buy from to meet the rule requirement.
**Entering multiple values**
When using a string field such as SKU, you can enter multiple comma-separated values in the same field (e.g., `SKU01, SKU02, SKU03`). The rule is satisfied if the order contains **any one** of the listed values — they are evaluated with **OR logic**.
The field accepts up to **100 characters** in total (not a count of values). For SKUs, this accommodates approximately 10 values on average.
This will allow you to configure the event to be completed in case Gameball receives X number of different types of data for this key.
**Example:** User-defined key: Category to receive **3 different values**, the customer will complete this event if Gameball receives **Fashion**, **Electronics**, and **Accessories.**
**Use case: Buy from 3 different collections**
If you want your customers to meet a condition with multiple variables, such as to buy at least one product from 3 different collections, then the different values operator is what you need to use.
The received number from the customer for this key should be greater than or equal to a specific value.
**Use Case: Free shipping for orders over \$500**
Grant a reward for when customers exceed a specific order value.
The received data from the customer for this key should equal a specific value in numbers.
The customer should reach a predefined number in one or multiple events for this key, and Gameball will store the received numbers till reaching the predefined number.
**Use case: Get a 20% coupon after spending a total of \$1000**
To create a rule where you want the customer to win a reward after they have spent a total of more than x amount (across all previous orders) you will need to use this operator.
Include will be triggered if the key-value contains the added rule value, and the customer's event should satisfy the included value. For example, if your rule is to reward customers when they buy a certain type of product like "Summer shirts", "Summer accessories", you can just select all products that **include** the word "Summer".
**Use case: Order includes an item from a specific collection**
Let customers win a reward when they complete an order that has at least one item that belongs to a specific collection, while it does not matter what other collections are under the same order.
When using this operator, you are prompted to enter a string value for the key selected, then the number of repeated times which this reward campaign is won. This campaign will be achieved only when the customer meets the configured criteria for the number of repeated times indicated.
By default, each new rule is set to be won for 1 time until the user changes it. The repeated number of times can be within the same event or cumulative.
**Use case: Buy 3 items from a specific collection**
You can create a rule where the customer has to buy 3 different items from the same collection using the repeated value operator.
You can use a **between** operator when working with numeric attributes, allowing you to target customers who fall within a specific numeric range with greater accuracy.
Minimum must be less than maximum.
**Use case: Spend anywhere from 100 to 500**
You can create a rule where the customer has to buy an order where the total price is between 100 and 500.
***
## The AND and OR Relation
You can also create multiple events. These are the relations you can set between those various events:
| Relation | Behavior |
| -------- | ----------------------------------------------------------------------------------------------- |
| **AND** | The customer will have to complete **every event** to win the reward campaign. |
| **OR** | The customer will have to complete **one of** the configured events to win the reward campaign. |
***
## Where You Will Use These Operators
Reward campaigns mainly focus on how to reward your customers when they take certain actions on your platform, especially if you are [creating action-based reward campaign from scratch](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign).
The referral program motivates your customers to spread the word about your platform so you can increase your acquisition and grow faster. When a customer refers a friend, the friend has to first complete a specific action before they receive rewards. [Read more about the referral Program](/product-documentation/programs/referral-program).
You can trigger communication campaigns based on customer actions, for example, when a customer visits a certain page on your website, they will receive a message that pushes them to take further action. [Read more about customer communication campaigns](/product-documentation/communication-campaigns)
You can create segments to target customers who fall within specific ranges based on the actions they made or the properties they have. [Read more about segment creation](/product-documentation/customer-segmentation)
# How Do I Set Up a Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/reward-campaign-general-setup-guide
A step-by-step guide to configuring campaign settings, audience targeting, rewards, notifications, and more.
This guide walks you through the essential setup steps for any reward campaign on Gameball, including how to define your audience, choose triggers and rewards, control repeatability, and track success with goal-based performance metrics.
***
## Audience
This is where you decide who will see and interact with your campaign. Gameball gives you flexible options to target the right users.
The campaign will be visible to everyone, whether they are signed in or not.
Only customers who are logged into their accounts will be able to see and engage with the campaign.
This option is not available for all campaigns.
Targets visitors who haven't signed up yet. Great for encouraging signups or collecting emails before they can join the campaign.
* If you choose **Anonymous** as the audience, the campaign will be available to visitors who are not yet identified on your store.
* Once enabled, a lead form will automatically appear prompting the customer to enter their information (e.g. name, email).
* This is a great way to collect leads and retarget potential customers later.
* You can fully customize this form by navigating to **Customize Design > Lead Form**.
* Available for **Shopify** and **Non-platform** only.
* This option is not available for all campaigns.
Narrow down your audience using detailed filters:
* **Segment**: Target predefined or custom audience segments from your dashboard. [Learn more](/product-documentation/customer-segmentation)
* **RFM Segment**: Reach users based on their Recency, Frequency, and Monetary values. [Learn more](/product-documentation/customer-segmentation)
* **Tag**: Include or exclude users based on specific tags assigned to them. [Learn more](/product-documentation/understanding-your-customers/gameball-customers)
* **Customer Attribute**: Use custom fields like level, join date, total orders, etc.
***
## Trigger
Triggers vary between campaigns, some are based on actions like orders or referrals, others on social interactions such as likes or shares, and some are tied to special occasions like birthdays or anniversaries.
[Check the guide for trigger details per campaign](/product-documentation/rewards-campaigns/reward-campaign-intro)
***
## Repeatability
Set how many times a customer can receive the reward from your campaign.
Customers can receive the reward every time the trigger is fulfilled, with no limit.
Customers can receive the reward only a specific number of times (e.g., 1 time only), even if the trigger keeps happening.
e.g., 10 times only
Customers can receive the reward every time the trigger is fulfilled, but only once (or a set number of times) per day.
e.g., 1 time per day
Customers can receive the reward a limited number of times overall, and also only once (or a set number of times) per day.
e.g., 1 time per day, with a maximum of 10 times in total.
***
## Activation
Decide when the campaign will be active for your customers.
The campaign will run continuously unless you manually deactivate it.
Set a start and end date for the campaign. It will only be visible and active during that time period.
***
## Details
Set up what your customers will see on Gameball's widget in your app or website.
**Campaign Name**
The title of the campaign as it will appear to your customers.
**Campaign Description**
A short message explaining what the campaign is about.
**Redirection Link** \[Optional]
1. **Redirection URL**: e.g., `https://example.com`
2. **Button Text**: Text that appears on the button.
3. **Query Parameters (optional)**: Add custom parameters to personalize or track the link (e.g., UTM-source)
4. This option is not available in all campaigns.
***
## Reward
Set the type of reward customers will receive when they complete the campaign.
Choose one of the following reward types: points, free product, free shipping, etc.
[Learn how to set up each reward type and advanced options.](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types)
***
## Badge
**Icon**
Choose a badge icon for your campaign in one of three ways:
* **Gameball Library** — Select from a curated set of pre-made badge icons.
* **Upload** — Upload your own custom image.
* **AI Image Studio** — Generate a custom badge image by typing a text prompt directly in the dashboard. No design tools or external software needed. Generated images go through automatic post-processing — background removal, light/dark theme injection based on your widget mode, and edge-filling — so assets are production-ready without any manual cleanup.
When clicking **Regenerate**, your last submitted prompt is pre-filled so you can refine it without retyping. Switching between **Generate with AI**, **From Library**, and **Upload** tabs does not clear your prompt. Style selection is locked while a generation is in progress.
Images in the library are organized by their intended slot — backgrounds appear only in background pickers, pointer images only in pointer slots — so purpose-specific assets never show up in the wrong context.
**Visibility**
By default, no badge is selected, meaning the campaign won't appear on the widget. You can choose to:
* **Show dimmed badge until earned**: Badge appears faded, then becomes bright when achieved.
* **Show only when earned**: Badge is hidden until the customer earns it.
**Tier-locked**
* By default, the badge is hidden if you're not part of the selected audience, except when the audience is a specific tier. In that case, the badge will appear with a lock icon, indicating it will unlock once the user reaches that tier.
* To enable this, apply an audience filter based on the tier from the campaign's main configuration page.
***
## Notification
Keep your customers engaged and informed by setting up notifications for their actions and achievements.
**Achievement Notification**
Choose whether to notify customers when they **successfully achieve** the campaign reward.
**Event Notification**
Notify customers when they complete an **action that brings them closer** to achieving the campaign.
Uses the default notification preferences you've already set in your Notifications settings.
[Learn more about configuring global notifications](/product-documentation/rewards-campaigns/reward-campaign-general-setup-guide)
This overrides global settings and **forces notifications ON**, even if they are disabled globally. Allows you to customize the notification content.
This overrides global settings and **forces notifications OFF**, even if they are enabled globally. Customers will not receive any notifications for this campaign.
***
## Goal
Measure the impact of your campaign by tracking a specific action you want your customers to complete.
**Action**
Choose an event like `place_order`, and optionally add filters such as order value, location, or product category to refine it.
**Time Frame**
The goal time frame defines how long customers have to complete the action after the campaign starts (e.g., within 7 days). The count starts from when the campaign starts, not when it ends.
***
## Customization
### Design and Content
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner (For game-based campaigns)**
* **Intro / Main Screen**
* **Lead Form (if audience set to Anonymous Customers - Not logged in)**
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
Customizing the lead form also allows you to add a hyperlink to the "terms and services" so that customers can read and accept them before clicking submit.
***
## Budget Control
Budget Control system allows you to define, monitor, and enforce spending limits for reward-based campaigns. This provides tighter cost governance, clearer visibility, and automated safeguards against overspending.
When creating a campaign, you can enable Budget Control to set a Total Budget, which is always defined in the workspace currency and cannot be changed afterward. Once activated, the system uses the entered amount as the campaign's full spending limit and automatically displays any additional configuration fields needed based on the reward type to ensure accurate cost calculation.
Budget Control requires a valid numerical value, and negative or non-numeric entries are not allowed. If Budget Control is turned on for a campaign that is already active or has been active before, tracking begins only from that moment, previous spending is not counted.
Turning the feature off resets the budget entirely, clears all accumulated metrics, and removes budget-related data from the campaign preview; re-enabling it starts fresh tracking with no historical records.
When editing an existing budget, the system prevents you from saving a value lower than the issued or actual spend and displays a warning if the current costs already exceed the proposed amount. Within the campaign overview, a dedicated Budget card shows the Total Budget, Issued Cost (liability), and Actual Spend (redeemed rewards), and tracking continues even if the campaign becomes inactive since previously issued rewards may still be redeemed.
You will also receive automated email alerts when spending reaches 50%, 80%, and 100% of the budget, and the campaign is automatically deactivated upon hitting 100% to prevent any further spending.
Yes. Once a campaign reaches 100% of its budget, it is automatically deactivated. You will also receive email notifications when the budget reaches 50%, 80%, and 100%.
As for the badge, its visibility depends on two things:
1. Whether the customer has completed the campaign.
2. The badge visibility setting you selected when configuring the campaign.
If a customer has earned the campaign reward, the badge will still appear for them. If not, its visibility will follow the rules you set.
**What does "badge visibility" mean?**
When setting up a campaign, you can choose how (or if) the campaign's badge appears inside the widget. You have three options:
**1. No Badge**
The campaign will not appear anywhere in the widget, whether the customer earns it or not.
**2. Always Visible**
The badge will appear dimmed before the customer earns it. Once earned, it becomes highlighted and will remain visible permanently, even if the campaign is later deactivated.
**3. Visible If Earned**
The badge remains hidden until the customer earns the reward. After achievement, it appears highlighted and stays visible permanently, even if the campaign is deactivated.
# What Is a Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/reward-campaign-intro
Discover Gameball's Rewards Campaigns, formerly known as Challenges, and implement various reward strategies to achieve their objectives.
Rewarding your customers is a powerful way to drive engagement, increase loyalty, and boost sales. In this article, we'll introduce the different types of Reward Campaigns and highlight our ready-made templates designed to help you engage, acquire, retain, personalize, grow, and celebrate special occasions with your customers.
## Types of Reward Campaigns
There are two ways you can create reward campaigns on Gameball:
Customize a campaign from the beginning with full control over every setting.
Ready-to-use templates that help you serve specific goals quickly.
***
## Start a Campaign from Scratch
To start creating a campaign from scratch, pick one of the following campaign types:
Reward customers based on specific actions they take, such as making a purchase, referring a friend, or completing a survey.
Reward customers on certain dates or occasions, such as birthdays, anniversaries, or holidays, to create a sense of exclusivity and appreciation.
Multiply the points earned by customers when they make a purchase, previously known as Cashback Campaigns, to incentivize spending and drive repeat purchases.
Create custom rewards triggered by specific actions on apps connected to Shopify Flow, letting you tailor rewards for unique actions like social engagement.
***
## Ready-Made Reward Campaign Templates
Gameball offers a range of ready-made templates categorized based on your objectives. These templates can be **filtered by reward campaign types.**
Before diving into the available templates, you must recognise the different types of templates you can distinguish through the **Tags** and **Icons** on each card.
| Tag | Description |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Shopify Flow | Available only on Shopify Flow. |
| Pop-up | This campaign does not only appear on the widget, but could be displayed as a pop-up when your customers visit your platform. This guarantees higher participation number. |
| Hard | Usually found on Game related campaigns. Means it is relatively more difficult to play and win than the other games. |
| Crown icon | Available on under a specific plan. |
***
## Available Types and Templates
Aimed to engage with customers in a fun, interactive manner and to keep them coming back for more.
Let customers spin a wheel for a chance to win prizes.
A slot machine game that rewards lucky customers.
Customers scratch a card to reveal their reward.
A memory card-matching game with rewards for winners.
An arcade-style catching game with reward prizes.
Reward customers who answer quiz questions correctly.
Collect customer feedback with a native question builder and reward completion.
Reward customers for completing a survey via Shopify Flow.
Encourage daily visits by rewarding consecutive check-ins.
A calendar-based challenge campaign for sustained engagement.
Reward customers who collect stamps through repeated actions.
An interactive driving game that rewards top performers.
A tap-based game where customers aim for targets to win.
A classic tic-tac-toe game with reward-based outcomes.
A challenging sliding puzzle game for dedicated players.
An arcade space shooter game with points and prize rewards.
Aimed at attracting new customers and incentivizing them to take specific actions, such as making their first purchase.
Reward customers who create a new account on your platform.
Display a pop-up offering a first-order discount to new visitors.
Capture emails and reward newsletter sign-ups via a pop-up.
Reward newsletter subscriptions triggered through Shopify Flow.
Designed to increase customer engagement through gamification and interactive challenges.
Reward customers for sharing content on Facebook.
Reward customers for sharing content on Instagram.
Reward customers for sharing content on Twitter.
Reward customers for sharing content on TikTok.
Reward customers for leaving a product review.
Reward reviews submitted through a Shopify Flow trigger.
Reward customers who leave a Google review for your business.
Geared towards growing your customer base and increasing sales through promoting a specific product or collection, and other growth-oriented activities.
Reward customers who place their first order.
Incentivize customers to return with a second purchase reward.
Drive a third purchase with a loyalty reward.
Celebrate the fifth order milestone with a special reward.
Reward customers who reach their tenth order.
Run a limited-time double points earning promotion.
Reward customers who beat their personal highest order value.
Issue a 20% coupon once a customer crosses a \$1000 spend threshold.
Reward customers who purchase a targeted product.
Incentivize purchases from a featured collection.
Reward customers who shop across three different collections.
Reward customers who add three items from the same collection.
Offer a reward on the next order after a qualifying purchase.
Give a $5 next-order reward for orders above $50.
Unlock free shipping for customers who spend over \$500.
Celebrate special occasions such as birthdays, holidays, or milestones with your customers by offering exclusive rewards and promotions.
Send a special reward to customers on their birthday.
Celebrate customers' anniversaries with exclusive rewards.
Run time-limited campaigns tied to seasonal promotions.
Supercharge Black Friday sales with a targeted reward campaign.
Delight customers with a festive Christmas reward campaign.
***
## How to Use Reward Campaigns
From the left side menu, navigate to the **Campaigns** section and click on **Rewards**.
You are now on the reward campaigns page, where you can see and manage data on previously created campaigns.
Choose the desired **template based on your objectives**, or choose to create a **new reward campaign from scratch**.
Make the necessary adjustments and **activate** the reward campaign to start rewarding your customers and driving desired behaviors.
***
## Manage Your Campaigns Efficiently
Gameball offers convenient shortcuts to manage your reward campaigns seamlessly. When you access your campaigns through the **Gameball Admin Dashboard,** you'll find a comprehensive **list of all your created campaigns** along with their details.
By **clicking on the points** beside each campaign, you'll unlock a range of options to streamline your campaign management process.
| Shortcut | Description |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Duplicate | Create an identical copy of the selected campaign. This is useful when you need to replicate a campaign with minor adjustments. |
| Activate / Deactivate | Toggle the active status of the campaign. Easily enable or disable a campaign to control its visibility and functionality. |
| Edit | Make adjustments to the settings and details of the selected campaign. Access the campaign's inner page to modify its configuration as needed. |
| Copy to Workspace | Copy that same campaign to a different workspace. |
| Campaign URL | Copy campaign URL. |
| Delete | Permanently remove the selected campaign. Exercise caution when using this option, as deleted campaigns cannot be recovered. |
By utilizing these shortcuts, you can efficiently manage your reward campaigns, saving time and ensuring that your customer engagement strategies remain dynamic and effective.
***
## Related Articles
A deep dive into every reward type available and how to configure each one.
Learn which metrics to track and how to measure campaign performance.
# What Is the Reward Campaign URL?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/reward-campaign-url
Using Campaign URLs to Share Your Game Campaigns
| Platform | Plan |
| ------------ | ------------- |
| Shopify | Not Available |
| Salla | Not Available |
| Non-Platform | All Plans |
The Campaign URL is available for game campaigns only.
## Intro
Gameball makes it easier than ever to engage your customers, no technical integration needed. Instantly generate and share a Campaign URL for your games across social media, email, SMS, or offline channels. Perfect for businesses without apps or websites: just share the link and start engaging!
***
## How to Access the Campaign URL
After creating a campaign, you can find the Campaign URL next to the internal campaign name at the top.
Click the three dots next to the campaign, and select **Campaign URL** from the dropdown menu.
***
## Campaign URL Options
The URL may either open directly for customers to play the game or prompt a lead form to identify the customer first, depending on the selected audience.
| Case | Details |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **1. Audience: Registered / Specific Customers** | The URL will contain a customer ID placeholder `{customerid}`. Replace `{customerid}` with the actual customer value or your dynamic variable. The customer is automatically identified and enters the game directly. Example: `https://play.gameball.app?k=xxx&p={customerid}&d=details_spin_123` |
| **2. Audience: Anonymous** | No ID is passed in the URL. The customer will see a form requesting their Email or Mobile Number before playing. You can customize the lead form from the customization page. Example: `https://play.gameball.app?k=xxx&d=details_spin_123` |
* If the URL is missing the ID, the game will not load.
* If the customer ID passed in the URL doesn't exist in Gameball, we will create a new customer account.
* Customers are created as **members**.
* You can set whether the customer identifier field on the form is **Email** (default) or **Mobile.**
* If the customer fills out the form and does not already exist in Gameball, a new customer account will be created.
* Customers are created as **guests**.
***
## Lead Form Configuration (When Audience is Anonymous)
When the campaign audience is set to **Anonymous**, a lead form appears before the game to collect the customer's information. You can customize this form from **Customize Design > Lead Form** in any game campaign — this applies to all platforms including Shopify.
The Campaign URL sharing feature is available on Non-Platform plans only. However, lead form customization is available to all platforms (including Shopify) whenever a game campaign audience is set to Anonymous.
The lead Form gives you more flexibility and control over the customer data you collect from guest users. You can enrich the Lead Form with your own **custom customer attributes**, allowing you to gather more meaningful information beyond the standard fields.
* **Lead Form supports 5 custom customer attributes:** You can include any previously created customer attributes, such as City, Gender, Favorite Product, Age, and more, using a multi-select dropdown. Custom fields display with the correct input type (text, number, date picker, toggle) and follow all validation rules.
* **Control over field configuration:** Rearrange fields, mark them as mandatory or optional, and toggle default fields (Name, Email, Mobile) on/off. Email or Mobile can be selected as the unique identifier, and unique identifiers cannot be removed or set as optional.
* **Smart data handling for guest users:** All submitted attributes are saved to the guest's temporary profile and automatically mapped to their customer profile once they are identified (e.g., login or purchase).
| Field | Notes |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name** | Optional. A field to collect the customer's name. |
| **Email** | Default identifier. A field to collect the customer's email. Required unless Mobile is selected as the identifier. |
| **Mobile** | Can be enabled and set as the primary identifier instead of Email. Mobile numbers are stored in **E.164 international format** `+[Country Code][Number]` (e.g., `+1XXXXXXXXXX`). |
| **Terms and Conditions** | Optional. A checkbox to confirm customer agreement. |
**If Channel Merging is enabled and the mobile number is used as the unique identifier across all customer channels:**
* When a GB customer creates an account for their player, they must use the same mobile number format we use in the lead form. **Format:** `+[country code][area code][number]` **Example:** For Egypt: `+201xxxxxxxx`
* If the customer provides the mobile number without following this format (e.g., missing the `+`), a new account will be created instead of linking to the existing one.
If an already registered customer filled out the lead form, Gameball will add the missing data to their profile and ignore the already collected data. For example, a registered customer fills out the lead form, providing their name, email address, and phone number.
Gameball checks and finds out that this is, in fact, a registered customer and that it already has their name and email filled, but it has no phone number. Gameball will only add the phone number to their stored profile data and will not overwrite the name and email, as this information has already been previously collected.
***
## Important Notes
**Replace Customer ID**
When using a URL with a customer ID, make sure to replace `customerid` with the actual customer value or your dynamic variable.
**Change Language**
* You can change the game language to any of the configured languages by passing the `lang` attribute in the URL (e.g., `?lang=ar` for Arabic).
* If the `lang` parameter is not passed, the game will open using the widget's default language.
* You can update or manage your available languages from **Widget Settings > General > Languages**.
***
## Automatically Trigger Game Popups Based on Page URL
Surface Gameball Games on websites by automatically launching a game in a pop-up when a customer visits a specific page. This allows you to deliver game-based engagement experiences without requiring customers to open the Gameball widget.
### Automatic Game Popups
Games such as Spin the Wheel, Slot Machine, and Match Cards can now be triggered automatically when a page URL matches predefined rules. The experience opens directly in a standalone pop-up rather than inside the widget.
### Game Pop-Up Experience
The game pop-up provides a streamlined, distraction-free experience by displaying only the game interface without any widget navigation elements. Customers can play the game or close the pop-up at any time, and it will automatically close once the game is completed or dismissed. Guest users will see the game alongside a lead form, while logged-in customers access it according to their eligibility criteria.
### URL Rules and Display Controls
You can configure where the game pop-up appears using the same flexible URL rule engine as Web Popups. The pop-up can be set to display on all pages where the widget is installed or only on pages that match specific conditions, such as "contains," "does not contain," "is," "is not," "starts with," or "ends with." You can also control how often it appears -- either once per session or a limited number of times. Additional timing options allow the pop-up to show immediately on page load, after a delay, or once the customer scrolls a defined percentage of the page.
### Eligibility Behavior
The pop-up will not appear for customers who are no longer eligible to play the game, such as those who have reached a daily or lifetime limit. When multiple campaigns share the same trigger conditions, the system prioritizes the campaign that was created first.
***
## Related Articles
A complete guide to configuring all reward campaign settings from audience to activation.
Understand the full range of reward types you can offer customers.
# What Insights Are Available for Reward Campaigns?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/reward-campaigns-insights
A breakdown of the key metrics available to evaluate the reward campaigns effectiveness.
| Platform | Plan |
| ---------- | ------------ |
| Shopify | Pro and Guru |
| Self Serve | All |
Reward campaigns are an essential tool for engaging customers, increasing your revenue, and driving desired behaviors. To effectively measure the performance of these campaigns, it's crucial to analyze various metrics that provide insights into their effectiveness.
***
## Where to Find Insights for Every Reward Campaign
From the left bar, click **Rewards** under **Campaigns**. Then choose any created campaign from the list.
Go to the **Insights Tab** to view all performance metrics for that campaign.
***
## Insights Explanation
Here's a breakdown of the **key metrics available** for you to evaluate the performance of your reward campaigns:
This metric measures the percentage of customers who successfully completed the campaign compared to the total number of customers the campaign was sent to. It is calculated using the **equation**:
**Number of customers completed the campaign / Total number of customers the campaign was sent to.**
The abandonment rate is the inverse of the completion rate and represents the ratio of customers who abandoned the campaign without completing it.
This metric indicates the total number of unique customers who participated in the campaign.
The total times customers participated in the campaign. It represents the overall level of engagement generated by the campaign.
The aggregate sum of points awarded to customers through the campaign. It reflects the total incentive provided to participants.
Similar to points, this metric represents the total number of coupons distributed as rewards during the campaign.
This metric provides both the total points awarded and their corresponding monetary value. It offers insight into the tangible benefits customers receive from participating in the campaign.
This graph visualizes the trend of campaign participation rates over a specific period. It helps identify any variations or patterns in customer participation.
Similarly, this graph tracks the number of customers completing the campaign over time. It allows for a continued analysis of campaign effectiveness.
***
## Funnel Analytics Insights
**Game Funnel Analytics** is an insights module that gives you a clear, step-by-step view of how your customers interact with every game campaign, across all game types, entry methods, and user types.
This funnel helps you understand where customers engage, where they drop off, and how effectively your game campaigns drive conversions.
### Supported Game Types and Entry Methods
**Unified Funnel Tracking for All Game Types**
Game Funnel Analytics supports **all Gameball games**, including:
Full funnel tracking for spin wheel campaigns.
Full funnel tracking for slot machine campaigns.
Full funnel tracking for scratch card campaigns.
Full funnel tracking for match card campaigns.
Full funnel tracking for catcher game campaigns.
Funnel-only insights added for quiz campaigns.
Both **guest customers** (via lead form) and **registered customers** are fully tracked.
Supported entry methods:
* Widget
* Deep link / direct URL
* Popup trigger
* Manual open
### Funnel Stages Tracked
Each game campaign includes a consistent set of funnel steps:
Triggered only when the game auto-displays via a pop-up.
Captured when a guest customer submits the lead form.
When a customer opens the game from any entry point.
When the customer clicks "Play".
When the game animation/logic finishes, regardless of the outcome.
**Rewarded** displays how many customers received a reward. **No Luck** shows customers who completed but did not receive a reward or lost.
### What Each Stage Shows
Each funnel stage displays the following data:
* Total customers
* Conversion rate to the next step
* Drop-off visualization
* Filtering aligned with the campaign's date filter
**Key metrics:**
* **Total Participated** = top-most tracked event.
* **Goal Completed** = customers who reached the last tracked step.
* **Total Conversion** = Completed / Started.
### Conversion and Drop-Off Logic
| Scenario | Example |
| ---------------------- | ------------------------------------------------------------- |
| **Step Conversion** | 1,000 opened → 750 started = 75% conversion. |
| **Step Drop-Off** | 25% dropped between "Opened" → "Started." |
| **Overall Conversion** | 1,000 opened → 200 reached the goal = 20% overall conversion. |
***
## Survey & Quiz Response Analytics
Read your Survey and Quiz results directly on the Insights page, without downloading a CSV.
### Aggregated Results
Every published Survey and Quiz question gets aggregated results, rendered by question type:
| Question Type | What's Shown |
| ----------------------------------- | ---------------------------------------------------------------------------------- |
| **Single Choice / Multiple Choice** | A distribution bar per option with count and percentage of respondents. |
| **Rating Scale** | The average as a headline number, plus a distribution across each scale point. |
| **NPS** | A −100 to +100 score with Promoter, Passive, and Detractor counts and percentages. |
| **Short Text / Long Text** | A scrollable list of answers with customer name and submission date. |
A survey-level header shows completion rate, distinct respondents, average time to complete, rewards issued, and participation over time — with a date-range filter across all aggregated results.
Historical aggregates stay accurate even after options are renamed, edited, or deleted.
### Individual Submissions
Open any single customer's complete question-by-question response set from the **Customers List**, using the **View Submission** action.
***
## Filtering Reward Campaigns Insights
In addition to these metrics, you can adjust the period for which you want to view the data directly from the report.
The report is designed to clearly demonstrate the value of Gameball's services in enhancing your business, highlighting how the campaign positively impacts engagement and revenue. Further, it helps you implement strategies to re-engage your customers with the campaign's configuration page, such as notifications, reminders, or incentives, especially after initial configuration.
***
## Related Articles
Step-by-step guide to building an action-triggered reward campaign from scratch.
Learn how to schedule campaigns around specific dates and occasions.
Set up a campaign that multiplies points earned on purchases.
# How Do I Send External Rewards Using API Calls Through Campaigns?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/send-external-rewards-using-api
Enable external rewards through Gameball campaigns without additional development, to connect your existing loyalty system seamlessly.
| Platform | Plan |
| ----------------- | --------------------- |
| Non-Platform only | Growth and Enterprise |
Gameball now supports engaging customers with gamified campaigns, even if you use your own loyalty program. You can leverage Gameball's campaign engine while sending external rewards -- like points, cashback, or physical gifts -- directly through their existing systems.
Gameball offers a new **External Reward (API Call)** option directly within campaign rewards.
This feature allows you to:
Connect your loyalty program without any additional backend development.
Reward customers with external benefits (points, cashback, physical goods, etc.) using a customizable API payload.
Speed up campaign activation and reduce technical dependencies.
***
## How to Configure External Rewards in Campaigns
Under **Rewards Types**, select **External Reward (API Call)**.
* **Reward Name**
* **API Data**
* API URL
* HTTP Method
Include any of the following dynamic variables in the **Body** of the API data as needed, as well as the **Headers**:
* `UniqueID`
* `First Name`
* `Last Name`
* `Mobile Number`
* `Email`
* `CampaignID`
* `Campaign Internal Name`
* `Reward Name`
This feature is available for campaign rewards only. It is not supported as a redemption method.
***
## Test API
Test API call configurations directly while setting up **Reward Campaigns** or **Automation Triggers**, ensuring your integrations work correctly before activation.
When configuring an API call in a reward campaign, click **"Test API"** to send a sample request and view:
`Response: 200 OK - Connection successful`
This makes it easier than ever to validate your setup confidently before going live.
***
## Common Questions
Yes, as long as your system accepts external API requests with the necessary data format.
Yes. This eliminates the need to develop and maintain a webhook listener for reward distribution.
***
## Related Articles
An overview of all reward campaign types and ready-made templates available in Gameball.
A detailed breakdown of every reward type and how to configure each one.
# How Do I Create an Action-based Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign
Learn how to create and configure an Action-Based reward campaign from scratch.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| ---------- | --------- |
| Growth | Yes |
| Enterprise | Yes |
Reward campaigns are powerful tools for driving customer engagement and loyalty. With Gameball, you can easily create and configure reward campaigns tailored to your business objectives, and reward your customers for any action that they perform on your platform.
Let's say, for example, that you want to reward your customers when they visit a certain product page with a 100-point reward. Once the customer completes this action, the event will be sent to Gameball, and the customer will earn their reward. [Learn more about Gameball Events](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Creating a New Action-Based Reward Campaign
Log in to your **Gameball Dashboard**. Navigate to the **Campaigns** section on the left side menu and click on **Rewards**.
Click **Create Reward Campaign**. Choose **Action Based Reward** from the **'Start from Scratch'** section.
Give your new campaign an **internal name** for your team, and then start the configuration.
***
## Configuration of an Action-Based Reward Campaign
Define the rules that determine when customers receive the campaign's rewards. Utilize Gameball's event-based engine to create sequences of rules that customers must follow to earn rewards.
Choose who is eligible to view and participate in this campaign:
* All Customers
* Specific Customers:
* Segments
* Tags
* Customer Attributes
* Combination of Segments, Tags, or Customer Attributes
After choosing the campaign's audience, you will be able to view the number of customers that are currently eligible to participate in this campaign.
Choose the rules that grant the customers the campaign's reward once achieved.
Let's say you want to reward the campaign's audience once they complete **1 order from Collection X, and 1 order from Collection Y**:
1. Select **Place Order** for the **Choose Event** dropdown menu.
2. Make your **After Counter** to **1** (this sets how many times the event should be achieved before rewarding the campaign).
3. **Add** a **Rule**, where the **Collection ID** equals **X**.
4. Add another Rule to complete the second part of the trigger. Click on **Add Rule**.
5. Select **Place Order** for the **Choose Event** dropdown menu.
6. Make your **After Counter** to **1**.
7. **Add** a **Rule**, where the **Collection ID** equals **Y**.
Check this article about [using the event engine](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) to understand more about how to create a campaign trigger.
Define the repeatability settings to specify how many times customers can achieve the campaign's rewards.
**No Limit Per Customer:**
* **Unlimited per customer**: this campaign can be achieved by your customers every time the trigger is fulfilled.
* **Limited to 1 time or more:** this campaign can be achieved 1 time(s) after fulfilling the trigger.
**With a Limit Per Customer:**
* **Unlimited Repeatability with a limit of 1 per day**: This campaign can be achieved by your customers every time the trigger is fulfilled, however, every customer can achieve it only 1 or more times/day.
* **Limited Repeatability with a limit of 1 per day**: This campaign can be achieved by your customers every time the trigger is fulfilled until the limit you've set, however, every customer can achieve it only 1 or more times/day.
Choose when this campaign will be available for your customers:
* **Always Active**: The campaign will always be available for its audience unless you deactivate it.
* **Scheduled**: The campaign will have a certain **start date** and **end date**. Before and after these dates, the campaign will not be visible to the audience.
Set up the information that will be displayed to the customers on Gameball's widget on your website/mobile app:
* Reward Name
* Reward Information
* \[Optional] **Redirection Link** (Navigates the customers to a desired page on the website/mobile app). You can use any URL — social sharing templates such as Instagram or TikTok do not restrict or validate the destination URL.
**Rewards**
Choose the type of reward that you will offer the audience once they achieve this campaign, and define the reward parameters to ensure it aligns with your campaign goals.
Choose one of the following **Reward Types**:
* Points
* Free Product
* Free Delivery
* Fixed Amount
* Percentage Based Discount
[Learn more on how to set up each Reward type.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
**Badge**
Along with the reward, the customer will be rewarded a Badge for the campaigns they achieve. Customize badge settings to visually represent the campaign's achievement:
1. Choose a **Badge Icon** for this campaign. You have three options:
* **Gameball Library** — Pick from a curated set of pre-made icons.
* **Upload** — Upload your own custom image.
* **AI Image Studio** — Type a text prompt to generate a custom image directly in the dashboard.
2. Configure **Badge Visibility**:
* By **default, no badge** will be chosen (Campaign not visible on the widget).
* You can choose for it to be:
* Dimmed and becomes bright upon earning
* Only **show badge when earned**
3. Configure **Badge Unlocking Process:**
By default, the badge will be unlocked to all tiers; it will appear dimmed until earned. However, you can choose for the badge to start appearing to customers when they are on a certain tier:
Configure **in-app and email notifications** to keep customers informed about their progress and achievements.
Decide whether you'd like to inform your customers upon achieving a reward campaign.
Select whether to notify customers after every completed action that brings them closer to achieving the reward campaign.
For both Notification types, you have the option to choose from the following:
* **Follow Global Settings:** Notifications will adhere to the predefined notification settings you configured in the notifications section. [Learn more about sending real-time notifications for reward campaign programs.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
* **Always Enabled**: Customers will receive a notification after completing an event or reward campaign.
* **In-app Notification:** Add Notification **Title** and Notification **Body**.
* **Email:** Add Email Subject and use the Email Builder to Customize the Email.
* **Always Disabled:** Customers will not receive any notifications after completing an event or reward campaign.
Define the campaign's goal to monitor its performance and effectiveness:
* Toggle the goal setting on or off based on your preference.
* Set event-based goals using the event engine to track customer actions and outcomes.
Now that you have created and configured your campaign, remember to press **Save**, **Preview**, and then **Activate** your campaign.
There are other types of Reward Campaigns. Learn how to create and configure each of them below:
* [Create & Configure a Time-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-time-based-reward-campaign)
* [Create & Configure a Points Multiplier Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-point-multiplier-reward-campaign)
***
## Related Articles
Explore the full setup guide for reward campaigns, including events, rewards, and notifications.
# How Do I Create a Point Multiplier Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/start-from-scratch/create-point-multiplier-reward-campaign
Learn how to create and configure a Point Multiplier reward campaign from scratch.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Starter | Yes |
| Pro & Guru | Yes |
| Plan | Available |
| ---------- | --------- |
| Growth | Yes |
| Enterprise | Yes |
Let's say you have the cashback set up for your customers to gain 1 point for every pound that they spend, but on certain occasions, you want to reward your customers with more than one point, let's say for example, on Black Fridays. This is where the **Point Multiplier Reward Campaign** comes into play. It's a campaign that you set on certain dates that multiply the number of points that a customer earns when they complete a purchase.
***
## Creating a New Point Multiplier Reward Campaign
Log in to your **Gameball Dashboard**. Navigate to the **Campaigns** section on the left side menu and click on **Rewards**.
Choose **Points Multiplier Reward** under the **'Start from Scratch'** section.
Give your new campaign an **internal name** for your team, and then start the configuration.
***
## Configuration of a Point Multiplier Reward Campaign
Define the rules that determine when customers receive the campaign's rewards. Utilize Gameball's event-based engine to create sequences of rules that customers must follow to earn rewards.
Choose who is eligible to view and participate in this campaign:
* All Customers
* Specific Customers:
* Segments
* Tags
* Customer Attributes
* Combination of Segments, Tags, or Customer Attributes
After choosing the campaign's audience, you will be able to view the number of customers that are currently eligible to participate in this campaign.
Set directly in the Rules section — no separate popup needed. Choose how many times a customer can earn this campaign:
* **Unlimited**
* **A total limit** (overall)
* **A per-period limit**
* **A combination of both**
For Points Multiplier rewards, the trigger is automatically set to the event "Place Order." You now have two options to configure this campaign:
1. **Apply the Points Multiplier to All Orders**: By default, the multiplier will apply to every order placed by your customers.
2. **Apply the Points Multiplier to Specific Collections or Product SKU**: If you only want to apply the multiplier to a specific collection or a product (e.g., during a sale or promotion), you can add a rule that includes the collection's ID. This way, the multiplier will only be applied to orders that include items from that particular collection or the product alone.
You can enter **multiple SKUs** in the SKU field using comma separation (e.g., `SKU01, SKU02, SKU03`). Multiple values use **OR logic** — an order qualifies if it contains any one of the listed SKUs.
The SKU field has a **100-character limit** (total field length, not a count of SKUs). On average, this accommodates approximately 10 SKUs.
This feature (editing rules) is available on the **Enterprise** & **Guru** plans only.
Choose when this campaign will be available for your customers:
* **Always Active**: The campaign will always be available for its audience unless you deactivate it.
* **Scheduled**: The campaign will have a certain **start date** and **end date**. Before and after these dates the campaign will not be visible to the audience.
Under **Reward Structure**, choose how you want to apply the multiplier:
**Default Reward** — Enter any custom multiplier value. You are not limited to preset options; you can set any number (e.g., 7x). As you type, the preview at the bottom updates in real time to show the resulting earn rate based on your base earn rule (e.g., "Customers will earn 10.5 points for every 1 USD spent").
**Point Multiplier Levels** — Set up spend-based tiers so customers earn different multipliers depending on how much they spend in a single order. Select the spend attribute (e.g., **Total Price**), then define each tier with a **Min Spend**, **Max Spend**, and **Multiplier** value. Use **Add Tier** to add more levels. The preview at the bottom shows the resulting equation for each tier based on your base earn rule.
The active tier and next-tier progress are available via the API, so you can surface the earning opportunity directly in your storefront or app.
Now that you have created and configured your campaign, remember to press **Save**, **Preview**, and then **Activate** your campaign.
***
## Transaction-Level Visibility
Open a Points Multiplier campaign and go to its **Campaign Activity** tab (next to **Overview** and **Insights**) to see exactly which orders it touched:
| Column | Description |
| ----------------- | ------------------------------------------- |
| **Customer ID** | The customer who triggered the transaction. |
| **Email** | The customer's registered email address. |
| **Reward** | The reward type applied (e.g., points). |
| **Order Details** | The order the multiplier was applied to. |
| **Points Value** | The points awarded for this transaction. |
| **Achieved At** | Timestamp of the transaction. |
Multiple transactions from the same customer appear as separate rows — no aggregation hides detail. Use the filter and sort icons above the table to narrow results, and **Export** to download the list.
**Activity Log** entries also show an indicator when a multiplier was applied, linking straight back to the campaign. Activity log exports gain **Applied Multiplier Campaign ID** and **Name** columns.
***
## Custom Expiry for Points Multiplier Campaigns
Set a configurable expiry period for points earned through point multiplier campaigns. This gives you full control over when bonus points are activated (respecting your return window) and when they expire, helping reduce fraud risk and liability.
### Why This Matters
Previously, points earned from multiplier campaigns (e.g., Double Points) were **activated immediately** without considering your return/refund window. This exposed merchants to:
| Risk | Description |
| ---------------------- | ----------------------------------------------------------------------- |
| **Fraud risk** | Customers could earn and use points before returning items. |
| **Inflated liability** | Early activation of bonus points inflated outstanding loyalty balances. |
With this update, you can now:
* Delay **point activation** until after the return window passes.
* Define a **custom expiry period (days)** for multiplier campaign points, just like in other reward campaigns.
* Align rewards with **finalized, eligible transactions** only.
### Partial Returns and Condition Thresholds
If a customer earns a multiplier by meeting a condition (e.g., ordering 2 or more items) and then returns part of the order — dropping below the qualifying threshold — **Gameball does not reverse the bonus points already earned**. Points are deducted proportionally based on the returned item's value (including the multiplier), but there is no retroactive reversal of the multiplier itself.
For example: a customer orders 2 items, qualifies for a 2x multiplier, earns 200 points (100 base + 100 bonus), then returns 1 item. Gameball deducts 100 points (50 base + 50 bonus). The remaining 100 points stay with the customer even though they no longer meet the 2-item condition.
To reduce exposure to this, use the **Return Window** setting to delay point activation until after your return window closes.
There are other types of Reward Campaigns. Learn how to create and configure each of them below:
* [Create & Configure a Time-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-time-based-reward-campaign)
* [Create & Configure an Action-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign)
***
## Related Articles
Explore the full setup guide for reward campaigns, including events, rewards, and notifications.
# How Do I Create a Recurring Customer Date Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/start-from-scratch/create-recurring-customer-date-reward-campaign
Learn how to create and configure a recurring customer date reward campaign from scratch.
## Plan Availability
| Plan | Available |
| ---- | --------- |
| All | Yes |
| Plan | Available |
| ---- | --------- |
| All | Yes |
Reward campaigns are powerful tools for driving customer engagement and loyalty. With Gameball, you can celebrate and engage customers on **any meaningful date** you track, such as their birthday, anniversary, join date, subscription renewal date, pet birthday, membership start date, or any custom date attribute.
***
## Creating a Recurring Customer Date Reward Campaign
Log in to your **Gameball Dashboard**. Navigate to the **Campaigns** section on the left side menu and click on **Rewards**.
Choose **Recurring Customer Date** under the **'Start from Scratch'** section.
Give your new campaign an **internal name** for your team, and then start the configuration.
***
## Configuration of a Recurring Customer Date Reward Campaign
Define the rules that determine when customers receive the campaign's rewards.
Choose who is eligible to view and participate in this campaign:
* All Customers
* Specific Customers:
* Segments
* Tags
* Customer Attributes
* Combination of Segments, Tags, or Customer Attributes
After choosing the campaign's audience, you will be able to view the number of customers that are currently eligible to participate in this campaign.
Choose when you want your audience to receive the reward. Examples include:
* First Captured Order Date
* Date of birth
* Join date (anniversary)
* Graduation Date, Pet Birthday, Membership Date, Subscription Renewal Date, etc.
**How does Gameball fetch these dates?**
* By default, Gameball collects these customer dates: Join Date, Creation Date, and First Order Date.
* Other dates can be sent to us through APIs (Contact Support).
Click **Change**, and set the number of times the customer can keep being rewarded annually for this occasion.
Set up the information that will be displayed to the customers on Gameball's widget on your website/mobile app:
* Reward Name
* Reward Information
* \[Optional] Redirection Link (Navigates the customers to a desired page on the website/mobile app).
**Reward**
Choose the type of reward that you will offer the audience once they achieve this campaign, and define the reward parameters to ensure it aligns with your campaign goals.
Choose one of the following **Reward Types**:
* Points
* Free Product
* Free Delivery
* Fixed Amount
* Percentage Based Discount
[Learn more about how to set up each Reward type.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
**Badge**
Along with the reward, the customer will be rewarded a Badge for the campaigns they achieve. Customize badge settings to visually represent the campaign's achievement:
1. Choose a **Badge Icon** for this campaign. You have three options:
* **Gameball Library** — Pick from a curated set of pre-made icons.
* **Upload** — Upload your own custom image.
* **AI Image Studio** — Type a text prompt to generate a custom image directly in the dashboard.
2. Configure **Badge Visibility**:
* By **default, no badge** will be chosen (Campaign not visible on the widget).
* You can choose for it to be:
* Dimmed and becomes bright upon earning
* Only **show badge when earned**
3. Configure **Badge Unlocking Process:**
By default, the badge will be unlocked to all tiers; it will appear dimmed until earned. However, you can choose for the badge to start appearing to customers when they are on a certain tier:
Configure in-app and email notifications to keep customers informed about their progress and achievements.
Decide whether you'd like to inform your customers upon achieving a reward campaign milestone.
Available for event-based and high-score reward campaigns only. Select whether to notify customers after every completed action that brings them closer to achieving the reward campaign.
For both Notification types, you have the option to choose from the following:
* **Follow Global Settings:** Notifications will adhere to the predefined notification settings you configured in the notifications section. [Learn more about sending real-time notifications for reward campaign programs.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
* **Always Enabled**: Customers will receive a notification after completing an event or reward campaign.
* **In-app Notification:** Add Notification **Title** and Notification **Body**.
* **Email:** Add Email Subject and use the Email Builder to Customize the Email.
* **Always Disabled:** Customers will not receive any notifications after completing an event or reward campaign.
Define the campaign's goal to monitor its performance and effectiveness:
* Toggle the goal setting on or off based on your preference.
* Set event-based goals using the event engine to track customer actions and outcomes.
Now that you have created and configured your campaign, remember to press **Save**, **Preview**, and then **Activate** your campaign.
There are other types of Reward Campaigns. Learn how to create and configure each of them below:
* [Create & Configure an Action-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign)
* [Create & Configure a Points Multiplier Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-point-multiplier-reward-campaign)
* [Create a Time-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-time-based-reward-campaign)
***
## Related Articles
Explore the full setup guide for reward campaigns, including events, rewards, and notifications.
# How Do I Create a Time-based Reward Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/start-from-scratch/create-time-based-reward-campaign
Learn how to create and configure a Time-Based reward campaign from scratch.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| ---------- | --------- |
| Growth | Yes |
| Enterprise | Yes |
Reward campaigns are powerful tools for driving customer engagement and loyalty. With Gameball, you can easily create and configure reward campaigns tailored to your business objectives, and reward your customers on certain **occasions**, **dates**, or even **instantly**.
***
## Creating a New Time-Based Reward Campaign
Log in to your **Gameball Dashboard**. Navigate to the **Campaigns** section on the left side menu and click on **Rewards**.
Choose **Time-Based Reward** under the **'Start from Scratch'** section.
Give your new campaign an **internal name** for your team, and then start the configuration.
***
## Configuration of a Time-Based Reward Campaign
Define the rules that determine when customers receive the campaign's rewards.
Choose who is eligible to view and participate in this campaign:
* All Customers
* Specific Customers:
* Segments
* Tags
* Customer Attributes
* Combination of Segments, Tags, or Customer Attributes
After choosing the campaign's audience, you will be able to view the number of customers that are currently eligible to participate in this campaign.
Choose when you want your audience to receive the reward:
* **Instant**: the audience will receive the reward once the campaign is activated.
* **Based on Date/Time:** the audience will receive the reward on the date and the time you choose.
Set up the information that will be displayed to the customers on Gameball's widget on your website/mobile app:
* Reward Name
* Reward Information
* \[Optional] Redirection Link (Navigates the customers to a desired page on the website/mobile app).
**Reward**
Choose the type of reward that you will offer the audience once they achieve this campaign, and define the reward parameters to ensure it aligns with your campaign goals.
Choose one of the following **Reward Types**:
* Points
* Free Product
* Free Delivery
* Fixed Amount
* Percentage Based Discount
[Learn more about how to set up each Reward type.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
**Badge**
Along with the reward, the customer will be rewarded a Badge for the campaigns they achieve. Customize badge settings to visually represent the campaign's achievement:
1. Choose a **Badge Icon** for this campaign. You have three options:
* **Gameball Library** — Pick from a curated set of pre-made icons.
* **Upload** — Upload your own custom image.
* **AI Image Studio** — Type a text prompt to generate a custom image directly in the dashboard.
2. Configure **Badge Visibility**:
* By **default, no badge** will be chosen (Campaign not visible on the widget).
* You can choose for it to be:
* Dimmed and becomes bright upon earning
* Only **show badge when earned**
3. Configure **Badge Unlocking Process:**
By default, the badge will be unlocked to all tiers; it will appear dimmed until earned. However, you can choose for the badge to start appearing to customers when they are on a certain tier:
Configure in-app and email notifications to keep customers informed about their progress and achievements.
Decide whether you'd like to inform your customers upon achieving a reward campaign milestone.
Available for event-based and high-score reward campaigns only. Select whether to notify customers after every completed action that brings them closer to achieving the reward campaign.
For both Notification types, you have the option to choose from the following:
* **Follow Global Settings:** Notifications will adhere to the predefined notification settings you configured in the notifications section. [Learn more about sending real-time notifications for reward campaign programs.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
* **Always Enabled**: Customers will receive a notification after completing an event or reward campaign.
* **In-app Notification:** Add Notification **Title** and Notification **Body**.
* **Email:** Add Email Subject and use the Email Builder to Customize the Email.
* **Always Disabled:** Customers will not receive any notifications after completing an event or reward campaign.
Define the campaign's goal to monitor its performance and effectiveness:
* Toggle the goal setting on or off based on your preference.
* Set event-based goals using the event engine to track customer actions and outcomes.
Now that you have created and configured your campaign, remember to press **Save**, **Preview**, and then **Activate** your campaign.
There are other types of Reward Campaigns. Learn how to create and configure each of them below:
* [Create & Configure an Action-based Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign)
* [Create a Recurring Customer Date Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-recurring-customer-date-reward-campaign)
* [Create & Configure a Points Multiplier Reward Campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-point-multiplier-reward-campaign)
***
## Related Articles
Explore the full setup guide for reward campaigns, including events, rewards, and notifications.
# How Do I Create an Account?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/acquisition-conversion/create-an-account
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers for creating an account is one of the simplest and most effective ways to encourage sign-ups and kick off user engagement. This campaign is ideal for driving account registrations, reducing bounce rates, and starting the customer journey on a high note.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Create account** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
The customer creates an account on your platform.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer visits your platform.
When they **successfully create an account**, Gameball automatically **triggers the reward**.
The customer receives the reward immediately (points, discount, badge -- based on your setup).
The customer will be **notified** via the widget or email with the reward as per your configuration.
***
## Important Notes
**New Customers Only**
Only customers who sign up *after* the campaign is active will be rewarded.
**Old Customers**
You can manually reward customers who signed up before by going to the **Customers tab -> Reward a Campaign -> Account Created**.
**Bulk Migration**
Importing customers while the campaign is active won't trigger rewards.
**\[Shopify] New Account Creation Method**
Customers registering this way are marked as **"Member"** and will receive the reward.
**\[Shopify] Guest Checkout**
Customers who check out as guests (Legacy method on Shopify) are labeled **"Guests"** and will **not** earn the reward, even if guest rewards are enabled.
**\[Shopify] Guest to Member**
If a guest later registers with the same email, their status will be converted to **"Member,"** and they will receive the signup reward.
# How Do I Subscribe to Newsletter (Shopify Flow)?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/acquisition-conversion/subscribe-to-newsletter
| Platform | Plan |
| ------------ | ------------- |
| Shopify | All Plans |
| Salla | Not Available |
| Non-Platform | Not Available |
Shopify Flow is a powerful automation tool that lets you seamlessly connect Gameball Loyalty with other Shopify apps. Use it to build custom workflows and enhance your loyalty program in multiple ways.
Use Shopify Flow templates to reward customers on Gameball based on actions from other apps -- for example, subscribe to newsletter on Shopify.
A Shopify Flow workflow consists of three main parts: **Triggers**, **Conditions**, and **Actions**. [Learn more in the full guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## How to Set Up
**On Gameball**
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Subscribe to newsletter** template tagged with Shopify Flow.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
After creating your campaign, **copy the Campaign ID**.
***
## Campaign Trigger
**On Shopify Flow**
From your Shopify admin, go to **Apps** > **Shopify Flow** and click **Create Workflow**.
Choose the trigger "**Customer Subscribed to Email Marketing**" from Shopify Triggers (or use any other trigger from your marketing app).
**Add the customer email** if the trigger doesn't pass the customer identifier automatically. See the important notes below for more details.
Add the **"Reward a Campaign"** action and paste the **Campaign ID** you copied from the campaign details page.
**Save the workflow** to activate it.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customer subscribes to Shopify email marketing (e.g., via Checkout or a Popup).
Shopify Flow triggers the workflow when they subscribe.
Gameball rewards the customer with the reward set in the "Subscribe to newsletter" campaign.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Important Notes
**Skip Email Field**
When setting up Gameball as an action in Shopify Flow, you may not need to fill in the email field if the trigger app already passes the customer identifier automatically. In this case, the identifier will appear just above the email field.
***
## Related Articles
Learn how to build Shopify Flow workflows with Gameball.
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# What Is Unlock 15% Off Your First Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/acquisition-conversion/unlock-15-percent-off-first-order
Launch campaigns that will help you collect emails and/or approve newsletter subscriptions.
| Platform | Plan |
| -------------------- | ------------------------------------------------ |
| Shopify & Self Serve | All New Plans (Not available on any legacy plan) |
Collecting emails from visitors who haven't signed up yet is essential as it opens more channels of communication between you and potential customers and it helps you take initiative that might convert visitors into customers.
Nevertheless, if you send newsletters, you might want to get approval from your customers as well as your visitors to receive these emails. There is no better way to collect emails and/or get newsletter approvals than the **Pop-up Campaigns** Gameball has created for you.
* This feature is intended for **Web-based businesses only**. It should not be enabled for non-web platforms (e.g., mobile apps).
* Make the necessary adjustments to the Activation, Details, Rewards, and Goal sections. [Learn more about setting up a Reward Campaign.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
Here are the pop-up campaigns ready-to-use templates currently available.
***
## Subscribe to Newsletter (for Shopify Users)
Encourage customers to give you their emails as approval for their subscription to your newsletter. Once the customer writes down their emails, they will automatically be marked as subscribed on Shopify. You can customize a reward that is convenient for this approval. For example, you can reward them with 10% off for doing so.
### How to Set Up
Select the audience for the campaign from the following options:
* All customers (This includes Anonymous and Registered visitors)
* Anonymous customers only
* Registered customers only
* Specific customer segments
Set a delay to your **Trigger** if needed. Select when the pop-up should appear:
* Immediately (Default)
* After a delay: you can specify the number of seconds for the delay (e.g., 5 seconds).
* **Display frequency:** The pop-up will be shown **once per session.** This means that the customer will not be seeing this more than once unless they completely close their browser and open it in a new session.
* If a customer is eligible for more than one newsletter subscription campaign, they will only be rewarded the first time they give their email address.
Create the content, look and feel of the pop-up so that it is clear and helpful. Choose **Customize Design**.
Customize both the **Main pop-up** and the **Success pop-up**.
Choose **Insights** to see how the campaign is doing in terms of performance.
***
## Unlock x% of Your First Order
Similarly, incentivize customers especially visitors who have not signed up yet to give their emails by rewarding them with a discount when doing so.
* This feature is intended for **Web-based businesses only**. It should not be enabled for non-web platforms (e.g., mobile apps).
* Make the necessary adjustments to the Activation, Details, Rewards, and Goal sections. [Learn more about setting up a Reward Campaign.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
### How to Set Up
Select the audience for the campaign from the following options:
* All customers (This includes Anonymous and Registered visitors)
* Anonymous customers only
* Registered customers only
* Specific customer segments
Set a delay to your **Trigger** if needed. Select when the pop-up should appear:
* Immediately (Default)
* After a delay: you can specify the number of seconds for the delay (e.g., 5 seconds).
* **Display frequency:** The pop-up will be shown **once per session.** This means that the customer will not see this more than once unless they completely close their browser and open it in a new session.
* If a customer is eligible for more than one newsletter subscription campaign, they will only be rewarded the first time they give their email address.
Choose Your **Audience** and edit your **trigger** by adding the **Collection ID** to the **Place Order** event that is already set up.
Make the necessary adjustments to the Activation, Details, Rewards, and Goal sections. [Learn more about setting up a Reward Campaign.](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
Create the content, look, and feel of the pop-up so that it is clear and helpful. Choose **Customize Design**.
Customize both the **Main pop-up** and the **Success pop-up**.
Choose **Insights** to see how the campaign is doing in terms of performance.
The analytics section provides an overview of the campaign's performance such as:
* **Distinct customers Count:** Unique players achieved this campaign.
* **Total Impressions:** Total Number of pop-up views.
* **Total Subscriptions**
* **Total Rewarded Coupons**
* **Total Rewarded Points**
* **Conversion Rate:** The percentage of users who achieved the campaign (*Calculated as: Total Subscription / Total Pop-up Views.*)
* **Dismissal Rate:** The percentage of users who dismissed the pop-up (*Calculated as: Total Dismissals / Total Pop-up Views.*)
* **Impressions vs Subscriptions overtime Report**
***
## Related Articles
Browse acquisition and conversion campaign templates.
Explore purchase and order incentive campaign templates.
Discover personalization and gamification campaign templates.
Find engagement-focused campaign templates.
Set up campaigns for special occasions and seasonal events.
# How Do I Set Up Calendar Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/calendar-campaign
Learn how to schedule interconnected or independent campaigns using calendar campaigns.
## Plan Availability
| Plan | Available |
| ------------- | --------- |
| Contact Sales | Yes |
Gameball Reward Campaigns often work as a powerful tool to engage customers in various ways. But each reward campaign is deployed on its own. In a special season, we know you sometimes want to deploy multiple reward campaigns as part of one theme. This is why Gameball has created the new Calendar Campaign.
The **Calendar Campaign** empowers you to create and manage multiple interconnected or independent campaigns, offering complete control over scheduling. Each campaign consists of **entities** (sub-campaigns), which can be customized based on your needs.
Customers will also find themselves ranking on a **leaderboard** that compares their performance and interaction with other customers who are also interacting with the campaign.
The Calendar Campaign leaderboard is **campaign-specific** — it ranks customers based on their performance within this campaign only, and is available as part of the Calendar Campaign feature. This is separate from the **program-wide leaderboard** in Widget General Settings, which ranks customers across your entire loyalty program and requires a specific plan or add-on.
***
## How Calendar Campaigns Work
You can define the number of entities within a campaign, making it flexible for various durations and events. For example:
Use 30 entities for a month-long challenge, deploying a new game or action every day.
Use 7 entities for a week-long event such as Black Friday week.
Use 3 entities for a short festival such as Eid or a holiday weekend.
***
## Creating a Calendar Campaign
From the left bar, choose **Reward** under **Campaigns**. Click **Create New Reward Campaign**.
Scroll down to choose the **Calendar Campaign** under **Engagement & Gamification**.
Select who will participate in the campaign.
Configure the activation window for the overall campaign.
Add individual sub-campaigns (entities) to the calendar.
Each entity within the campaign can feature one of the following engaging games:
Let customers spin to win prizes from a randomized wheel of rewards.
Reward customers when all three slots align in this luck-based game.
Challenge customers with trivia questions to earn rewards.
Give customers a digital scratch card to reveal their prize.
Each entity can have its own unlock and lock dates through **Custom Scheduling**, allowing campaigns to run sequentially or independently, depending on your strategy.
When you are done with creating the first Entity (sub-campaign), click **Save** and choose if you want to add more campaigns.
***
## How Calendar Campaign Looks on the Widget
After adding multiple entities to your calendar campaign, the customers will be able to see all scheduled sub-campaigns ahead of their unlock time to motivate them to come back and proceed with their wins.
***
## Customize Calendar Campaign and Leaderboard
To design the calendar campaign as well as the leaderboard, click on **Customize Design**.
Select background colors, the campaign's main image, and write down the content.
Type down the main content of this interface, such as the game titles, prize description, etc.
***
## Personalize the Widget Banner
You can fully personalize how the calendar campaign banner appears in the customer widget — including the title, image, description, and CTA button text. Navigate to **Widget > Content > Games** in your dashboard.
| Field | Description |
| -------------------------- | --------------------------------------------------- |
| **Calendar Banner Title** | The headline displayed on the banner |
| **Calendar Banner Button** | The CTA text customers click to enter the campaign |
| **Background** | Choose an image from the library or upload your own |
| **Icon** | Use the default icon or upload a custom image |
When multiple calendar campaigns run simultaneously, a selector appears in the dashboard so you can configure the banner for each campaign independently.
***
## Use Cases
Engage your audience with a daily trivia game for 30 days. Participants answer a new question every day, keeping them excited and consistently interacting with the campaign.
Keep customers engaged with a new game each day. The campaign offers a mix of exciting experiences, such as **Spin the Wheel**, **Slot Machine**, **Trivia Quiz**, and **Scratch and Win**. This variety ensures daily excitement and sustained customer participation throughout the campaign.
Introduce a new game each week to sustain customer interest and interaction. Weekly games can vary in style and mechanics, offering fresh experiences to participants.
Collaborate with brands to sponsor specific games. These games will feature full branding integration, including logos, icons, rewards, and custom visuals. For example, an Adidas-sponsored game could include Adidas-themed graphics, exclusive rewards, and tailored branding throughout the experience.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up Driving Game?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/driving-game
Test your customers' reaction to speed and let them win a reward with an engaging game such as the driving game.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
An interactive gamification tool that boosts engagement and brand awareness. Customers play Driving Game to win and unlock rewards, driving interaction, visibility, and new revenue opportunities.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Driving Game** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Customers can access the game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
**Audience**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:** You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
**Repeatability**
* By default, customers can play **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
* All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customers start by moving between lanes, trying to collect the coins and avoid the cards.
The game ends when the time has ended, or you finish all your lives.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
## Customization
**Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner**
* **Intro / Main Screen**
* **Game General Rule:**
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Mistakes/Lives**: Choose how many lives a customer has (e.g., 1, 3, or unlimited).
* **Goal Score**: Fixed at **300 points** — this cannot be changed. Customers must reach this score to win.
* **Dashboard Controls**: Easily configure these settings in the game setup screen.
* **Default Values**: Existing defaults remain if no customization is made.
* **Tooltips**: Added help text explaining how time and lives impact gameplay.
* **Lead Form (if audience set to Anonymous Customers - Not logged in)**
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Fill a Survey (Shopify Flow)?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/fill-a-survey
| Platform | Plan |
| ------------ | ------------- |
| Shopify | All Plans |
| Salla | Not Available |
| Non-Platform | Not Available |
Shopify Flow is a powerful automation tool that lets you seamlessly connect Gameball Loyalty with other Shopify apps. Use it to build custom workflows and enhance your loyalty program in multiple ways.
Use Shopify Flow templates to reward customers on Gameball based on actions from other apps -- for example, filling a survey on Okendo.
A Shopify Flow workflow consists of three main parts: **Triggers**, **Conditions**, and **Actions**. [Learn more in the full guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## How to Set Up
**On Gameball**
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Fill a Survey** template tagged with Shopify Flow.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
After creating your campaign, **copy the Campaign ID**.
***
## Campaign Trigger
**On Shopify Flow**
From your Shopify admin, go to **Apps** > **Shopify Flow** and click **Create Workflow**.
Choose **"Okendo Survey Response Created"** as the trigger (or another relevant app trigger).
**Add the customer email** if the trigger doesn't pass the customer identifier automatically. See the important notes below for more details.
Add the **"Reward a Campaign"** action and paste the **Campaign ID** you copied from the campaign details page.
**Save the workflow** to activate it.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customer fills a survey (e.g., via Okendo).
Shopify Flow triggers the workflow based on the survey response.
Gameball rewards the customer with the reward set in the "Fill a Survey" campaign.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Important Notes
**Skip Email Field**
When setting up Gameball as an action in Shopify Flow, you may not need to fill in the email field if the trigger app already passes the customer identifier automatically. In this case, the identifier will appear just above the email field.
***
## Related Articles
Learn how to build Shopify Flow workflows with Gameball.
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Match Cards?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/match-cards
Test your customers' memory and let them win a reward with an engaging game such as match cards.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
An interactive gamification tool that boosts engagement and brand awareness. Customers match item pairs to unlock rewards, driving interaction, visibility, and new revenue opportunities.
**Use Cases:**
1. **Brand Sponsorships:** Let brands sponsor in-game challenges for added revenue and engagement.
2. **Promote New Products:** Feature new products in the game to boost visibility and interest.
3. **Boost Activity:** Encourage daily or weekly logins with regular gameplay and rewards to drive retention.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Match Cards** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Customers can access the match card through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
Use the `#gameball-match` deep link to trigger the match cards campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Audience**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:** You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
**Repeatability**
* By default, customers can play **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
* All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
## Game Rules
**Game Cards**
Go to **Customize Design -> Game** to set up the rules.
1. The game includes **6 pairs of images** by default.
2. Customers must match all pairs **before the timer runs out**.
**Time**
Specify the duration (in seconds) during which the customer is allowed to play the game.
**Flips**
* To add difficulty, you can **limit the number of flips**. If flips run out before all matches are made, the user **loses** the game.
* The min number of flips accepted is 12 flips.
***
## How It Works for Customers
Customers tap cards to reveal hidden images.
Matching pairs leads to a win.
The game ends when all pairs are matched or time runs out.
The customer is notified via the widget or email, depending on your configuration when they earned a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
## Customization
**Design & Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner (For game-based campaigns)**
* **Intro / Main Screen**
* **Success Screen**
* **No Luck Screen**
* **Game General Rules Customizations:**
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Number of Flips**: Choose how many lives a customer has (e.g., 20, 25, or unlimited).
* **Dashboard Controls**: Easily configure these settings in the game setup screen.
* **Default Values**: Existing defaults remain if no customization is made.
* **Tooltips**: Added help text explaining how time and lives impact gameplay.
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Milestone?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/milestone
Reward customers when they hit spending or item-count thresholds within a timeframe.
| Platform | Plan |
| ------------ | ------ |
| Shopify | Add-on |
| Salla | Add-on |
| Non-Platform | Add-on |
The **Milestone Campaign** is a rule-based campaign that accumulates a customer's eligible spend or item count across orders during a defined period (e.g., **SAR 500 per month**). Help increase **AOV** and **repeat purchase frequency**.
**Use Cases:**
1. **Spending Milestones**
Reward based on total spend within a period.
*Example:* "Spend **$1000** and get a **$100** gift card."
2. **Collection/Tag/SKU/Branch-Specific Milestones**
Only spending on a chosen collection/category/SKU counts.
*Example:* "Spend **$500** on **Electronics** and get **$50** off your next order."
3. **Items-Purchased Milestones (count)**
Reward by quantity of items, regardless of price.
*Example:* "Buy **10** items and get **20%** off next order."
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Milestone** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Select the **attribute to track** (e.g., *Total price*).
Choose the **progress method**: **Cumulative** (adds up across orders).
Set the **milestone threshold** that triggers the reward (e.g., **\$1,000**).
Add **filters/conditions** -- e.g., item **quantity**, specific **collection/category/SKU**, branch, etc.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer begins the milestone by placing an order that **meets the configured conditions**.
Each **eligible order** counts **toward** the customer's progress.
Once the milestone is **completed**, the configured reward is issued **immediately** (e.g., points, discount, badge).
If the milestone is **repeatable**, completion starts a **new round**: the next eligible order resets progress, and the widget displays the **new progress** toward the next milestone.
## Customization
**Design & Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Main Screen**
* **Success Screen**
* **Terms & conditions**
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Mission?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/mission
Encourage users to explore features, complete onboarding, or reach milestones by guiding them through a collection of tasks.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
The **Mission Campaign** lets you define up to **10 different actions/tasks**. Once a customer completes *all* tasks -- regardless of order -- they earn a reward and unlock a badge. It's perfect for onboarding flows, multi-step journeys, and targeted engagement.
**Use Cases:**
1. **User Onboarding**
Complete "Create Account," "Verify Email," and "Place First Order".
2. **Complete Your Profile**
"Upload profile picture", "Add address" and "Add payment method".
3. **Repeat Purchase Encouragement**
"Place Second Order", "Purchase with min-value \$100", and "Leave a Review".
4. **Milestone Engagement**
"Make a \$100 purchase," "Add 3 items to cart," and "Refer a friend."
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Mission** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
**Tasks**
Add up to **10 tasks**.
You can define **an event** for each task, such as placing an order, visiting a product page, and so on.
You can **add rules** for each event -- for example:
* Specific order value
* Specific product/category requirement
Configure each task content and Icon.
**Rewards**
Each task includes an optional **"Task Reward"** configuration.
* Task rewards can be configured independently per task.
* If no task reward is set, it only contributes to overall mission progress and no immediate reward is granted until the end of the mission.
**Repeatability**
* No repeatability option.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
The customer can start the mission by completing any of the required tasks (e.g., creating an account, placing an order).
They complete the remaining tasks in **any order** until all are finished.
They receive notifications after each task if event notification is enabled.
After completing all tasks, the customer receives the reward immediately (points, discount, badge -- based on your setup).
Missions are non-repeatable by default, so the reward can only be earned once per customer.
## Customization
**Design & Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Main Screen**
* **Success Screen**
* **Terms & conditions**
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
## Editing a Live Mission
Editing a live mission should be done with care to ensure a smooth experience for your customers. Below, we break down each scenario and its impact.
### Editing a Task
**Editing task Content:**
* If a customer changes (title, image, description), it is instantly updated for **all users**, regardless of progress.
**Editing Event:**
* If the user has already completed the task, their task remains marked as completed.
* If the task is not yet completed, the updated event/condition will take effect. Any progress already made will be preserved, and the user must fulfill the **remaining requirement** based on the new condition.
**Example:**
Task: *Spend \$1000 on Collection A*
* A user spends \$500 before the customer updates the task to *Collection B*.
* The $500 spent is preserved, and the user must now spend the **remaining $500 on Collection B\*\* to complete the task.
### Deleting a Task
If a task is deleted, it will be removed for **all customers**, **regardless of their progress** -- whether completed or not.
**Impact on Customers In Progress:**
* If a task is deleted while some users are still in progress, the task will be removed from their task list. Their overall progress will be recalculated. If this were their **only pending task**, the campaign would be **marked as complete,** and the **final reward would be granted**.
**Impact on Analytics & Customer Activity:**
* Deleted tasks will continue to appear in both the analytics and customer task lists, but without a specific task number. They will be clearly labeled as "Deleted".
### Adding a New Task
* If the mission is **already completed**, the newly added task will **not appear** for the customer, and the mission will remain marked as **earned**.
* If the mission is **still in progress**, the new task will be **visible**, and the customer must **complete it** along with the others to earn the reward.
### De-activate
* Customer progress is **saved**.
* Any actions performed while the campaign is inactive **will not** be counted toward the campaign.
### Re-activate
Customers resume from the **last saved state**. Progress continues as normal.
### Task Overlap Handling
**A single customer action can fulfill multiple tasks at once.**
* For example, if a player makes a **\$200 purchase with 5 items**, it can **simultaneously complete two tasks**:
* *Task A: Spend \$200*
* *Task B: Buy 5 items*
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Predict & Win?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/predict-and-win
Run a score-prediction game around live events — customers forecast match results, earn points by accuracy, and compete on a live leaderboard.
| Platform | Plan |
| ------------ | ------------------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Enterprise (add-on) |
Turn a major sporting event into a month of daily engagement. Predict & Win lets customers forecast match scores before kickoff, earn points based on prediction accuracy, and climb a live leaderboard — giving you a daily reason to bring shoppers back throughout the event.
***
## Creating a Predict & Win Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Predict & Win** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **All Customers:** Every registered customer in your program.
* **Specific Customers:** Filter by segment, tag, or customer attributes to limit who can participate.
The trigger for this campaign is **Customer Predict match and collect score** — customers earn the reward each time they submit a prediction for an open match.
A dedicated **Predict & Win** banner appears in the loyalty widget. You can also share a deep link directly to the game for use in emails, banners, or push notifications.
* **Always Active:** The campaign runs continuously while live.
* **Scheduled:** Set a start and end date to align the campaign with the event window.
Choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## Matches Selection
Choose which matches customers can predict on.
| Option | Description |
| -------------- | ------------------------------------------------ |
| **All** | Every match in the event is open for predictions |
| **By Country** | Only matches involving a specific national team |
| **By Match** | Hand-pick individual matches to open |
Only matches you enable are visible to customers in the widget.
***
## Scoring Model
Configure how many points customers earn per prediction. The model is fully customizable, with World Cup default rules pre-filled:
| Prediction Type | Description |
| ------------------- | -------------------------------------------- |
| **Exact score** | Predicted the exact final score |
| **Goal difference** | Correct goal margin but wrong exact score |
| **Correct winner** | Right winning side but wrong margin |
| **Participation** | Submitted a prediction regardless of outcome |
You can also enable a **knockout timing bonus** that awards extra points for predictions submitted close to kickoff during knockout-stage matches.
### Knockout Stage Predictions
Predict & Win runs through the final. Knockout matches can't end in a draw, so the match card adapts to what the customer predicts:
* **Level score predicted:** The customer is asked who wins the penalty shootout.
* **Decisive score predicted:** The customer gets a 90 minutes / extra time toggle.
A **Correct Decider** bonus (default +2 points, fully configurable) rewards customers who correctly call both the advancing side and the manner of victory. Base scoring tiers are unchanged, and no new setup is required to use knockout matches.
***
## Rewards & Leaderboard
Predict & Win supports two independent reward tracks:
* **Per-match rewards** — awarded based on prediction accuracy after each match result is confirmed
* **Rank-based leaderboard rewards** — awarded to the top-ranked customers at the end of the campaign (up to 10 positions)
Rewards can be delivered via Gameball, an external API, or self-fulfilment.
***
## Advanced Options
**Show Leaderboard** — When on, players can see the live leaderboard ranking for this campaign inside the widget. Turn it off to run the game without a visible ranking.
**Notifications** — Configure how customers are notified when they earn a reward:
* **In-App Notifications:** Achieve Notifications and Event Notifications both follow Global Settings by default.
* **Email Notifications:** Achieve Notifications follow Global Settings by default.
[Learn more about notifications](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## End User Experience
Customers tap the Predict & Win banner in the loyalty widget or follow a shared deep link.
On the **Matches** tab, customers enter their predicted score for each open match before kickoff.
After matches are played, customers check their accuracy on the **History** tab and see their overall standing on the **Board** tab.
Points are awarded based on prediction accuracy. Top-ranked customers earn leaderboard rewards at the end of the campaign.
***
## Insights & Export
The Predict & Win insights panel labels its participation metric **Total Predictions** — the count of both scored and unscored predictions submitted. The distinct customer count matches the number of players shown on the widget, counting anyone who made a prediction, scored or not.
The Insights leaderboard lets you export participant lists filtered by result category or rank. Use the export to:
* Reward top-ranked customers manually
* Segment football-fan customers for follow-up campaigns
* Tag participants for future targeting
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and will not reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Quiz?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/quiz
Engage and entertain your customers with this gamified reward campaign and let them win for solving your quiz.
| Platform | Plan |
| ------------ | -------------------- |
| Shopify | Starter, Pro, & Guru |
| Salla | Starter, Pro, & Guru |
| Non-Platform | Add-on |
Add an educational and interactive twist to your loyalty program with the **Quiz** campaign. Let your customers answer questions to earn rewards based on their knowledge and engagement.
**Use Cases:**
1. **Brand-Sponsored Quizzes:** Partner with brands to feature their products in quiz questions and offer branded rewards.
2. **Seasonal Campaigns:** Run themed quizzes for holidays or events like Valentine's Day or Black Friday with exclusive offers.
3. **Educational Quizzes:** Teach users about your products or industry and reward them for learning.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Quiz** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Customers can access the quiz through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin.
Use the `#gameball-quiz` deep link to trigger the quiz campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Audience**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:** You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
**Repeatability**
* No Repeatability.
* The quiz can only be played once per customer.
**Platform Visibility**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
## Quiz Setup
**Questions**
* Minimum: **1 question**
* Each question must include:
* The question text
* An **optional image**
* At least **1 answer** should be added
* One **correct answer** must be selected
**Timer**
* Question Timer (**Optional**)
* At the end of configuring your questions, you can enable a timer that applies to each question individually (e.g., 10 or 20 seconds per question).
* This helps increase challenge and customer engagement.
***
## How It Works for Customers
Customers are presented with a set of questions.
Customers will earn the reward only if they answer all questions correctly.
Getting 0 answers right is always considered failure, and the customer will receive the "No Luck" widget screen. Customer must answer **All** questions right for them to win.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
The quiz reward is all-or-nothing. Customers must answer **all** questions correctly to earn the reward — there is no partial reward for getting some questions right, and no consolation reward for incorrect answers. Conditional payouts (e.g., different rewards based on correctness) are not supported.
## Customization
**Design & Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner**
* **Intro / Main Screen**
* **Questions Screen**
**Game General Rule:**
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Mistakes/Lives**: Choose how many lives a customer has (e.g., 1, 3, or unlimited).
* **Default Values**: Existing defaults remain if no customization is made.
* **Tooltips**: Added help text explaining how time and lives impact gameplay.
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks. Text color customization is available across all banner options — From Library, Upload Image, and Use AI.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
***
## Customer Report
Aggregated results for every quiz question are also available on the **Insights** page — see [Survey & Quiz Response Analytics](/product-documentation/rewards-campaigns/reward-campaigns-insights#survey-quiz-response-analytics).
You can extract a customer list report directly from the quiz campaign page. The report includes one row per participating customer with the following columns:
| Column | Description |
| --------------- | ------------------------------------------------------------------------ |
| Customer Id | The unique identifier of the customer in Gameball. |
| Customer Name | The customer's full name. |
| Customer Email | The email address associated with the customer's account. |
| Reward | The reward the customer earned upon completing the quiz. |
| Points Value | The points value of the earned reward. |
| Achieved At | The date and time the customer completed the quiz and earned the reward. |
| Correct Answers | The number of questions the customer answered correctly. |
| Success State | Whether the customer won or did not win the quiz. |
To segment customers by quiz outcome, use the [Get Customer Campaigns Progress API](/api-reference/customers/progress/get-customer-campaigns-progress) and check the `achievedCount` field. Customers with `achievedCount > 0` answered correctly and won. You can then tag those customers using the Gameball tagging API to create segments based on quiz performance.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Scratch & Win?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/scratch-and-win
Give your customers an opportunity to scratch a digital loyalty card and win a reward.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
Introduce an element of chance with the Scratch & Win template. Customers can try their luck to win a reward, allowing them to get various prizes, from discounts to free products or bonus points. You can also organize weekly contests or lucky scratches to encourage customers to return to your platform regularly.
**Use Cases:**
* **Limited-Time Promotions:** Use scratch cards for seasonal sales, holiday campaigns, or product launches to create excitement and urgency.
* **Product Awareness & Upselling:** Feature new or high-margin products as potential rewards to introduce users to items they might not have considered.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Scratch & Win** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Customers can access the scratch card through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin scratching.
Use the `#gameball-scratch` deep link to trigger the scratch the card campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Audience**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:** You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
**Repeatability**
* By default, customers can scratch the card **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
* All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
## Rewards Setup
**Types**
* Choose from any of the reward types supported by Gameball. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
* Min & Max Rewards Count:
* The **minimum** number of rewards allowed is **2**
* The **maximum** number of rewards allowed is **8**
**Probability**
Enter a numerical value (e.g., 2, 3, 4) to represent the probability of a customer receiving this reward. This means that every trial is completely independent of the previous ones, and the chance of landing on a specific reward is always the same, no matter how many times you've scratched the card.
* The probability input can accept a value of 0, meaning the reward will not be available.
* Probabilities are calculated based on the sum of all assigned probabilities across the rewards.
While each reward has a set probability, it doesn't guarantee that all rewards will be won equally over time. Some rewards might appear more often, while others might be less frequent. It's all part of the random nature of the game!
* **Example**:
* Reward #1: Probability 1
* Reward #2: Probability 1
* Reward #3: Probability 1
After 100 scratches, you might see results like this:
* Reward #1: 27 times
* Reward #2: 36 times
* Reward #3: 37 times
In another set of 100 scratches:
* Reward #1: 28 times
* Reward #2: 49 times
* Reward #3: 23 times
**Reward Limits**
The maximum number of times a specific reward can be claimed by all customers throughout the campaign.
* **Optional Feature:** You can choose to add a reward limit when configuring the campaign.
* **Tracking Wins:** Gameball will track how many times each reward has been won. After the limit is reached, the reward will no longer be winnable.
* **Reward Limit Adjustment:** If you adjust the reward limit while the campaign is running:
* **Increase the Limit:** If the new limit is higher, customers can win the reward again.
* **Decrease the Limit:** If the new limit is lower, the system will prevent the reward from being won if the initial limit was already reached.
* **Example:**
Reward 1: Probability 1, Limit: 1
Reward 2: Probability 1, No Limit
Reward 3: Probability 1, No Limit
After 10 scratches, the results might look like this:
* Reward 1: 1 win (limit reached)
* Reward 2: 5 wins
* Reward 3: 4 wins
If all rewards have limits and they are reached, customers will see a "No rewards available at the moment" message.
***
## How It Works for Customers
Customers tap the card and **scratch** to reveal their reward.
Prizes can include discounts, bonus points, free products, and more.
The customer is notified via the widget or email, depending on your configuration when they earned a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
## Customization
**Design & Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner (For game-based campaigns)**
* **Intro / Main Screen**
* **Lead Form (if audience set to Anonymous Customers - Not logged in)**
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
Customizing the lead form also allows you to add a hyperlink to the **"terms and services"** so that customers can read and accept them before clicking submit.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Sliding Puzzle?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/sliding-puzzle
Test your customers' intelligence and let them win a reward with an engaging game such as sliding puzzle.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
An interactive gamification tool that boosts engagement and brand awareness. Customers play Sliding Puzzle to win and unlock rewards, driving interaction, visibility, and new revenue opportunities.
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Sliding Puzzle** template.
Edit the campaign's setup to match your goals.
Click **Set Live** to activate the campaign.
***
## Campaign Trigger
Customers can access the game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
**Audience**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:** You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
**Repeatability**
* By default, customers can play **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
* All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customers must organize the puzzle from 1 to 15 to form the final picture.
They can only slide one piece of the puzzle in one direction.
The game ends when the puzzle is formed or when time ends.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
## Customization
**Content**
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner**
* **Intro / Main Screen**
* **Game General Rule:**
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Lead Form (if audience set to Anonymous Customers - Not logged in)**
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
* **Branding**: Adjust background colors, text colors, timer, upload custom artworks, as well as the puzzle image.
This allows you to create a fully branded, on-theme experience that aligns with your business identity.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Explore the different reward types you can offer customers.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Slot Machine?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/slot-machine
Engage your customers with Gameball's slot machine and ask them to try their luck.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Starter | Yes |
| Pro & Guru | Yes |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
Add excitement to your customer experience with the Slot Machine campaign. This gamified feature lets customers try their luck -- if all three slots align, they win a prize! From discounts and free products to bonus points, the rewards keep them coming back.
***
## Creating a Slot Machine Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Slot Machine** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **Machine Banner on Widget:**
A banner will display on your widget's homepage. When customers click the banner, they'll be taken to the game screen where they can roll the machine.
* **Deep Link:**
Use the `#gameball-slot` deep link to trigger the slot machine campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
* **Registered Customers:**
Customers who have an account on your platform (signed up)
* **Anonymous Customers:**
Visitors browsing anonymously without providing any contact information or identifiable details (not signed up)
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:**
You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
By default, customers can roll the machine **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## Rewards Setup
Choose from any of the reward types supported by Gameball. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
| Setting | Value |
| ----------------------- | ----- |
| Minimum rewards allowed | 2 |
| Maximum rewards allowed | 8 |
Enter a numerical value (e.g., 2, 3, 4) to represent the probability of a customer receiving this reward. Every spin is completely independent of the previous ones, and the chance of landing on a specific reward is always the same, no matter how many times the machine has been rolled.
* The probability input can accept a value of 0, meaning the reward will not be available.
* Probabilities are calculated based on the sum of all assigned probabilities across the rewards.
While each reward has a set probability, it doesn't guarantee that all rewards will be won equally over time. Some rewards might appear more often, while others might be less frequent. It's all part of the random nature of the game!
**Example:**
* Reward #1: Probability 1
* Reward #2: Probability 1
* Reward #3: Probability 1
After 100 trials, you might see results like this:
* Reward #1: 27 times
* Reward #2: 36 times
* Reward #3: 37 times
The maximum number of times a specific reward can be claimed by all customers throughout the campaign.
* **Optional Feature:** You can choose to add a reward limit when configuring the campaign.
* **Tracking Wins:** Gameball will track how many times each reward has been won. After the limit is reached, the reward will still appear on the machine but will no longer be winnable.
* **Reward Limit Adjustment:**
* **Increase the Limit:** If the new limit is higher, customers can win the reward again.
* **Decrease the Limit:** If the new limit is lower, the system will prevent the reward from being won if the initial limit was already reached.
**Example:**
* Reward 1: Probability 1, Limit: 1
* Reward 2: Probability 1, No Limit
* Reward 3: Probability 1, No Limit
After 10 trials: Reward 1 hits 1 win (limit reached), Reward 2 hits 5 wins, Reward 3 hits 4 wins.
If all rewards have limits and they are reached, customers will see a "No rewards available at the moment" message.
***
## End User Experience
**How it works:**
Customers earn rewards through rolling the machine.
If all three windows match, they win a reward.
Prizes can include discounts, free items, bonus points, and more.
The customer is notified via the widget or email, depending on your configuration when they earned a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
Configure the banner that appears in the widget to promote the Slot Machine campaign.
Set up the main game screen with headlines, descriptions, and call-to-action messages.
Shown when audience is set to **Anonymous Customers (Not logged in)**. Collect visitor information before gameplay.
Customize the message and visuals shown when a customer wins.
Configure the message shown when a customer does not win.
For each screen, you can tailor:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Notes
### Fraud Prevention
In the "Slot Machine" campaigns for guests (**Audience is Anonymous/Not Logged-in**), the following protections apply:
| Protection | Description |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Single Play Per Session** | Guest users can try the game only once per session. If they attempt to re-enter, a message displays: "You have already spun the Machine." |
| **Multiple Machines in Campaign** | For campaigns with multiple machines, this restriction applies individually to each machine. Guests can still roll any other machine they haven't tried. |
| **Session Restriction** | If a guest opens a new browser tab or window after playing, the same restriction message will appear. |
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
### Anonymous Option
* If you choose **Anonymous** as the audience, the campaign will be available to visitors who are not yet identified on your store.
* Once enabled, a lead form will automatically appear prompting the customer to enter their information (e.g. name, email).
* This is a great way to collect leads and retarget potential customers later.
* You can fully customize this form by navigating to **Customize Design -> Lead Form**.
Customizing the lead form also allows you to add a hyperlink to the **"terms and services"** so that customers can read and accept them before clicking submit.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up Space Shooter?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/space-shooter
Test your customers' competitiveness and let them win a reward with an engaging game such as Space Shooter.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
An interactive gamification tool that boosts engagement and brand awareness. Customers play Space Shooter to win and unlock rewards, driving interaction, visibility, and new revenue opportunities.
***
## Creating a Space Shooter Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Space Shooter** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **On Widget:**
Customers can access the game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
* **Registered Customers:**
Customers who have an account on your platform (signed up)
* **Anonymous Customers:**
Visitors browsing anonymously without providing any contact information or identifiable details (not signed up)
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:**
You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
By default, customers can play **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## End User Experience
**How it works:**
Customers start by trying to hit the gifts and rewards and intentionally miss the bombs.
Customers win if they reach a certain score before time ends.
The game ends when time ends.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
Configure the banner that appears in the widget to promote the Space Shooter campaign.
Set up the main game screen with headlines, descriptions, and call-to-action messages.
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Tooltips**: Added help text explaining how time and lives impact gameplay.
Shown when audience is set to **Anonymous Customers (Not logged in)**. Collect visitor information before gameplay.
Customize the message and visuals shown when a customer wins or does not win.
For each screen, you can tailor:
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Note
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up Spin the Wheel?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/spin-the-wheel
Engage your customers with Gameball's gamified tool and let them spin to win!
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Starter | Yes |
| Pro & Guru | Yes |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
Introduce an element of chance with the Spin the Wheel template. Customers can earn a spin as a reward for their actions, allowing them to win various prizes, from discounts to free products or bonus points. You can also organize weekly contests or lucky draws to encourage customers to return to your platform regularly.
***
## Creating a Spin the Wheel Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Spin the Wheel** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **Registered Customers:**
Customers who have an account on your platform (signed up)
* **Anonymous Customers:**
Visitors browsing anonymously without providing any contact information or identifiable details (not signed up)
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:**
You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
* **Wheel Banner on Widget:**
A banner will display on your widget's homepage. When customers click the banner, they'll be taken to the game screen where they can spin the wheel.
* **Deep Link:**
Use the `#gameball-wheel` deep link to trigger the Spin the Wheel campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
By default, customers can spin the wheel **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## Rewards Setup
Choose from any of the reward types supported by Gameball. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
| Setting | Value |
| ----------------------- | ----- |
| Minimum rewards allowed | 2 |
| Maximum rewards allowed | 8 |
Enter a numerical value (e.g., 2, 3, 4) to represent the probability of a customer receiving this reward. Every spin is completely independent of the previous ones, and the chance of landing on a specific reward is always the same, no matter how many times the wheel has been spun.
* The probability input can accept a value of 0, meaning the reward will not be available.
* Probabilities are calculated based on the sum of all assigned probabilities across the rewards.
* **Probability Adjustments:** The new probability will take effect immediately for future spins.
While each reward has a set probability, it doesn't guarantee that all rewards will be won equally over time. Some rewards might appear more often, while others might be less frequent. It's all part of the random nature of the game!
**Example:**
* Reward #1: Probability 1
* Reward #2: Probability 1
* Reward #3: Probability 1
After 100 spins, you might see results like this:
* Reward #1: 27 times
* Reward #2: 36 times
* Reward #3: 37 times
The maximum number of times a specific reward can be claimed by all customers throughout the campaign.
* **Optional Feature:** You can choose to add a reward limit when configuring the campaign.
* **Tracking Wins:** Gameball will track how many times each reward has been won. After the limit is reached, the reward will still appear on the wheel but will no longer be winnable.
* **Reward Limit Adjustment:**
* **Increase the Limit:** If the new limit is higher, customers can win the reward again.
* **Decrease the Limit:** If the new limit is lower, the system will prevent the reward from being won if the initial limit was already reached.
* **Removing a Reward:**
* Setting a probability to 0 effectively makes the reward unavailable. The reward will still appear on the wheel, but will no longer be winnable.
* Removing a reward completely will make the reward unavailable on the wheel and unwinnable.
**Example:**
* Reward 1: Probability 1, Limit: 1
* Reward 2: Probability 1, No Limit
* Reward 3: Probability 1, No Limit
After 10 spins: Reward 1 hits 1 win (limit reached), Reward 2 hits 5 wins, Reward 3 hits 4 wins.
* If all rewards have limits and they are reached, customers will see a "No rewards available at the moment" message.
* Drag and drop the created reward to reorder them on the wheel.
***
## End User Experience
**How it works:**
Customers earn rewards through spinning the wheel.
Spinning offers a chance to win rewards: discounts, free products, bonus points, and more.
The customer is notified via the widget or email, depending on your configuration when they earned a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
Configure the banner that appears in the widget to promote the Spin the Wheel campaign.
Set up the main game screen with headlines, descriptions, and call-to-action messages.
Shown when audience is set to **Anonymous Customers (Not logged in)**. Collect visitor information before gameplay.
Customize the message and visuals shown when a customer wins.
Configure the message shown when a customer does not win.
For each screen, you can tailor:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Notes
### Fraud Prevention
In the "Spin the Wheel" campaigns for guests (**Audience is Anonymous/Not Logged-in**), the following protections apply:
| Protection | Description |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Single Spin Per Session** | Guest users can spin the wheel only once per session. If they attempt to re-enter, a message displays: "You have already spun the wheel." |
| **Multiple Wheels in Campaign** | For campaigns with multiple wheels, this restriction applies individually to each wheel. Guests can still spin any other wheels they haven't tried. |
| **Session Restriction** | If a guest opens a new browser tab or window after spinning, the same restriction message will appear. |
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
### Anonymous Option
* If you choose **Anonymous** as the audience, the campaign will be available to visitors who are not yet identified on your store.
* Once enabled, a lead form will automatically appear prompting the customer to enter their information (e.g. name, email).
* This is a great way to collect leads and retarget potential customers later.
* You can fully customize this form by navigating to **Customize Design -> Lead Form**.
Customizing the lead form also allows you to add a hyperlink to the **"terms and services"** so that customers can read and accept them before clicking submit.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up Stamps?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/stamps
Ensure your customers keep coming back to repeat the same action over and over.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
The **Stamps** campaign allows you to reward customers for completing a specific action multiple times in a row. It's a powerful way to boost repeat behavior and long-term engagement.
***
## Use Cases
Place 3 orders within this month to earn a reward.
Make 5 orders over \$100 each to get rewarded.
Make 3 orders, each one from a specific collection (Kids, Women, Men).
Refer 3 friends to get a premium membership.
***
## Creating a Stamps Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Stamps** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
Choose how many times a customer needs to complete the action to earn a reward.
*Example:* "The customer must place 5 orders to receive a reward."
Select the action you'd like to track -- such as placing an order, referring a friend, etc.
You can set specific conditions for each action in the streak.
*Example:*
* Order 1 must be at least \$100
* Order 2 must be at least \$300
* You can set **one condition per action** in the streak. For example, require an order to meet a minimum amount or come from a specific collection.
* You **can use different collections for each action**, but you cannot mix condition types (e.g., minimum amount for one action and collection for another). Different values or amounts can be set for each step.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## End User Experience
**How it works:**
The customer starts by completing the first required action (e.g., placing an order).
They complete each step in the streak in sequence.
They receive notifications after each step if event notification is enabled. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
After finishing all the steps, the customer receives the reward immediately (points, discount, badge -- based on your setup).
If allowed, they can repeat the streak to earn the reward again as per the repeatability setup. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
Configure the banner that appears in the widget to promote the Stamps campaign.
Set up the main campaign screen with headlines, descriptions, and call-to-action messages.
Customize the message and visuals shown when a customer completes the stamp cycle and earns a reward.
Add the terms and conditions for participation in this campaign.
For each screen, you can tailor:
* **Branding**: Adjust background colors, text colors, and upload custom artworks.
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Editing a Live Stamps Campaign
Editing a live campaign should be done with care to ensure a smooth experience for your customers.
The **trigger event**, **trigger condition**, and **streak length** **cannot be edited**.
If changes are required, the admin must **create a new campaign**.
**Audience Edited:**
* All existing customers are **re-evaluated**.
* Customers who no longer match the updated audience are **automatically exited** from the campaign.
**Auto-Removed from Audience (e.g., segment change):**
* The same behavior applies -- the customer is **automatically exited** from the campaign.
**Mid-Cycle Exit Impact**
If a customer exits **in the middle of a cycle**, they will:
* **Lose all progress** made in that cycle.
* The cycle will still **count toward their repeatability limit**, even if not completed.
**Widget Behavior:**
1. The customer is ineligible and has not earned the streak. The campaign is **hidden** from the widget.
2. The customer has already earned the streak at least once -- the badge remains **visible in the widget** with an **"Achieved"** status. Any progress in the current cycle is **lost**.
**New Limit is Higher:**
* Customers can **rejoin** the campaign if they are still eligible under the updated limit.
**New Limit is Lower:**
* All customers are **re-evaluated**.
* Customers who have already reached or exceeded the new limit will be **automatically exited** from their current cycle.
**Mid-Cycle Exit Impact**
If a customer is exited **mid-cycle** due to the limit change:
* They will **lose any progress** made during that cycle.
* The cycle will still **count toward their repeatability limit**, even if no reward was earned.
**De-activate:** Customer progress is **saved**. Any actions performed while the campaign is inactive **will not** be counted toward the streak.
**Re-activate:** Customers resume from the **last saved step**. Progress continues as normal.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up Streak Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/streak-campaign
Make your consistent customers feel special using the streak reward campaign template.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Starter | Yes |
| Pro & Guru | Yes |
| Plan | Available |
| ---- | --------- |
| All | Yes |
Streak campaigns help you increase customer engagement by rewarding consecutive actions over time. You can configure streaks based on any customer action, such as purchases, reviews, or visits, and reward customers with points, coupons, or badges as they maintain their streak. This habit-forming campaign keeps your brand top-of-mind and encourages regular interaction.
***
## How to Create a Streak Campaign
From the left bar, choose **Reward** under **Campaigns**. Click **Create New Reward Campaign**.
Scroll to choose the **Streak** under **Engagement & Gamification**.
You may follow the steps in this article to configure the general settings of this campaign. [Learn more about setting up a Reward Campaign.](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign)
Select the actions that will count toward the streak. Examples:
* Purchases
* Reviews
* Website visits
In the **Rewards** section, set up the streak rewarding system. For example, you might want customers to get 10 points every day they purchase until the 5th day, then 20 points daily until the 10th day, then 50 points thereafter.
If the customer misses a day, they start over. The streak resets, but milestone badges already earned remain with the customer.
You can add up to **10 Daily Rewards**. Rewards should increase with longer streaks to encourage continued engagement.
Add the Badges of each streak. Badges are awarded when customers reach a milestone and remain permanently, even if the streak resets.
***
## How Gameball Tracks Daily Visits
If the trigger chosen is **Daily Visits**, here is how Gameball records customer check-ins:
A **daily visit (check-in)** is recorded when a registered customer interacts with your platform after **midnight (00:00 AM)** in their local time.
A customer visit is counted as a daily check-in in any of the following cases:
* The customer is **logged in** and loads any page that includes the **Gameball widget** (typically added via a JavaScript snippet).
* If the customer is **logged out**, they must **log in** for the visit to count.
* The platform sends **any event** on behalf of the customer (e.g., a purchase or tier-up event).
* You **retrieve customer details via the Gameball API** (e.g., calling `Get Customer` endpoint).
If you're not using a built-in Gameball plugin like **Shopify** or **Salla**, make sure the widget is integrated using our JavaScript SDK [guide](/installation-guides/v3/web/getting-started) to ensure proper tracking.
On mobile, a check-in is registered under the following conditions:
* The customer **clicks on the loyalty program button** to launch the Gameball widget.
* The app **initializes the Gameball SDK**, even in the background, when the customer opens the app.
* The app sends **any event** related to the customer through Gameball's event tracking.
* You **retrieve customer details via the API** (same as on web).
Simply opening the app without triggering the widget or an event **will not** count as a check-in.
***
## Streak Achievement Events
Every time a customer progresses in a streak, Gameball fires a `streak_progression` event. You can use this event to trigger automations, send personalized messages, or build custom segmentation logic.
### Event Fired on Every Streak Progression
The `streak_progression` event fires automatically whenever a customer advances their streak — regardless of whether a reward milestone was reached.
### Using Streak Events for Automation and Personalization
You can reference this event in:
* **Automation campaigns** — trigger a flow when a customer reaches a specific streak length
* **Communication campaigns** — send a congratulatory message at key milestones
* **Segmentation** — group customers based on their current or longest streak
### Event Metadata
| Field | Description |
| ------------------------- | ----------------------------------------------------------------- |
| `campaign_id` | The ID of the streak campaign |
| `campaign_name` | The name of the streak campaign |
| `current_streak_duration` | The customer's current consecutive streak count |
| `longest_streak_duration` | The highest streak the customer has ever reached in this campaign |
* The `streak_progression` event fires on every progression, not just on reward milestones.
* If the streak resets, `current_streak_duration` resets to 0, but `longest_streak_duration` retains the historical maximum.
* Milestone badges earned remain with the customer even after a reset.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up a Survey Campaign?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/survey-campaign
Collect customer feedback without leaving Gameball, and reward customers in points or coupons for completing it.
| Platform | Plan |
| ---------- | ------------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Self Serve | Contact Sales |
Collect customer feedback directly through Gameball and pay for it in points. **Survey** is a reward campaign type with its own question builder, an optional completion reward, and three ways to reach customers: inside the loyalty widget, as a storefront popup, or through a standalone shareable link.
This is a native Gameball campaign type. For the Shopify-Flow-based template that rewards customers for completing a survey on a separate app (e.g. Okendo), see [Fill a Survey (Shopify Flow)](/product-documentation/rewards-campaigns/templates/engagement-gamification/fill-a-survey).
***
## How to Set Up
Log in to your Gameball dashboard.
Click **Add Reward Campaign**.
Choose the **Survey** template.
Edit the campaign's setup to match your goals (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **All Customers**
* **Anonymous Customers (Not logged in)**
* **Specific Customers:** Filter by segment, tag, or customer attributes to limit who can participate.
As you adjust the audience, Gameball shows how many customers are currently eligible to participate.
* **Customer completes the survey:** The reward is issued once the customer submits all required questions.
* **Web Popup (URL-based trigger):** Show the survey as a popup on specific storefront pages.
Choose how many times a customer can earn this campaign:
* **Unlimited**
* **Limited to X times overall**
* **Time-based limit (per period)**
* **Combined** (overall + per period)
The completion reward is issued only once per customer per allowed repetition, no matter which channel (widget, popup, or shareable link) they used.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## Question Builder
Build your survey from seven supported question types:
| Type | Description |
| ------------------- | ----------------------------------------------- |
| **Single Choice** | Customer picks one option from a list. |
| **Multiple Choice** | Customer can select more than one option. |
| **Short Text** | A single-line free-text answer. |
| **Long Text** | A multi-line free-text answer. |
| **Rating Scale** | Customer rates on a scale of 1–5 or 1–10. |
| **NPS** | Net Promoter Score question, scored 0–10. |
| **Image Choice** | Customer picks one option from a set of images. |
Add, reorder, and delete questions freely, and mark any question **Required** or **Optional**.
Reward the survey with points or a coupon from your existing redemption rules — or run it with no reward at all. You can also set a start/end date and a total participation limit for the whole campaign, independent of per-customer repeatability.
***
## Distribution
Reach customers through three channels, configurable independently:
* **Gameball Widget:** The survey appears inside the loyalty widget.
* **Storefront Popup:** Enable popup mode with a configurable trigger — page load, time delay, or exit intent.
* **Shareable Link:** Copy an auto-generated link that renders the survey on a Gameball-hosted page, no widget required. Useful for emails, SMS, or social posts.
***
## Customization
Customize branding and copy for each stage of the survey — Intro, Question, and Success screens.
* **Branding:** Set the main color and button text color.
* **Content:** Edit button labels and other on-screen copy per screen, with support for both English and Arabic.
* Question transitions and selections are animated, with a confirmation screen shown on submission.
***
## Customer Experience & Data
* **Identified customers** are credited automatically for their responses.
* **Anonymous link visitors** are handled based on your campaign configuration.
* Any survey answer can be stored back on the customer as a **customer attribute**, so responses become segmentation and targeting criteria for future campaigns, automations, and audiences.
* Responses are stored per campaign and exportable as CSV.
* Aggregated results for every published survey are available in **Insights**. See [Survey & Quiz Response Analytics](/product-documentation/rewards-campaigns/reward-campaigns-insights#survey-quiz-response-analytics).
***
## Important Notes
**Customer Eligibility**
The survey updates dynamically based on customer eligibility, ensuring customers only see surveys they can still participate in. If a customer no longer belongs to the campaign's target segment, the survey is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Step-by-step guide to configuring any reward campaign.
Learn which metrics to track and how to measure campaign performance.
Reward customers for completing a survey on a connected Shopify Flow app.
# How Do I Set Up Tap The Target?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/tap-the-target
Test your customers' fast reaction and let them win a reward with an engaging game such as tap the target.
## Plan Availability
| Plan | Available |
| ---------- | --------- |
| Pro & Guru | Yes |
| Plan | Available |
| ------ | --------- |
| Add-on | Yes |
An interactive gamification tool that boosts engagement and brand awareness. Customers play Tap The Target to win and unlock rewards, driving interaction, visibility, and new revenue opportunities.
***
## Creating a Tap The Target Campaign
Open Gameball and click **Add Reward Campaign**.
Select the **Tap The Target** template.
Edit the campaign's setup (see configuration sections below).
Click **Set Live** to activate the campaign.
***
## Campaign Configuration
* **On Widget:**
Customers can access the game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
* **Registered Customers:**
Customers who have an account on your platform (signed up)
* **Anonymous Customers:**
Visitors browsing anonymously without providing any contact information or identifiable details (not signed up)
* Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience.
* Widget deep links that open a specific game work for guests as well. The widget would open directly into the game screen and allow participation without login.
* **Specific Customers:**
You can choose for a specific selection of customers to participate in this campaign by filtering using segments, tags or customer attributes.
By default, customers can play **once per day**. A new opportunity to replay it begins at 00:00 AM based on the chosen time zone.
All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## End User Experience
**How it works:**
Customers start playing by tapping the good items, such as gifts and stars, and ignoring the bad items, such as bombs.
Every time the customer taps a good item, they gain a score, and vice versa when they tap a bad item.
The game ends when the time ends.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
Configure the banner that appears in the widget to promote the Tap The Target campaign.
Set up the main game screen with headlines, descriptions, and call-to-action messages.
* **Time Duration**: Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Mistakes/Lives**: Choose how many lives a customer has (e.g., 1, 3, or unlimited).
* **Tooltips**: Added help text explaining how time and lives impact gameplay.
Shown when audience is set to **Anonymous Customers (Not logged in)**. Collect visitor information before gameplay.
Customize the message and visuals shown when a customer wins or does not win.
For each screen, you can tailor:
* **Content**: Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Note
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Learn the full setup process for creating and activating reward campaigns.
Explore all reward types available and how to configure each one.
Configure in-app and email notifications triggered when customers earn rewards.
# How Do I Set Up The Catcher?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/the-catcher
Test your customers' reaction time and let them win a reward with an engaging game, such as the Catcher.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
An interactive gamification tool that boosts engagement and brand awareness. Customers try to catch positive icons and miss bad ones to unlock rewards, driving interaction, visibility, and new revenue opportunities.
**Use Cases:**
1. **Boost Activity:** Encourage daily or weekly logins with regular gameplay and rewards to drive retention.
2. **Brand-Sponsored Challenges:** Brands can sponsor games, driving engagement and creating new revenue streams for Gameball customers.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Catcher** Template.
Configure your campaign's audience, rewards, repeatability, and platform visibility.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
Customers can access the Catcher game through two entry points:
* **On Widget:** Customers can access the catcher game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing.
* **Deep Link:** Use the deep link to trigger the catcher campaign from a custom banner or button on your website or app. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Audience Options:**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience. Widget deep links that open a specific game work for guests as well — the widget opens directly into the game screen and allows participation without login.
* **Specific Customers:** You can choose a specific selection of customers to participate in this campaign by filtering using segments, tags, or customer attributes.
**Repeatability:**
By default, customers can play **once per day**. A new opportunity to replay begins at 00:00 AM based on the chosen time zone. All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility:**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## Game Rules
Go to **Customize Design -> Game** to set up the rules.
**Dropping Items**
1. The game includes **items to catch** and **items to avoid** by default, and you can add up to 5 items each.
2. Customers must catch enough items and reach the required score **before the timer runs out**.
**Minimum Items to Collect & Time**
* Specify the minimum amount of items that should be caught to win before time runs out.
* Specify the duration (in seconds) during which the customer is allowed to play the game.
**Lives**
* To add difficulty, you can **limit the number of lives**. If customers lose more lives than specified by collecting bad items, they lose.
***
## How It Works for Customers
Customers move the cursor to slide the basket left and right. Random items are dropping.
The customer tries to catch good items and must avoid bad ones to win.
The game ends when the time runs out or when the customer loses the maximum number of lives.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner**
* **Intro / Main Screen**
* **Success Screen**
* **No Luck Screen**
* **Game General Rule Customizations:**
* **Time Duration:** Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Mistakes/Lives:** Choose how many lives a customer has (e.g., 1, 3, or unlimited).
* **Minimum Number of Items to Collect.**
* **Tooltips:** Added help text explaining how time and lives impact gameplay.
For each screen, you can tailor the following elements:
* **Branding:** Adjust background colors, text colors, and upload custom artwork.
* **Content:** Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Tic Tac Toe?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/engagement-gamification/tic-tac-toe
Test your customers' intelligence and let them win a reward with an engaging game such as tic tac toe.
| Platform | Plan |
| ------------ | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-Platform | Add-on |
An interactive gamification tool that boosts engagement and brand awareness. Customers play Tic Tac Toe to win and unlock rewards, driving interaction, visibility, and new revenue opportunities.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Tic Tac Toe** template.
Configure your campaign's audience, rewards, repeatability, and platform visibility.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
Customers can access the game through the **Badges** section in the widget. Tapping the badge redirects them to a screen where they can start playing and trigger the campaign to begin playing.
**Audience Options:**
* **Registered Customers:** Customers who have an account on your platform (signed up).
* **Anonymous Customers:** Visitors browsing anonymously without providing any contact information or identifiable details (not signed up).
Visitors can open the game, submit basic information through the lead form, play, and receive rewards, matching the standalone game URL experience. Widget deep links that open a specific game work for guests as well — the widget opens directly into the game screen and allows participation without login.
* **Specific Customers:** You can choose a specific selection of customers to participate in this campaign by filtering using segments, tags, or customer attributes.
**Repeatability:**
By default, customers can play **once per day**. A new opportunity to replay begins at 00:00 AM based on the chosen time zone. All Games campaigns support only the Limit per day/week/etc. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
**Platform Visibility:**
You can choose whether the game campaign is shown on web, mobile, or both, giving you better control over engagement strategies across platforms.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customers start by choosing a block to play X on.
Three Xs on the same row, column, or diagonal means a win.
The game ends when all 3 boxes on the line are won by the customer or the AI, or the time ends.
The customer is notified via the widget or email, depending on your configuration, when they earn a reward. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Customization
You can fully customize each stage of the campaign through dedicated tabs representing the different screens in the flow:
* **Banner**
* **Intro / Main Screen**
* **Game General Rule:**
* **Time Duration:** Set how long each game lasts (e.g., 10s, 20s, 60s).
* **Tooltips:** Added help text explaining how time and lives impact gameplay.
* **Lead Form** (if audience set to Anonymous Customers - Not logged in)
* **Success Screen**
* **No Luck Screen**
For each screen, you can tailor the following elements:
* **Content:** Edit the headlines, descriptions, and call-to-action messages to match your tone and messaging.
***
## Important Notes
**Customer Eligibility**
Games in the widget update dynamically based on customer eligibility, ensuring customers only see games they can still participate in.
**Games are hidden when customers become ineligible.**
If a customer no longer belongs to the game's target segment, the game is automatically removed from the widget and won't reappear unless eligibility is restored.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy 3 Items from a Specific Collection?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-3-items-from-collection
Reward customers who buy multiple items from a specific collection to promote product bundles and increase order value.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Drive deeper engagement with your product collections by rewarding customers who buy multiple items from a specific collection. The ***Buy 3 Items from a Specific Collection*** campaign is ideal for promoting seasonal ranges, product bundles, or themed collections, encouraging customers to add more items to their cart and increase their order value.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy 3 Items from a Specific Collection** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:**
* **Field:** Collection ID
* **Operator:** Repeated Value
* **Collection ID:** *Enter the target Collection ID*
* **Repeated Value Times:** 3 *(Customer must purchase 3 items from this collection)*
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places an order that includes **three items from the same collection**.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Same Collection Requirement**
All three items must belong to the **same configured collection** to trigger the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy a Specific Product?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-a-specific-product
Reward customers for purchasing select products to drive targeted sales and increase product visibility.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Use the ***Buy a Specific Product*** campaign to highlight and promote key items in your catalog. By rewarding customers for purchasing select products, you can drive targeted sales, increase product visibility, and encourage repeat purchases of high-priority or new stock.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy a Specific Product** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:** Add the **Product ID** to the trigger to specify which product you ask them to purchase.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer **places an order** that includes the configured product/s.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Product-Specific Only**
The reward will only trigger if the customer's order includes the **Product ID(s)** you've specified.
**Multiple Products**
* You can add several product IDs if you want to reward purchases that contain **all** the configured products as a group.
* To do this: Click **Add Rule -> Select Product ID -> Choose "Equals" -> Enter the Product ID**
* The reward will only trigger when the customer's order includes **every product ID** listed in the campaign setup.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy from 3 Different Collections?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-from-3-different-collections
Reward customers who shop across multiple collections to encourage product discovery and increase average order value.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Encourage product discovery and increase average order value by rewarding customers who shop across multiple collections. The ***Buy from 3 Different Collections*** campaign is perfect for cross-selling and promoting variety in customer purchases. By targeting collection diversity, you can guide customers to explore more of what your store offers.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy from 3 Different Collections** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:**
* **Field:** Collection ID
* **Operator:** Different values
* **Value:** 3 *(Number of different collections required in a single order)*
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places an order that includes products from **three different collections**.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Collection Diversity Required**
The order must include products from **three different collections** to trigger the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy from a Specific Collection?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-from-a-specific-collection
Reward customers who shop from selected collections to boost seasonal sales, highlight new arrivals, or push slower-moving inventory.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Use the ***Buy from a Specific Collection*** campaign to promote entire product categories by rewarding customers who shop from selected collections. This is a great way to boost seasonal sales, highlight new arrivals, or push slower-moving inventory by creating targeted incentives for collection-based purchases.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy from a Specific Collection** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:** Add the **Collection ID** to the trigger to define which collection(s) qualify.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer **places an order** that includes at least one product from the configured collection.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Collection-Specific Only**
The reward will only trigger if the customer's order includes a product that belongs to the **specified collection/s**.
**Multiple Collections**
* You can add several collection IDs if you want to reward purchases that contain products from **all** the configured collections.
* To do this: Click **Add Rule -> Select Collection ID -> Choose "Equals" -> Enter the Collection ID** for each collection you want to include.
* The reward will only trigger when the customer's order includes at least one product from **every collection ID** listed in the campaign setup.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy Over $50 and Get $5 on the Next Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-over-50-get-5-next-order
Encourage higher-order values and repeat purchases by rewarding customers who spend over $50 with a $5 discount on their next order.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Encourage higher-order values and repeat purchases with the ***Buy Over $50 and Get $5 on the Next Order*** campaign. This setup is perfect for motivating customers to spend more now in exchange for a clear reward they can redeem later, helping you boost both short-term revenue and long-term retention.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy Over $50 and Get $5** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:**
* **Field:** Total Price
* **Operator:** >= (Greater than or equal)
* **Value:** 50
**Reward:**
* The customer gets a **\$5** coupon.
* The reward value can be adjusted from the campaign.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places an order worth **\$50 or more**.
Gameball automatically triggers the reward.
The customer receives a **\$5 discount**, which can be applied to their **next order**.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Minimum Order Value Required**
Only orders with a **total price of \$50 or more** will trigger the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Buy X Get Y on the Next Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/buy-x-get-y-next-order
Reward customers for purchasing high-priority products with a valuable reward on their next order to boost sales and drive repeat purchases.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Use the **Buy X and Get Y** campaign to reward customers for purchasing high-priority products while encouraging them to return and shop again. By offering a valuable reward in the next order, you not only boost sales of key items but also drive repeat purchases and build stronger customer loyalty.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Buy X and Get Y** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:** Add the **Product ID** to the trigger to specify which product you ask them to purchase.
**Reward:**
* The customer gets **Y product** as a coupon.
* The reward value can be adjusted from the campaign.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer **places an order** that includes the configured product/s.
Gameball automatically triggers the reward as a coupon used on the next order.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Reward applies to next order**
While this is a Buy X Get Y campaign, the **Y item is delivered as a coupon** that the customer can redeem in their next order.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Exceed My Highest Order Value?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/exceed-highest-order-value
Motivate customers to increase their order value by offering rewards each time they exceed their previous highest purchase.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Motivate customers to increase their order value by offering rewards for larger purchases. Each time the customer exceeds their highest order value, they will earn a reward that you set up. This tactic can help boost average order value and maximize revenue per transaction.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Exceed your highest order value** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
This campaign rewards customers for placing orders:
1. Each time a customer places an order that exceeds their previous highest order value, they earn a reward.
2. You can set a minimum order value to activate the campaign (e.g., the order must exceed a specific amount to qualify, such as \$100).
**Repeatability:**
Customers can earn this reward unlimited times, as long as each new order exceeds their previous highest order value. This setting cannot be customized.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
Customer places an order with an order value higher than their previous highest purchase.
Customer gets rewarded immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Earning Rules**
1. This campaign only triggers on placed order events.
2. Customers can earn the reward unlimited times, as long as each new order exceeds their previous highest value.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Fifth Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/fifth-order
Reward customers after completing five orders to acknowledge loyalty and encourage continued engagement.
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers after completing five orders is a powerful way to acknowledge loyalty and encourage continued engagement. Reaching five purchases is a clear indicator of strong satisfaction with your brand, and a reward at this stage helps build emotional connection and long-term retention. It's a great opportunity to reinforce habits and turn regular customers into true brand advocates.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Fifth Order** Template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger fires when the customer places **5 orders** on your platform:
* **Action:** Place Order
* **Times:** 5
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places **5 orders** after the campaign is activated.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**New Orders Only**
Only customers who place five new orders **after** the campaign is activated will be rewarded.
**No Retro Rewarding**
Orders placed before the campaign is activated will **not** be counted. The customer must place **five new orders after activation** to receive the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up First Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/first-order
Reward customers for placing their first order to drive conversions and turn new signups into paying customers.
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers for placing their first order is a great way to drive conversions and turn new signups into paying customers. This campaign is perfect for encouraging first-time purchases and strengthening early-stage customer relationships.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **First Order** Template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger fires when the customer places their **first order** on your platform:
* **Action:** Place Order
* **Times:** 1
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places a **new order** after the campaign is activated.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**New Orders Only**
Only customers who place a new order **after** the campaign is activated will be rewarded.
**No Retro Rewarding**
Orders placed before the campaign is activated will **not** be counted. The customer must place **a new order after activation** to receive the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Free Shipping for Orders Over $500?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/free-shipping-orders-over-500
Reward high spenders with a free shipping coupon for their next purchase to drive repeat orders and improve customer satisfaction.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Encourage larger purchases by rewarding high spenders with a **free shipping coupon**. With the *Free Shipping for Orders Over \$500* campaign, customers who place a qualifying order receive a free shipping coupon to be used on their **next purchase** — a smart way to drive repeat orders and improve customer satisfaction.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Free Shipping for Orders Over \$500** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of orders required with this condition)*
3. **Rule:**
* **Field:** Total Price
* **Operator:** >= (Greater than or equal)
* **Value:** 500
**Reward:**
* The customer gets a **Free Shipping** coupon used on the next order.
* The reward value can be adjusted from the campaign.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places an order worth **\$500 or more**.
Gameball automatically triggers the reward.
The customer receives a **free shipping coupon**, which can be used on their **next order**.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Minimum Order Value Required**
Only orders with a total value of **\$500 or more** will qualify.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Get 20% Coupon After Spending a Total of $1000?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/get-20-percent-coupon-after-spending-1000
Reward high spenders with a 20% coupon when they reach a cumulative spending milestone of $1000 to drive long-term engagement.
| Platform | Plan |
| ------------ | ------------------ |
| Shopify | Starter, Pro, Guru |
| Salla | Starter, Pro, Guru |
| Non-Platform | All Plans |
Reward your high spenders and loyal customers with a special coupon when they hit a spending milestone. The ***Spend \$1000 to Get 20% Off*** campaign is perfect for driving long-term engagement and showing appreciation to your most valuable customers. It encourages larger purchases over time and reinforces customer loyalty through meaningful rewards.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Get 20% coupon after spending a total of \$1000** template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger is configured as follows:
1. **Action:** Place Order
2. **Times:** 1 *(Number of times the trigger condition should be occurred)*
3. **Rule:**
* **Field:** Total Price *(Order value)*
* **Operator:** Accumulative Total *(Tracks the total value of all orders placed)*
* **Value:** 1000 *(Customer must reach \$1000 in total spend)*
**Reward:**
* The customer gets a **20%** coupon.
* The reward value can be adjusted from the campaign.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer reaches a **total spend of \$1000** over any number of purchases.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**Cumulative Spend**
The **\$1000** spend is calculated cumulatively across all orders. It does not need to be a single transaction.
**Accumulated Spending Logic**
When using the "**Accumulative Total**" operator and setting the "**Times**" field to a value like **2 or 3**, the trigger must be fulfilled **that many times**. For example, if the condition is spending $1000 and the Times field is set to 2, the customer must spend $1000 twice (a total of \$2000) to earn the reward.
**Starts from Activation Only**
The accumulation begins **only from the moment the campaign is set live**. Any orders placed **before** activation are **not counted** toward the total spend.
**Using Other Operators ( = or >= )**
If you change the operator to **=** or **>=**, the customer must reach the specified spend in one order.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Second Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/second-order
Reward customers for their second order to turn first-time buyers into loyal customers and boost retention.
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers for their second order is a great way to turn first-time buyers into loyal customers. While the first purchase shows interest, the second confirms trust. This campaign helps boost retention and encourages consistent buying behavior early in the customer journey.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Second Order** Template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger fires when the customer places **two orders** on your platform:
* **Action:** Place Order
* **Times:** 2
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places **2 orders** after the campaign is activated.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**New Orders Only**
Only customers who place two new orders **after** the campaign is activated will be rewarded.
**No Retro Rewarding**
Orders placed before the campaign is activated will **not** be counted. The customer must place **two new orders after activation** to receive the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Tenth Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/tenth-order
Reward customers for completing ten orders to celebrate loyalty and strengthen long-term relationships.
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers for completing ten orders is a great way to celebrate loyalty and strengthen long-term relationships. Hitting ten purchases is a major milestone that reflects consistent satisfaction and trust. A well-timed reward here can increase emotional attachment and encourage continued purchasing behavior.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Tenth Order** Template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger fires when the customer places **10 orders** on your platform:
* **Action:** Place Order
* **Times:** 10
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places **10 orders** after the campaign is activated.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**New Orders Only**
Only customers who place ten new orders **after** the campaign is activated will be rewarded.
**No Retro Rewarding**
Orders placed before the campaign is activated will **not** be counted. The customer must place **ten new orders after activation** to receive the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Third Order?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/purchase-order-incentives/third-order
Reward customers for completing their third order to reinforce buying habits and build long-term loyalty.
| Platform | Plan |
| ------------ | --------- |
| Shopify | All Plans |
| Salla | All Plans |
| Non-Platform | All Plans |
Rewarding customers for completing their third order helps reinforce buying habits and build long-term loyalty. This milestone shows growing trust in your brand, and offering a reward at this point can motivate customers to keep coming back. It's a smart way to increase repeat purchases and move customers closer to becoming brand advocates.
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Select the **Third Order** Template.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
***
## Campaign Trigger
The campaign trigger fires when the customer places **3 orders** on your platform:
* **Action:** Place Order
* **Times:** 3
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
A customer places **3 orders** after the campaign is activated.
Gameball automatically triggers the reward.
The customer receives the reward immediately (points, discount, badge — based on your setup).
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign)
***
## Important Notes
**New Orders Only**
Only customers who place three new orders **after** the campaign is activated will be rewarded.
**No Retro Rewarding**
Orders placed before the campaign is activated will **not** be counted. The customer must place **three new orders after activation** to receive the reward.
***
## Related Articles
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# How Do I Set Up Write a Review (Shopify Flow)?
Source: https://docs.gameball.co/product-documentation/rewards-campaigns/templates/social-sharing-reviews/write-a-review
| Platform | Plan |
| ------------ | ------------- |
| Shopify | All Plans |
| Salla | Not Available |
| Non-Platform | Not Available |
Shopify Flow is a powerful automation tool that lets you seamlessly connect Gameball Loyalty with other Shopify apps. Use it to build custom workflows and enhance your loyalty program in multiple ways.
Use Shopify Flow templates to reward customers on Gameball based on actions from other apps — for example, leaving a review on Yotpo, Reviews.io, AG Product Reviews, or any other Shopify Flow-compatible review app.
A Shopify Flow workflow consists of three main parts: **Triggers**, **Conditions**, and **Actions**. [Learn more in the full guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## How to Set Up
Log in to your Gameball Admin Dashboard.
Click **Add Reward Campaign**.
Choose the **"Write a review"** template tagged with Shopify Flow.
Configure your campaign's audience, rewards, and other settings.
Click **Set Live** to activate your campaign.
After creating your campaign, **copy the Campaign ID** from the campaign details page.
From your Shopify admin, go to **Apps > Shopify Flow** and click **Create Workflow**.
Choose the app you use for reviews as the trigger — this works with any Shopify Flow-compatible review app, such as Yotpo, Reviews.io, or AG Product Reviews.
**Add the customer email** if the trigger doesn't pass the customer identifier automatically. See the Important Notes section below for more details.
Add the **"Reward a Campaign"** action and paste the **Campaign ID** you copied from the Gameball campaign details page.
**Save the workflow** to activate it.
This template uses the standard reward campaign setup. See the [Generic Setup Guide](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign) for details.
***
## How It Works for Customers
The customer leaves a review (e.g., via Yotpo).
Shopify Flow triggers the workflow based on the review response.
Gameball rewards the customer with the reward set in the "write a review" campaign.
The customer is notified via the widget or email, depending on your configuration. [Learn more](/product-documentation/rewards-campaigns/start-from-scratch/setup-reward-campaign).
***
## Important Notes
**Repeatability**
The Write a Review campaign template defaults to **Limited to 1 time overall** — meaning each customer can only earn the reward once. You can change this in the campaign setup under **Repeatability**, where you can allow unlimited earnings, set a higher overall cap, or define a time-based limit (e.g., once per month).
**Skip Email Field**
When setting up Gameball as an action in Shopify Flow, you may not need to fill in the email field if the trigger app already passes the customer identifier automatically. In this case, the identifier will appear just above the email field.
***
## Related Articles
Learn how to build custom workflows using Shopify Flow with Gameball.
Learn the full setup process for creating and launching reward campaigns.
Explore the different reward types available in Gameball campaigns.
Configure how customers are notified when they earn a reward.
# What Are Customer Events?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/customer-profile/customer-events
What are events? What are event rules? And how do they contribute to your customers' experience?
## Event
An event is a data point that represents any action between your customer and your platform or product. An event can be a single action or a wide range of interactions. For example, it could be something as simple as viewing a product on your platform to something more sequential, such as a customer searching for, placing, and paying for an order.
Your platform sends Gameball when these events occur or these actions are performed by your customer on your platform. [Learn more](/api-reference/events/send-events)
In return, Gameball can act using this information according to your prompts. For example, Gameball can send a notification reminding your customers to complete their order after they have added an item to the cart.
You can also define your own terms for when Gameball should react when a customer completes a certain event; these conditions are applied through your event rules.
***
## Event Rule
Event rules are metadata that represent the event and help you define its specifications. They define the properties of the customer event to which Gameball should track and find before it takes further actions as instructed. In simpler words, each event can have its own characteristics, or event terms. When these terms are satisfied, Gameball then acts accordingly. These rules can have more specifications, which are called "[keys](/product-documentation/guides-strategies-faqs/supportive-guides/ecommerce-events)".
For example, for a coffee purchase, the event would be Purchase, and the event metadata could be *Item Type* (in this case, a Coffee) or *Item Price* (in this case, \$2.50), and so on.
More examples:
* **Event:** Place Order
* **Rules:** Order price, product type, order weight, etc.
* **Event:** Add to Cart
* **Rules:** Number of products, total price, total order weight, etc.
[Read about suggested customer events for your e-commerce website](/product-documentation/guides-strategies-faqs/supportive-guides/ecommerce-events)
***
## What Else?
How to create and send Events to Gameball.
Use your Shopify Events through Gameball.
How does the Event(s) Rule Engine work?
View and manage your events log.
# What Are Customer Profile Attributes?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/customer-profile/customer-profile-attributes
Discover Gameball's essential customer profile attributes, how to customize them for your business.
Gameball provides one of its most powerful features for personalization -- Customer Attributes. With these attributes, you can enrich each customer profile, store custom data, and create highly targeted campaigns using specific notifications, messages, or emails based on segmented customer groups.
There are three types of customer attributes supported by Gameball:
Predefined by Gameball and expected to be sent by your platform.
Automatically generated and updated by Gameball.
Attributes that you define based on your specific business needs.
***
## Default Customer Attributes
These are attributes expected to be sent from your platform to Gameball using API or integration methods. They help form the base of every customer profile.
If you are using Gameball on a supported platform such as **Shopify** or **Salla**, some of these attributes are already included by default through Gameball's plugin integration.
### 1. Attributes Sent Through API or Platform Integration
These attributes should be provided through your system via Gameball's API or are automatically included when using a native integration with platforms like **Shopify** or **Salla**.
| Attribute | Description | Included in Integration |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| **Customer ID** | Unique identifier for the customer (Required on all customer data sent to Gameball) | Shopify, Salla |
| **Customer Name** | Full display name | Shopify, Salla |
| **First Name** | Customer's first name | Shopify, Salla |
| **Last Name** | Customer's last name | Shopify, Salla |
| **Customer Email** | Email address (Recommended for communications and tracking) | Shopify, Salla |
| **Gender** | Gender identity | |
| **Mobile Number** | Contact phone number | Salla |
| **Date of Birth** | Customer birth date (editable through the dashboard). Not automatically synced from Shopify — customers must provide it themselves, typically through a birthday reward campaign. | |
| **Join Date** | Date the customer joined your store, not the loyalty program. | Shopify, Salla |
| **Country** | Country of customer | |
| **City** | City of customer | |
| **Zip Code** | Postal code | |
| **Preferred Language** | Communication language | |
| **Guest Status** | Indicates if the customer is a guest who is placing guest orders | Shopify |
| **Total Amount Spent** | Total value of all purchases | |
| **Last Order Date** | Date of last order | |
| **Total Orders Count** | Number of total orders placed | |
| **Average Order Value** | Total value divided by number of orders | Shopify |
| **Channel** | Indicates acquisition channel (e.g., mobile, website) | Shopify, Salla |
### 2. Attributes Captured Automatically by Gameball
These attributes do **not** need to be sent from your system. Gameball captures them automatically or when the **Gameball widget** is active on your website.
| Attribute | Description | How It Is Captured |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| **Gameball Creation Date** | The date the customer profile was created in Gameball | Captured automatically when a new customer profile is created |
| **Gameball Source** | Indicates the method through which the customer profile was created on Gameball (e.g., via API, widget initialization, or a platform integration such as Shopify or Salla) | Captured automatically when the customer profile is created |
| **UTMs** | Tracks acquisition sources including medium, campaign, source, content, and term | Automatically captured if the customer visits your website via a UTM-tagged URL and the Gameball widget is enabled |
| **Devices Used** | Devices associated with the customer | Automatically captured if the customer visits your website and the Gameball widget is enabled |
***
## Attributes Calculated by Gameball
These attributes are generated and updated automatically by Gameball based on customer behavior, transactions, and platform activity.
| Attribute | Description | How to Feed into Gameball |
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| **Total Captured Orders** | Total number of orders received by Gameball | Auto-calculated based on the usage of the Order/Payment APIs |
| **Total Captured Amount Spent** | Total spend from captured orders | Auto-calculated based on the usage of the Order/Payment APIs |
| **First Captured Order Date** | Date of first captured order | Auto-calculated based on the usage of the Order/Payment APIs |
| **Last Captured Order Date** | Date of latest captured order | Auto-calculated based on the usage of the Order/Payment APIs |
| **Average Basket** | Total amount divided by number of orders | Auto-calculated based on the usage of the Order/Payment APIs |
| **Unit Per Trx** | Average units per transaction | Auto-calculated based on the usage of the Order/Payment APIs |
| **Average Captured Order Value** | Average order value of captured orders | Auto-calculated based on the usage of the Order/Payment APIs |
| **Total Referrals** | Number of successful referrals | Auto-calculated if Gameball referral is used |
| **Last Referral Date** | Date of last successful referral | Auto-calculated if Gameball referral is used |
| **Total Redemptions** | Number of redemption transactions | Auto-calculated if Gameball points redemption is enabled |
| **Total Redeemed Amount** | Value of redeemed points | Auto-calculated if Gameball points redemption is enabled |
| **Redeemed Points** | Total points redeemed | Auto-calculated if Gameball points redemption is enabled |
| **Last Redemption Date** | Date of most recent redemption transaction | Auto-calculated if Gameball points redemption is enabled |
| **Total Net Amount of Transactions** | Total transaction value after refunds/discounts | Auto-calculated based on the usage of the Order/Payment APIs |
| **Last Login Date** | Last time the customer logged in | Auto-calculated |
| **Last Coupon Usage** | Last time any coupon created by Gameball was used | Auto-calculated |
| **Last Gameball Coupon Usage** | Last time a Gameball-generated coupon was used | Auto-calculated |
| **Last Message Sent Date** | Last in-app message sent by Gameball | Auto-calculated |
| **Last Email Sent Date** | Last email sent by Gameball | Auto-calculated |
| **Transactions Amount in the Last Rolling Year** | Total spend in the past 12 months | Auto-calculated based on the usage of the Order/Payment APIs |
| **Earned Points** | Total points earned | Auto-calculated |
| **Expired Points** | Total points expired | Auto-calculated |
| **Starting Store** | Store where account was created. This will include the branch ID from Gameball Merchant data. | Auto-calculated based on the usage of the Order API and Merchant data was provided |
| **Connecting Store** | Store of the latest transaction. This will include the branch ID from Gameball Merchant data. | Auto-calculated based on the usage of the Order API and Merchant data was provided |
| **Store of First Transaction** | Store where the first order was made. This will include the branch ID from Gameball Merchant data. | Auto-calculated based on the usage of the Order API and Merchant data was provided |
| **Date of First Transaction** | Date of the customer's first transaction. This will include the branch ID from Gameball Merchant data. | Auto-calculated based on the usage of the Order/Payment APIs |
| **Is Referred** | Helps you identify whether a customer was referred by another customer or acquired through other channels. | Auto-calculated |
| **Referral Status** | Distinguishes between customers who were referred but haven't completed the required action ("pending") and those who have successfully completed it ("successful"). | Auto-calculated |
***
## Adding Custom Attributes to Customer Profiles
Need to store additional details like region, area, or membership ID? You can create **custom attributes** to capture unique data specific to your business.
These attributes can be used for segmentation, automation, and personalizing campaigns across Gameball modules. To add custom attributes:
* Define your custom fields via the API
* Assign values to these fields per customer
* Use these values to segment your customers
Custom attributes give you full control over what kind of data to track and how to act on it.
[Read more about how to manage your Gameball customer custom attributes](/product-documentation/admin-settings/manage-customer-attributes)
***
## What is Next?
Use tags to manually group and target customers.
Learn how to manage your Gameball customer attributes.
# What Is Explore and Manage a Customer Profile?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/customer-profile/explore-and-manage-a-customer-profile
Understand what data is displayed inside each customer profile and how to perform key actions.
Each customer has a dedicated profile page in Gameball where you can explore all related data, behaviors, rewards, and available actions. This profile helps you gain insights into individual engagement and loyalty progress, allowing you to take quick and relevant actions.
***
## Profile Overview
You can access the profile of any customer by navigating to **Customers**, then clicking the name or ID of any listed customer. The profile is divided into several key sections:
You can view essential customer information grouped into the following areas:
**Info Panel**
* Includes identity and contact details such as name, email, mobile number, location, and customer status (e.g., guest or registered).
* Displays unique attributes and behavioral indicators such as UTMs and devices used.
* Shows whether the customer is subscribed to your emails and their preferred language.
Learn more in the [Customer Profile Attributes](/product-documentation/understanding-your-customers/customer-profile/customer-profile-attributes) article.
This panel includes:
* The customer's unique **referral link**
* Who referred them (if any)
* A list of customers they have referred
To learn more, visit [Gameball Referral Program](/product-documentation/programs/referral-program/launching-referral-program).
* **Total Amount Spent**: Overall spending captured through your platform.
* **Current Tier**: Customer's current VIP tier.
* **Points Balance**: Total earned points, broken down into active and pending.
You can view the tags and segments the customer belongs to:
* **Tags**: Manually added labels to help with grouping and targeting. [Learn more](/product-documentation/understanding-your-customers/customer-profile/group-your-customers-by-tags)
* **Segments**: Rule-based or RFM segments automatically applied based on behaviors and configurations. [Learn more](/product-documentation/customer-segmentation/how-to-segment-customers)
* **RFM Segments**: Behavioral-based classifications for recency, frequency, and monetary value. [Learn more](/product-documentation/customer-segmentation/rfm-segments/introduction-to-rfm-segments)
If your program has **Family Wallet** enabled, this section will show the customer's wallet group with the combined points balance.
Learn more in the [Family Wallet](/product-documentation/admin-settings/gameball-family-wallet) article.
Displays a timeline of customer interactions or events triggered on your platform. You can click **Show More** to load additional recent events.
Learn more in the [Customer Events](/product-documentation/understanding-your-customers/customer-profile/customer-events) article.
This section lists all the campaigns the customer has completed or participated in. For each campaign, you can:
* View the name and type of campaign
* See how many times it was completed
* Identify which are completed vs. in-progress
* See message type icons (email, in-app, etc.) and key dates like **Sent** and **Clicked** at a glance.
* Cards are sorted by **newest first**, with a **Load More** option for long histories.
* When empty, you will see: *"No Communication Activities Yet."*
* Each automation now displays its **name**, **status (Completed, Waiting, or Exited)**, and key dates (Entry, Complete, or Exit).
* Compact one-line view for simple automations.
* When empty, you will see: *"No Active Automations."*
Clicking a campaign name will redirect you to its configuration page.
***
## Actions You Can Take
At the top of the customer profile, you will find several management options:
| Action | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Include/Exclude Customer** | You can use the toggle on the top of the page to include or exclude the customer from your Gameball loyalty program. |
| **Adjust Balance** | Add or deduct points from their balance. |
| **Adjust Tier** | Manually change the customer's VIP tier. |
| **Reward a Campaign Manually** | Trigger any configured campaign for this customer manually. |
| **Extract** | Export the customer activities list to a CSV file. Read more about this through [Export Your Customer Activities Log](/product-documentation/understanding-your-customers/your-customers/export-customer-activities-log). |
| **Delete** | Remove the customer from Gameball (only available for non-platform-based clients). |
***
## Related Articles
Learn about all customer profile attributes and how to customize them.
Gain insights on launching and managing your referral program.
# What Are Group Your Customers by Tags?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/customer-profile/group-your-customers-by-tags
Use tags to manually group customers and customize special rewards and communication campaigns to be sent only to your tagged customers.
Tags let you group your customers manually. They are great for highlighting VIP customers who may need VIP rewards, loyal customers who should be treated differently, or when you need to simulate different rewards based on the assigned tags. For example, if you want to create and send communication campaigns, notifications, or assign reward campaigns to only a specific group of customers, tags are a great way to link between these customers and the assigned notifications, emails, or reward campaigns.
The maximum number of tags that can be created is **15 tags**.
***
## How to Create Customer Tags
The following steps are also what you need to completely remove or delete a tag.
On your Gameball dashboard, go to **Settings > Admin Settings > Customer Tags**.
On the top right of the page, click **Create New Tag**.
Add the tag **name** and choose the tag **color**, then click **Create**.
***
## How to Tag Your Customers
The following steps are also what you need to remove tags from a customer.
On your Gameball dashboard, go to **Customers**, then open any customer page.
Under the **Segments** section, beside **Tags**, click on **+Add**.
Search for the available tags and assign the tag to the customer.
This is also where you remove a tag from a customer.
On your Gameball dashboard, go to **Customers**.
Click on the **Filter Icon**.
Filter your customers according to your needs, then click **More**.
Choose between adding or removing tags, then click on **+Add**.
Scroll down and pick the desired tag(s), then click **Apply**.
All customers in the currently active filter will be tagged with the selected tags.
If no filter is applied, the operation will automatically tag all customers on Gameball at the moment of the operation.
You can also tag customers using Gameball APIs. Check our [technical documentation](/api-reference/customers/tags/attach-customer-tags) for more details.
***
## What is Next?
Configure different rewards through reward campaigns for your customers based on tags.
Customer tags automatically sync with Gameball customers' tags on Shopify.
# What Is Customers on Gameball?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/gameball-customers/introduction-to-customers-on-gameball
Gameball aims to engage your customers through its variety of modules
When your customer is interacting with your platform through Gameball, they go through a gamified experience that helps boost engagement and retention. As they continue to engage with your platform, customers can earn points, achieve milestones, and progress through VIP tiers.
Gameball automatically creates a profile for every new customer. This profile stores and displays their progress, achievements, point transactions, and all relevant customer activities. You can track all these details through the Gameball dashboard.
***
## What Every Customer Has
Customers start their journey at a specific **VIP tier** and can advance to higher tiers based on the engagement metrics you define. You can choose to measure progress through points, score, or other variables. Gameball allows you to monitor this journey in real-time through the **Gameball dashboard**.
Read more about **VIP Tiers** Methods, [Click Here](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods).
Points are granted to customers for placing orders or completing specific actions/achievements. These points can be redeemed for discounts, benefits, or other rewards that you configure. The more transactions or actions a customer completes, the more points they accumulate.
By default, Gameball will create a profile for every customer, and then you will be able to track their progress, achievements, and points transactions through the Gameball admin dashboard.
Gameball allows you to enrich customer profiles with custom attributes such as name, gender, join date, birthday, and more. These attributes are used in personalized communication, segmentation, and automation across Gameball modules.
Events are any actions performed by your customers on your platform, such as viewing products, adding to the cart, placing an order, etc. You can trigger rewards, segment, or send a campaign to your customers based on these events.
Customers can belong to different segments depending on how they are categorized. These can include tags added manually to the customer profile, dynamic segments based on predefined rules configured by you, or automatically generated RFM segments that consider recency, frequency, and monetary value. These segments can be used to define targeted audiences across all Gameball modules, including campaigns, automation, and redemption options.
***
## What is Next?
Manage your Gameball customer attributes.
Import your customers through a CSV file.
# What Is Customer Activity Log?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/customer-activity-log
Learn where to monitor all your customers' activity, performance, information, and how to extract that data.
The customer activities section is where you can track all the transactions your customers perform on a daily basis, such as earning or redeeming points, tiering up, achieving a campaign, etc.
***
## Overview of the Activities List
To access this, navigate to **Customers > Activities**.
The **Customer Activities** tab logs all tracked actions made by your customers.
### Understand the Columns in the Activities List
Each record includes:
| Column | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Date** | The timestamp of the recorded activity. |
| **Customer** | Displays the customer's Gameball ID and full name (if available). |
| **Activity** | The activity type that was logged (see full list below). |
| **Points** | Reflects the number of points earned or deducted, if applicable. In case points are pending, you will see a clock icon beside the activity points -- hover over it to see when it will be activated. Hovering over the points amount will allow you to see their expiration date. |
| **Coupons** | Shows the coupon type and value if one was issued or redeemed as part of the activity. |
| **Merchant** | Reserved for multi-merchant activities. It shows the merchant name that owns this activity and the corresponding branch name. This is available only in case the [Merchant Module](/product-documentation/programs/loyalty-points-earn/crossover-reward-program/gameball-merchants-crossover-rewards-experience) was used by this account. The Merchant Module is only available for non-platform integration with Gameball. |
### Types of Logged Activities
Below is a list of activity types you may encounter in this section:
| Activity | Description | Comment |
| ------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Automation Activity** | A customer was rewarded or affected through an automated flow. | The automation name is shown as a **clickable link**, taking you directly to the source automation campaign. This makes it easy to trace any reward back to the automation that triggered it. |
| **Balance Adjustment (+ or -)** | Manual adjustment of points by an admin. Includes both addition and deduction. | By default, it has the "Manual" tag. Hover over the manual tag to read the reason behind the adjustment. |
| **Bonus Referral Rewarded** | An extra reward given to a customer for referring X number of friends. | -- |
| **Campaign Rewarded** | A customer completed a reward campaign and received a configured reward. | The second line shows its name and a link to the reward campaign page. |
| **Cashback Cancelled** | A previously issued cashback was canceled (e.g., order refund or cancellation). | The second line shows the order ID. Clicking the ID opens a side tab with order details. |
| **Cashback Rewarded** | A cashback was granted as part of a transaction or campaign. | The second line shows the order ID. Clicking the ID opens a side tab with order details. |
| **Friend Referred** | A new customer was referred successfully by an existing one. | -- |
| **Tier Downgraded** | The customer was downgraded to a lower VIP tier. | The second line shows the newly reached tier. |
| **Tier Upgraded** | The customer was upgraded to a higher VIP tier. | The second line shows the newly reached tier. |
| **Lifetime Coupon** | A lifetime-use coupon was issued to the customer based on the tier. | Read more about this in [Customizing Benefits for Different Tiers](/product-documentation/programs/vip-tiers/tier-settings/customizing-benefits-for-different-tiers). |
| **Migration** | Customer activity imported via CSV or API during data migration. | -- |
| **Points Expiry** | Points expired according to your configured return window and expiration rules. | Read more about [Points Configuration](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system). |
| **Points Redeemed** | Points were used to redeem a reward or benefit. | The second line shows the order ID. Clicking the ID opens a side tab with order details. |
| **Points Refunded** | Previously redeemed points were returned to the customer (e.g., after reward reversal). | The second line shows the order ID. Clicking the ID opens a side tab with order details. |
| **Referee Reward Received** | The referred customer received their reward. | |
Some activities may include a **"Manual"** tag. This indicates that the action was performed manually by an admin, either on an individual customer or through a bulk action. Examples include **Reward a Campaign** manually, or **Adjust Balance** manually.
***
## Customers Page-Level Actions
This section covers how to filter your customer activities list and how to export it.
### Apply Filters to Refine the View
You can **filter** the list based on any of the activities, and you can **extract** the full list or the filtered list.
Click the **Filter** icon at the top of the **Activities** page.
Select from the available filter options listed below.
Define your criteria (e.g., ranges, keywords, status).
Click **Apply Filter** to view only the activities that match your selected criteria.
#### Available Filters
| Filter | Description |
| ------------------------- | -------------------------------------------------------------------------------------- |
| **Creation Date** | Filter activities by the date they occurred. |
| **Customer Type** | Filter between registered customers and guest users. |
| **Customer ID** | Search activities related to a specific customer by their Gameball ID. |
| **Customer Name** | Search for activities linked to a customer by name. |
| **Customer Email** | Filter by a customer's registered email address. |
| **Customer Phone Number** | Filter by a customer's mobile number. |
| **Order ID** | Filter by the order ID associated with a cashback or reward. |
| **Refund ID** | Filter activities related to refunds that triggered a point refund. |
| **Points Status** | Filter based on the status of points: active, pending, blocked, or expired. |
| **Manual Actions** | View only manually triggered activities, such as manual rewards or adjustments. |
| **Activity** | Filter by specific activity types (e.g., Points Expiry, Campaign Rewarded). |
| **Points** | Filter by points value earned, redeemed, deducted, or refunded. |
| **Coupon** | Search activities linked to a specific coupon code or type. |
| **Merchant Name** | Filter by merchant in multi-merchant setups, if applicable. |
| **Branch Name** | Filter by branch name under a merchant, if applicable. |
| **Customer Tier** | Filter activities based on the customer's VIP tier at the time of the activity. |
| **Reward Campaign Name** | Filter by the name of a completed reward campaign. |
| **Reward Campaign Type** | Filter by the type of campaign completed (e.g., Spin the Wheel, Cashback, Tier-based). |
### Export the Activities Log
Apply any filters you need.
Click the **Extract** button in the top right corner.
Your filtered activities will be exported to a CSV file.
Read more about this through [Export Your Customer Activities Log](/product-documentation/understanding-your-customers/your-customers/export-customer-activities-log).
***
## Rewarded Coupons Log
**If you're using Gameball's couponing engine**, a separate log for **rewarded coupons** generated through the Gameball couponing engine is now available in the same section.
This log provides a clear view of coupon distribution, redemption rates, and overall coupon-related activity for each customer.
You can also filter this section with: creation date, customer ID, coupon usage, coupon usage limit, source, amount, and status.
***
## Why Use the Customer Activity Log?
Monitor customer engagement and reward activity across your loyalty program.
Identify trends in customer behavior to tailor your loyalty program more effectively.
Ensure that rewards, points, and tier statuses are accurately tracked for all customers.
Gain insights into the effectiveness of your campaigns, including how and when rewarded coupons are being utilized.
***
## Related Articles
View and manage individual customer data.
Use tags to group and target customers.
# How Do I Export Customer Activities Log?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/export-customer-activities-log
Learn how to export customer activities from the Gameball dashboard, what fields are included, and how to interpret them.
Gameball allows you to export detailed activity logs for all your customers through the **Customers > Activities** tab. This export helps you analyze behaviors, rewards, redemptions, and more.
You can filter the activity log before exporting or extract a filtered segment for specific needs.
Extracted reports (Activity Logs, Outbound, and Automation) now require you to be authenticated to the dashboard — a report link alone is no longer enough to download it.
***
## Step-by-Step Instructions
Go to **Customers > Activities** in your Gameball dashboard.
Apply filters if you'd like to export a specific activity segment.
Click the **Extract** button in the top right.
Your filtered customer activity list will be downloaded as a CSV file.
***
## Exported Fields and Their Descriptions
Below is a list of all columns included in the exported customer activities file, along with what each field means:
| Column Header | Description | Remarks |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Type** | The main classification of the logged activity (e.g., Points Redeemed, Cashback Rewarded). | Refer to the [Customer Activity Log](/product-documentation/understanding-your-customers/your-customers/customer-activity-log) article for all activity types. |
| **Activity ID** | Unique identifier generated by Gameball for each activity log. | Useful for referencing in support or audits. |
| **Week Day** | Day of the week when the activity occurred (e.g., Monday, Thursday). | Derived from activity timestamp. |
| **Activity Date** | Calendar date of the activity. | Format: YYYY-MM-DD |
| **Activity Time** | Time the activity occurred. | Format: HH:MM:SS |
| **Player Unique ID** | The Gameball customer ID. | Same as the customer ID in other exports. |
| **Email** | Customer's registered email address. | May be blank for guest customers. |
| **Phone Number** | Customer's mobile number, if available. | Depends on platform data. |
| **Player Display Name** | Full name or nickname associated with the customer. | Comes from the platform or profile attributes. |
| **Transaction ID (on client)** | Transaction ID passed from your system for reference. | Only available for activities tied to a transaction (e.g., orders). |
| **Activity Type (Manual or not)** | Indicates whether the activity was triggered manually or automatically. | **Manual** = performed by an admin or via bulk action. |
| **Points** | The number of points added, deducted, or refunded. | Can be positive (earned) or negative. |
| **Reason** | The reason added by the admin while adjusting the customer balance manually. | |
| **Calculated Redemption** | Total points that should have been redeemed based on reward rules. | Based on reward configuration. |
| **Actual Redemption** | Actual redeemed points from the customer. | May differ from calculated due to fractions. |
| **Family Redemption Amount** | Combined redemption value across family accounts. | Applies if the account [family wallet](/product-documentation/admin-settings/gameball-family-wallet) is enabled. |
| **Family Redemption Points** | Combined redeemed points across family accounts. | Applies if the account [family wallet](/product-documentation/admin-settings/gameball-family-wallet) is enabled. |
| **Paid Amount** | Net amount paid by the customer in this activity. | Relevant for cashback or discount-based actions. |
| **Outstanding Points** | In case of expiry, this field indicates exactly how many points to deduct while expiring this activity. For example, if this activity was 100 points and the customer redeemed only 60, the system will expire only 40 points. | |
| **Reward Threshold** | The minimum spend amount required to trigger the reward points calculation and receive the reward factor based on it. | See [Earn Points Configuration](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system). |
| **Reward Factor** | The number of points earned per unit-of-currency based on the configured reward threshold. | See [Earn Points Configuration](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system). |
| **Currency** | Currency in which the transaction occurred. | E.g., USD, SAR, EGP |
| **Redemption Factor** | Conversion rate of 1 point to currency used in this activity. | Example: if this value is 0.01, it means 1 point equals 0.01 USD upon redemption. |
| **Achieved Campaign** | Name of the campaign completed as part of the activity. | |
| **Achieved Level** | Name of the tier or level the customer reached. | |
| **Reward Points** | Number of points rewarded during the activity. | |
| **Campaign Enabled** | Whether a points multiplier campaign was enabled and affected this activity at the time of this activity. | Values: True / False |
| **Is Guest** | Indicates if the customer was a guest at the time of the activity. | **True = guest**, may lack full profile data. |
| **Coupon Used** | Indicates if a coupon was used during this activity. | |
| **Coupon Type** | Type of coupon applied (e.g., Percentage, Fixed Amount, Free Product). | |
| **Coupon Code** | Code of the coupon redeemed. | Useful for tracing specific reward usage. |
| **Coupon Group** | The coupon group or campaign associated with this code. | Helps identify source configuration. |
| **Guest Player Email** | Email used by the guest customer in case it was added through a popup campaign or a game-based reward campaign targeting visitors. | |
| **Cashback %** | Cashback percentage rewarded to the customer. For example, a customer gets 1 point for every 1 USD spent. Upon redemption, 1 point equals 0.01 USD. The cashback % in this case will be 1%. | |
| **Merchant ID** | ID of the merchant if you're using a multi-merchant setup. | |
| **Merchant Name** | Name of the merchant associated with this activity. | |
| **Branch ID** | ID of the branch/store involved in the activity. | |
| **Branch Name** | Name of the store branch where the transaction occurred. | |
| **Free Product Name** | Name of the free product awarded (if part of the reward). | Applies to "Free Product" coupon type. |
| **Free Product ID** | Internal identifier for the free product awarded. | |
| **Product Variant Name** | Name of the variant (e.g., size or color) of the free product. | |
| **Activity Actual Date** | The original date and time when the activity occurred, regardless of when it was sent to Gameball via Order API or batch processing. | |
| **Points Expiry Date** | Populated for any activity that includes earned points (e.g., orders, campaigns, referrals, or missions). | |
| **Channel Source** | The channel through which the order was placed (e.g., `pos`, `web`, `mobile`). | Salla merchants only. Empty for activities not linked to an order. |
| **Reference ID** | Salla's external order reference ID — the same ID visible in your Salla dashboard. Useful for reconciling loyalty transactions with Salla orders. | Salla merchants only. Empty for activities not linked to an order. |
***
## Related Articles
Track customer activities and understand activity types.
Access order and refund details from activity history.
View and manage individual customer profiles.
# How Do I Export My Customer List?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/export-your-customer-list
Learn how to export your customer data from the Gameball dashboard, what fields are included, and how to interpret them.
Gameball allows you to export your customer data directly from the **Customers** page. You can apply filters to narrow down the list before exporting, or export a broader dataset as needed.
If a filter is applied, the export will include **only the filtered customers** currently visible in the list.
***
## Step-by-Step Instructions
Go to the **Customers** page from the Gameball dashboard.
Apply filters if you'd like to export a specific segment.
Click **More** then choose **Extract**.
Your filtered customer list will be exported as a CSV file.
If you need a full export of your entire customer database (not limited by filters), please contact the Gameball support team.
***
## Exported Fields and Their Descriptions
Here's a description of all the columns included in your exported file:
| Column Header | Description | Comment |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **customer\_id** | The unique identifier of the customer in Gameball. | Required for all customer data updates. |
| **customer\_name** | The full name of the customer, if provided. | |
| **customer\_email** | The registered email of the customer. | |
| **gender** | The gender of the customer. | |
| **phone\_number** | Mobile phone number of the customer. | |
| **date\_of\_birth** | Date of birth of the customer. | |
| **join\_date** | Date the customer joined your platform. | |
| **creation\_date** | Date the customer profile was created in Gameball. | |
| **country** | Country from which the customer registered. | |
| **city** | Customer's city. | |
| **zip\_code** | Postal or ZIP code. | |
| **preferred\_language** | Customer's preferred communication language. | |
| **is\_guest** | Indicates if the customer is a guest. | **True = guest**, meaning the user has not created a full account. |
| **utm\_source, utm\_medium, utm\_campaign, utm\_content, utm\_term** | Tracks how the customer first landed on your site. | Comma-separated. |
| **device** | The device type used during the customer's session. | |
| **total\_amount\_spent** | Total value of transactions made by the customer. | This field is based on the configured [Tiering-up Method](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods). |
| **last\_order\_date** | The date the customer placed their most recent order. | |
| **total\_orders\_count** | Number of orders the customer has placed. | |
| **avg\_order\_value** | Average spend per order. | |
| **channel** | Source channel where the customer was acquired (e.g., website, mobile app). | |
| **current\_tier\_name** | The name of the customer's current VIP tier. | |
| **current\_tier\_order** | The internal order of the customer's current tier. | |
| **score** | Used only if your tiering-up method is score-based. | |
| **total\_points\_earned** | All points the customer has earned historically. | |
| **points** | The current total of active, redeemable points. | Pending points are excluded. |
| **pending\_points** | Points that are not yet redeemable due to the return window or pending state. | |
| **total\_referrals** | Number of successful referrals by the customer. | |
| **total\_redemptions** | Number of rewards redeemed. | |
| **last\_redemption\_date** | Date the customer last redeemed a reward. | |
| **last\_login\_date** | Last time the customer logged into your platform. | |
| **last\_coupon\_usage** | Date the customer last used any coupon. | |
| **last\_gameball\_coupon\_usage** | Date of last coupon issued through Gameball. | |
| **last\_message\_sent\_date** | Date of the last in-app message sent to this customer. | |
| **last\_email\_sent\_date** | Date of the last email sent via Gameball. | |
| **segments** | List of segments the customer belongs to. | Includes both rule-based and RFM segments. |
| **Tags** | Each exported row displays all tags associated with the corresponding customer. | Supports multiple tags per customer (comma-separated). |
| **program\_status** | Whether the customer is included in or excluded from the loyalty program. | Values: **Included** or **Excluded**. Reflects the include/exclude toggle on the customer's profile. See [Include or Exclude Customers](/product-documentation/guides-strategies-faqs/supportive-guides/include-exclude-customers). |
You can read more about all customer attributes included in the extracted file through the [Customer Profile Attributes](/product-documentation/understanding-your-customers/customer-profile/customer-profile-attributes) article. This also explains how each attribute is added, captured, or calculated by Gameball.
***
## Related Articles
Learn about all customer attributes and how they are populated.
View and manage your full customer list.
Migrate customers from other loyalty programs.
Use tags to manually group and target customers.
# How Do I Manage My Customer List?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/manage-your-customer-list
Learn how to view, filter, and perform actions on your customer list in the Gameball dashboard.
You can access your **Customers** tab through the **Gameball Admin Dashboard**.
***
## Customer List Overview
Once you access the **Customers** tab on your Gameball dashboard, you will see a list of all customers along with key profile attributes that help you better understand and manage each customer's engagement level.
### Understand the Columns in the Customer List
| Column | Description |
| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Creation Date** | The date and time the customer profile was created in Gameball. |
| **Customer** | Displays the customer's full name and their unique Gameball ID. |
| **Customer Email** | The registered email address associated with the customer. |
| **VIP Tier** | The current tier of the customer based on your configured loyalty program. This includes both the tier order and tier name. |
| **Score / Total Amount Spent / Total Points Earned** | This column varies depending on your configured tiering-up method: if based on **Score**, this shows the current score; if based on **Amount Spent**, it shows cumulative spend; if based on **Points**, it shows the total points earned. You can learn more about the [Tiering-up methods](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods). |
| **Points Balance** | Displays two types of points: **Active Points** (redeemable points currently available) and **Pending Points** (non-redeemable points awaiting the completion of the configured return window). Learn more about [Pending Points and Return Window](/product-documentation/programs/loyalty-points-earn/launch-and-configure-your-earn-pointing-system). |
| **Guest Tag** | Indicates that the customer placed an order as a guest and has not yet created an account on your platform. This tag is automatically displayed if the customer's status is identified as a guest. The [guest customers](/product-documentation/guides-strategies-faqs/supportive-guides/integrate-guest-customers) feature is available by default in Shopify or through custom integration with Gameball. |
| **Tags and Segments** | Lists any tags manually added to the customer, and the segments they belong to, based on dynamic rules or RFM logic. |
### Actions Available on Each Row
Each customer in the list has a quick action menu that allows you to perform individual updates or actions directly from the list view. Here are the available actions:
| Action | Description | Availability |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| **View Customer** | Opens the detailed customer profile page, where you can review full data, points history, events, and more. | All platforms |
| **Adjust Tier** | Manually update the customer's VIP tier. This allows you to override the default tiering logic when needed. | All platforms |
| **Adjust Balance** | Manually add or deduct points from the customer's current balance. | All platforms |
| **Reward a Campaign Manually** | Manually reward a customer with a configured campaign. Useful for ad-hoc or support-related rewards. | All platforms |
| **Shopify Page** | Opens the customer's profile directly within your Shopify admin. | Shopify only |
| **Delete** | Permanently deletes the customer profile from Gameball. This option is **not available for Shopify or Salla integrations**. | Non-platform clients only |
***
## Customers Page-Level Actions
This section covers how to filter your customer list and how to apply single actions and bulk actions to one or more selected customers.
### Apply Filters to Refine the View
You can use filters to narrow down the customer list based on specific attributes or behavioral data. Multiple filters can be applied at the same time for more advanced segmentation.
Click the **Filter** icon at the top of the Customers page.
Select from the available filter options listed below.
Define your criteria (e.g., ranges, keywords, status).
Click **Apply Filter** to view only the customers matching your selected criteria.
#### Available Filters
| Filter | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------- |
| **Creation Date** | Filter by the date the customer was added to Gameball. |
| **Customer Type** | Filter between registered users and guests. |
| **Customer ID** | Search for a specific customer using their unique ID. |
| **Customer Name** | Search by full name. |
| **Customer Email** | Filter by email address. |
| **Customer Phone Number** | Filter by mobile number. |
| **Total Amount Spent** | Filter customers based on how much they've spent in total (or based on your configured tiering-up method). |
| **Points** | Filter by current total points. |
| **Pending Points** | Filter customers based on points currently in a pending state. |
| **Included** | Filter by inclusion or exclusion from your loyalty program. |
| **Tags** | Filter by one or more tags applied to customers. |
| **Segments** | Filter based on the customer's assigned dynamic segments. |
| **RFM Segments** | Filter by customers' RFM segments. |
| **Tier** | Filter by current VIP tier. |
All applied filters will remain active until you manually reset or remove them. The customer list and any bulk actions will reflect only the filtered results.
### Perform Bulk Actions
You can apply actions to multiple customers simultaneously. This is useful when managing a filtered segment or performing large-scale updates.
If a filter is applied, bulk actions will be applied **only to the filtered customers** currently visible in the list.
#### Available Bulk Actions
| Action | Description |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Reward a Campaign** | Manually assign a configured reward campaign to all selected customers. This is useful for delivering one-time rewards or campaign incentives in bulk instead of waiting for the customer to accomplish the reward campaign rules. |
| **Add/Deduct Points** | Directly adjust the points balance of selected customers by adding or deducting points. Useful for corrections or manual point rewards. |
| **Tag Filtered Customers** | Apply one or more tags to the selected customers for future targeting or segmentation. |
| **Include/Exclude Customers** | Bulk include or exclude selected customers from your Gameball loyalty program. |
| **Update Customers** | Update customer data in bulk via CSV. Labeled **"Update Customers"** on Shopify/Salla to update existing customer data. Labeled **"Update/Migrate Customers"** on non-platform integrations to support customer migration and updates. Customer creation and deletion are not allowed through Gameball for Shopify or Salla users -- these operations must be handled through the platform, and Gameball will sync automatically. |
| **Extract** | Export the filtered customer list to a CSV file, including detailed fields beyond those shown on screen. Read more about this through [Export Your Customer List](/product-documentation/understanding-your-customers/your-customers/export-your-customer-list). |
1. You cannot delete customers in bulk.
2. There are some other bulk actions you can apply using the [batch creation API](/api-reference/batches/batch-creation).
***
## Related Articles
Export your customer data to a CSV file with detailed fields.
Track all customer transactions and activities.
Use tags to manually group and target customers.
View and manage individual customer data.
# How Do I Migrate My Customers to Gameball From Other Loyalty Programs on Shopify?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/migrate-your-customers-to-gameball-from-other-loyalty-programs-on-shopify
Learn how to easily migrate customers to Gameball from other loyalty programs like Growave, Yotpo, LoyaltyLion, Stamped, Smile.io.
Thank you for deciding to switch to Gameball for your rewards program! To migrate your customers from any other loyalty program to Gameball, all you need is to go through some easy, quick steps. Check out this video, or follow the steps below.
***
## Step 1: Export Old Rewards Program Data
All you need to do is head to your current rewards program and ask for your customers' export files.
Pause your current loyalty program on the old platform, and follow the next step to complete the migration process.
***
## Step 2: Migrate to Gameball
From **Gameball Admin Dashboard**, go to **Customers > Customers Section > More > Update Customers**.
Choose the former loyalty program from the following list:
* Growave
* Yotpo
* LoyaltyLion
* Stamped
* Smile.io
If the former loyalty engine you were using is not in the list or you are not a Shopify user, choose **CSV** and follow [the steps here](/product-documentation/understanding-your-customers/your-customers/import-customers-using-csv).
Click on **"Click to upload."**
Choose the downloaded CSV file and click **Open**.
Once the file is read by Gameball, click **Continue.**
In order for Gameball to correctly place the customers' data into their corresponding attributes, you will have to map the CSV file headers with Gameball's requested attributes.
For example: if the CSV file has a column titled "Email address," then select this header under **Your File Attribute**, right beside **"Customer Email."** This way Gameball will understand that data under the "Email Address" column should be placed in the **Customer Email** attribute and so on.
The only mandatory data/customer attribute is the **Customer Identifier** which could be placed with the email address if no unique ID/number is assigned to each customer.
Choose the Tiering-up Recalculation Method by clicking on the **Edit Icon** under **"Tier Name"**.
Choose between:
* Customers will be re-evaluated with the next recalculation cycle based on your tier expiry configuration.
* Customers are placed into this tier forever with no later evaluation.
* Customers are placed into this tier till a specific date.
If you are adding the customers' birth dates, choose date format under **Date of Birth** and choose the format that matches the one in the CSV file.
Choose between:
* YYYY-MM-DD
* MM-DD-YYYY
* DD-MM-YYYY
* YYYY/MM/DD
* DD/MM/YYYY
* MM/DD/YYYY
Click **Import**.
If the CSV file you uploaded has unmatching data that doesn't comply with the original format, Gameball will show you the errors that need to be fixed for a successful migration.
If there are more than 10 errors in the file, you will need to **download** the error sheet to check all your errors, as you will not see all the errors on the reviewing page.
After fixing all the errors on the sheet, click **re-upload**.
If you find that the addressed errors will not cause a problem, click **Submit**.
If you have fixed all your errors, you can submit your file.
You will then be redirected to the Customers page, where you will find the list of the new customers added, as well as a sheet of all the existing errors to be downloaded.
An email will be sent with the errors sheet to the admin account's registered email.
The migration/customer update process is now over, and the new customers are now part of your Gameball loyalty program.
**Important notes:**
* If you are a Shopify user, you can only update the information of existing customers from your customer list that was automatically migrated to Gameball during the integration process. As for non-Shopify users, by following this process, you will be able to migrate your customers or update the information of existing ones.
* In the case of updating the data of an existing customer, any value in the migration sheet overrides what exists in the system. For example: if the customer has 300 points in the system and the sheet value for the same customer is 100, the customer's balance will be 100 after the successful migration. If the customer has 0 points on the sheet, the customer's balance will be 0 after migration. If the points cell is empty, the customer balance will remain 300.
***
## How to Migrate Guests (Customers Who Are Not Registered)
When migrating your customers from other loyalty programs or through a CSV file, some of the customers' data might not be registered. If you still want these customers to be part of your loyalty program, you will have to enable guest customers to integrate them with your loyalty program. [Learn how to integrate your guest customers into your rewards program](/product-documentation/guides-strategies-faqs/supportive-guides/integrate-guest-customers).
***
## How to Extract Your Current Customer Data
Go to your **Customers section** on **Gameball Admin Dashboard**.
On the top right of the page, click **More**, then **Extract**.
***
## What Else?
Learn more about your customer's data.
Common customer update/migration errors and how to fix them.
Import your customers from other loyalty programs using a CSV file.
# How Do I Update My Existing Customer Data in Bulk Using CSV?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/update-customer-data-in-bulk
Learn how to update your existing customers' points, tiers, and attributes in bulk by uploading a CSV file through the Gameball dashboard.
Use the bulk update flow to modify existing customer data — such as points balances, tier assignments, or profile attributes — across multiple customers at once using a CSV file.
***
## Step 1: Go to the Updating Page
From the **Gameball Admin Dashboard**, navigate to **Customers > Customers Section > More > Update Customers**.
***
## Step 2: Pick What to Update
Choose what you want to update for your customers:
Update customers' points balances.
Assign or change customers' VIP tier levels.
Update profile attributes such as tags, birthday, or email subscription status.
If you need to update more than one element (for example, points and tiers), you can do them separately by repeating the process for each.
***
## Step 3: Upload Your Customer File
Select your CSV file and click **Open**. Once Gameball reads the file, click **Continue**.
***
## Step 4: Map Your Attributes
Match the column headers in your CSV to the corresponding Gameball fields.
The only mandatory field is the **Customer Identifier** — this can be the customer's unique ID or email address.
**For tier updates**, choose the Tiering-up Recalculation Method by clicking the **Edit Icon** under **Tier Name**:
| Option | Description |
| ------------------------------ | --------------------------------------------------------------------------------------------------- |
| **Re-evaluate on next cycle** | Customers are re-evaluated at the next recalculation cycle based on your tier expiry configuration. |
| **Place in tier forever** | Customers are placed into this tier permanently with no further evaluation. |
| **Place in tier until a date** | Customers are placed into this tier until a specific date. |
**For birthday updates**, select the date format under **Date of Birth** that matches the format in your CSV file.
Supported formats: `YYYY-MM-DD`, `MM-DD-YYYY`, `DD-MM-YYYY`, `YYYY/MM/DD`, `DD/MM/YYYY`, `MM/DD/YYYY`
***
## Step 5: Review Errors
If any rows in your file contain data that doesn't match the expected format, Gameball will display the errors before submission.
If there are more than 10 errors, you will need to **download** the error sheet to see all issues — not all errors are shown on screen at once.
After fixing errors, click **Re-upload**. If the remaining errors are acceptable, click **Submit**.
***
## Step 6: Submit the File
Once submitted, you are redirected to the Customers page, where updated records are reflected. An error report is sent to the admin account's registered email.
Any value in the update sheet **overrides** what exists in the system for that customer. For example, if a customer has 300 points and the sheet says 100, their balance becomes 100. If the cell is empty, the existing value is preserved. If the cell contains 0, the value becomes 0.
***
## How to Extract Your Current Customer Data Before Updating
Navigate to your **Customers** section on the Gameball Admin Dashboard.
Click **More**, then **Extract** to download your current customer data as a CSV.
***
## Related Articles
Migrate customers from other loyalty programs into Gameball using a CSV file.
Troubleshoot errors that may occur during the customer update process.
# How Do I View Order Details from Activity Logs?
Source: https://docs.gameball.co/product-documentation/understanding-your-customers/your-customers/view-order-details-from-activity-logs
Learn how to access complete order and refund details directly from your customer's activity history.
Gameball allows you to track all order-related interactions through the **Customers Activities** tab. When a customer completes a transaction, redeems a cashback, or receives a refund, Gameball logs the event and links it to the associated order.
***
## Accessing Order Details
When an activity is linked to an order (e.g., cashback reward or refund), the **order ID** will appear as a clickable value directly within the activity log.
Go to **Customers > Activities**.
Locate any activity associated with an order (e.g., **Cashback Rewarded**, **Points Refunded**).
Click the **order ID** shown on the second line of the activity. This will open a side tab with full order details.
***
## What You'll See in the Order Details
The order details side panel includes:
* **Order ID** and **Order Date**
* **Merchant Name** and **Branch Name**
* **Points Redeemed** or **Points Earned** through this order
* **Total Paid**, **Total Price**, and **Payment Method**
A breakdown of all **products** in the order, including:
* Name & ID
* Quantity, SKU, Category
* Price, Tax, and Discounts
* **Order Subtotals**: shipping, discount, and tax
Any custom key-value attributes sent in the order are shown in an **Extras** section. Empty fields are automatically hidden to keep the view clean.
Displays the channel the order was placed on: **Mobile**, **Web**, or **In-store**.
Displays the Gameball-generated coupon code that was redeemed on this order. Gameball automatically links each redeemed coupon session back to its order, so you can see exactly which coupon drove each transaction directly from the activity log.
For Shopify merchants, the order reference number (e.g., #1307) is stored as a `referenceId` on every transaction, making it easy to cross-reference orders between Shopify admin and Gameball activity logs. The field also appears as a dedicated column in exported reports.
***
## Viewing Refund Details
If the activity is related to a refund (e.g., **Points Refunded**):
Click the **refund ID** shown in the log.
You will be directed to a **Refund Details** panel. This panel includes:
* **Refund ID** and **Refund Date**
* **Merchant** and **Branch**
* **Points Refunded**
* A **View Order Details** button that links back to the original order.
This allows you to connect refund activity back to the original transaction for full context.
***
## Important Notes
* Clicking an **Order ID** opens the original transaction summary.
* Clicking a **Refund ID** shows the refund panel, including a link to the associated order.
* This feature is useful for support agents reviewing customer concerns related to rewards, cashback, or balance changes.
***
## Related Articles
Track customer activities and export logs.
View and manage individual customer profiles.
# How Do I Configure Gameball Currency Settings?
Source: https://docs.gameball.co/product-documentation/admin-settings/configure-currency-settings
Match between your platform currency and Gameball currency.
## Plan Availability
**All Gameball customers**
***
## Configure Gameball Currency Settings
You can access the **Currency** settings section in **Gameball Admin Dashboard** through **Settings > Admin Settings > General > Currency Section**
Inside the Currency section you will find an option where you can change how the currency appears on Gameball's Widget to be as a symbol.
The chosen currency will be applied to all currency fields in the system:
Total Rewarded Points Equivalence shown in your Earn Program.
Total Redeemed Points Equivalence shown in your Redeem Program.
Points value for redemption in the default redemption rule of Earn Configurations.
Points Equivalence displayed inside the Gameball Widget for customers.
***
## Related Articles
Match your platform timezone with Gameball data timestamps.
Configure customer profile attributes for deeper segmentation insights.
Change the language of your Gameball dashboard to your preferred locale.
# How Do I Configure Gameball Dashboard Language Settings?
Source: https://docs.gameball.co/product-documentation/admin-settings/configure-dashboard-language
Learn how to change the language of your Gameball dashboard.
## Plan Availability
| Platform | Support |
| ------------------- | ------------------------- |
| Shopify (All plans) | Supported (All languages) |
| Salla (All plans) | Supported (All languages) |
| Integration | Support |
| ------------------ | ------------------------- |
| Custom (All plans) | Supported (All languages) |
***
## Overview
Gameball currently supports nine languages on the dashboard to enable clients to use their local language while setting up their player experience. You can choose between the following languages:
Default dashboard language.
Full right-to-left support.
Complete French localization.
Full Japanese localization.
Complete Spanish localization.
Complete Italian localization.
Brazilian Portuguese localization.
European Portuguese localization.
Complete German localization.
***
## Changing the Dashboard Language
By default, your dashboard language is English (EN). You can easily change that by following these steps:
Access your account at the Gameball Admin Dashboard.
Go to **Settings** > **Admin Settings** > **General**.
In the **Admin Dashboard Language**, click on the **Edit** icon.
Choose your preferred language from the dropdown menu, then click **Save**.
Watch your dashboard change its previous language to the selected language.
We are currently working on localizing our dashboard to more languages. If you would like to suggest a new language, please email us at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Configure the language of the player-facing widget on your platform.
Match your platform timezone with Gameball data timestamps.
Match your platform currency with the Gameball currency display.
Configure customer profile attributes for deeper segmentation insights.
# How Do I Configure My Firebase Account for Mobile Push Notifications?
Source: https://docs.gameball.co/product-documentation/admin-settings/configure-firebase-push-notifications
Learn how to use Firebase for push notifications on your mobile app.
## Plan Availability
| Plan | Available |
| ---- | --------- |
| Pro | Yes |
| Guru | Yes |
| Plan | Available |
| ---------- | --------- |
| Growth | Yes |
| Enterprise | Yes |
| Plan | Available |
| ------------ | --------- |
| Pro (Silver) | Yes |
| Guru (Gold) | Yes |
***
## Overview
In today's mobile-centric world, delivering timely and relevant push notifications is crucial for engaging users and enhancing their app experience. Firebase, Google's powerful mobile and web application development platform, provides robust tools for managing push notifications.
This article walks you through the steps to configure your Firebase account for push notifications within the Gameball Admin Dashboard.
***
## Getting Started with Firebase Configuration
To ensure seamless integration and functionality for push notifications in your mobile app, follow these steps to set up Firebase:
Navigate to your Gameball Admin Dashboard > **Settings** > **Admin Settings**.
Locate the **Integration** section then go to **Mobile Integration**.
In the Account Integration page, scroll down to the Firebase Settings section. You will need to input the following information from your Firebase account:
This key is essential for sending messages to your app.
**Where to Find It:** Firebase Console > Your app > Project Settings > Cloud Messaging > Project credentials > Server key
This ID is used for both server keys and legacy server key tokens.
**Where to Find It:** Firebase Console > Your app > Project Settings > Cloud Messaging > Sender ID
This key is used for authentication and access to Firebase services.
**Where to Find It:** Firebase Console > Your app > Project settings > General > Web API Key
***
## Migrating from Legacy FCM APIs to HTTP v1
Firebase recently updated their messaging system, requiring a [migration from the legacy FCM APIs to the newer **HTTPv1 API**](https://firebase.google.com/docs/cloud-messaging/migrate-v1). With this update, there are important changes to the way information is sent from Gameball to Firebase, particularly in how the data object is structured.
### Key Changes
With the new HTTPv1 API, any extra information that needs to be sent for notifications must be included in a **data object**.
* **Before (FCM API)**: The data object was formatted as a standard **JSON**.
* **After (HTTPv1 API)**: The data object must now be sent as **Key Value Pairs of String**, which needs to be parsed by you.
Here's a comparison of the data structure before and after the update:
**Before (FCM API format):**
```json theme={null}
{
"to": "/topics/news",
"notification": {
"title": "Breaking News",
"body": "Check out the Top Story.",
"click_action": "TOP_STORY_ACTIVITY"
},
"data": {
"story_id": "story_12345"
}
}
```
**After (HTTPv1 API format):**
```json theme={null}
{
"message": {
"notification": {
"title": "Breaking News",
"body": "New news story available."
},
"data": {
"isGb": "true"
},
"android": {
"notification": {
"click_action": "CLICK_ACTION"
}
},
"apns": {
"payload": {
"aps": {
"category": "CLICK_ACTION"
}
}
}
}
}
```
As seen in the "After" section, the `data` object is now sent as a **Key Value Pairs of String**, meaning the data values should be properly stringified.
```kotlin theme={null}
val isGB = message.data["isGB"].toBoolean()
val isGB = message.data["isGB"] as Boolean
```
If you need to send additional information along with the notification from Gameball, ensure that the data is converted to a JSON string before it is passed to Firebase. Failing to do so may result in errors or failed notifications.
With Firebase configured, you're ready to enhance user engagement through push notifications. The next step is to set up Firebase for mobile friends referral links in Gameball. This will allow you to leverage push notifications for referrals, driving growth and user acquisition.
***
## Related Articles
Configure your Firebase account on Gameball for mobile friends referral links.
Step-by-step guide to migrate your FCM configuration to the new HTTP v1 API.
# How Do I Configure Gameball Time Zone Settings?
Source: https://docs.gameball.co/product-documentation/admin-settings/configure-time-zone
Match between your platform timezone and Gameball data timezone.
## Plan Availability
**All Gameball customers**
***
## Configure Gameball Time Zone Settings
You can access the **Time zone** settings section in **Gameball Admin Dashboard** through **Settings > Admin Settings > General > Time zone Section**.
The time zone will be applied to all dates across the system:
All date-based analytics and reporting reflect the configured time zone.
Customer join dates are recorded using the configured time zone.
Achievement timestamps are aligned with your selected time zone.
All points earning and redemption events are timestamped in your time zone.
Setting the correct time zone is essential to ensure your reports and activity logs reflect accurate timestamps.
Gameball automatically adjusts for Daylight Saving Time (DST). When a country changes its clocks, timezone offsets update accordingly — campaign schedules, expiry times, and event timestamps remain accurate for merchants in DST-observing regions.
***
## Related Articles
Match your platform currency with the Gameball currency display.
Configure customer profile attributes for deeper segmentation insights.
Change the language of your Gameball dashboard to your preferred locale.
# How Do I Create and Send Events to Gameball?
Source: https://docs.gameball.co/product-documentation/admin-settings/create-and-send-events
Configure and add the events you send to Gameball automatically through your Admin Settings.
## Plan Availability
| Platform | Plan |
| -------- | ---- |
| Shopify | Guru |
| Salla | Guru |
| Integration | Plan |
| ----------- | ---- |
| Custom | All |
***
## Overview
Events are the actions performed by your customers on your platform. Your platform should fire signals to Gameball when important events occur. In other words, Gameball should be notified when customers perform certain actions or sequences of actions on your platform. [Learn more](/api-reference/events/send-events)
To configure these events on the **Gameball dashboard**, go to **Settings > Admin Settings > Integrations: Events**.
On the events page, you can find all events sent to Gameball and their details.
***
## Adding Events
Once an event is sent from your platform to Gameball, it automatically appears on the events page. You can edit or delete the event as long as it is not linked to any Gameball configurations. Once an event is linked to a campaign, you will not be able to edit it or delete it unless you unlink it.
You can configure and edit event details before linking an event on the Gameball dashboard. Here is a brief description of each field:
The event name as sent from your platform.
A relevant event name as chosen by you for display in the dashboard.
Includes two variables: the key name and the data type for the key.
***
## Enable and Disable Internal Events
You have the ability to **enable or disable the internal events** that Gameball automatically fires (such as `place_order`, `view_product`, `order_refunded`, `add_to_cart`, etc.).
### Why This Matters
This gives you **complete control** over the events you track and process, allowing you to:
* Eliminate unnecessary or duplicate events.
* Customize your tracking to fit your business logic.
* Decide which events should (or shouldn't) be fired to your system.
### Key Details
A dedicated settings page lists all auto-fired Gameball events with toggles to enable or disable them individually.
Changes apply in real time — once an event is disabled, it stops being fired immediately.
When disabled, the event will no longer be sent to your system or used in internal Gameball flows unless you manually fire it.
Only Admins, Workspace Owners, or Workspace Admins can control event toggles. If custom roles are enabled, this action is assignable.
***
## Remarks
The [event and rules](/product-documentation/understanding-your-customers/customer-profile/customer-events) stored for each event must be synced across your mobile and web integrations to provide your customers with a consistent experience.
You can only edit the display name for events linked to configurations on your Gameball dashboard. To make more changes, you must unlink your event from any configurations.
You can test the events your platform is sending to Gameball through the **Events Log**. [Read more on Events Log](/product-documentation/admin-settings/events-log)
***
## Related Articles
Learn how customer events are tracked and stored in Gameball.
Understand how the event-based rule engine works for challenges.
Monitor live events being sent from your platform to Gameball.
A step-by-step guide to configuring and using events on Shopify.
# How to Create a New User on Gameball Dashboard and Assign Roles?
Source: https://docs.gameball.co/product-documentation/admin-settings/create-user-assign-roles
Learn how to give different users access to your Gameball dashboard by creating multiple user accounts.
***
After setting up your loyalty program, you always need to make adjustments along the way. You can give access to as many people as you want to allow other employees to make the appropriate changes to your program.
***
## Creating a New User Account on Gameball Dashboard
Go to **Gameball dashboard** > **Settings** > **Admin Settings**, scroll down, and click **Accounts** under **Users**.
Click **Invite a teammate** on the top right of the page.
Complete the invitation form with the following fields:
* **User first name**
* **User last name**
* **User email**
* **User password** — create a password your teammate can use for their first login.
* **User Role** — choose the role to decide the level of authority this teammate should have over the dashboard.
* **User Workspace** — in case you have multiple workspaces, choose which of them your teammate should have access to. [Learn more](/product-documentation/admin-settings/creating-multiple-workspaces)
Users can change their password once they log in for the first time.
Click **Send invitation**. Once the invitation is sent, the teammate will receive an email with their credentials.
On the **Dashboard**, the user **Status will appear as Pending until they log in once**. The status will then change from **Pending** to **Active**.
***
## Choosing Roles
You can decide the level of access your invited teammate should have from the following roles:
This role gives full authority, allowing teammates to edit, configure, or even add new admins to the dashboard, including creating and managing all workspaces.
This role gives full authority allowing teammates to edit, configure, or even add new admins to the dashboard, except for creating new workspaces or accessing workspaces they are not given access to by the owner.
**Allowed Actions:**
* Access premium features (features with a crown icon)
* View and update the Gameball Program Status (from the top bar)
* View all customer details, including segmenting and achievements
* Manually adjust customer levels, and add/deduct points to customers' accounts
* Access detailed points transactions and view referral data
* Set and configure points-earning rules and redeeming settings for your loyalty program
* View, create, and manage automation (set conditions and triggers for customer actions)
* Send and test notifications (like emails or push notifications) and manage communication campaigns
* View and configure app integrations (add, update, or remove apps)
* Manage settings (including account settings and integrations)
* Configure the widget settings (like launcher branding, languages, and visibility on the website)
* Create workspaces
* Access reports and analytics related to customer activity and rewards
**Disabled/Hidden Actions:**
* Deleting workspaces (Admins cannot delete workspaces)
This role only allows the teammate to make a few changes related to **customers only**.
**Allowed Actions:**
* View the Gameball Status from the top bar
* Access and view basic customer details (including segments and points transactions)
* View points earning and redeem history
* View notifications and access communication campaigns (emails, messages)
* View settings for accounts and manage communication preferences
* Access reports for customer interactions and referrals (read-only)
**Disabled/Hidden Actions:**
* Premium features access is hidden (these features are restricted)
* Cannot update the Gameball Status
* Cannot adjust customer levels or manually adjust points
* Cannot create or manage automation
* Cannot modify or update any app integrations
* Restricted from changing any settings (e.g., time zone, account setup, widget configurations)
* Widget configuration options are hidden
* Essentially, all actions involving changes to configurations or updates are restricted
The above actions are applied manually only to a single customer. They cannot execute this action on a bulk of customers.
As for the rest of the dashboard, the customer support role does not allow them to make edits; however, they can view all dashboard sections and buttons **except for**: Analytics, Update/import button, Admin Settings, Billing page, removing Gameball, writing a review, and workspaces they are not assigned to.
This role only allows the teammate to make a few changes related to **customers only**.
**Allowed Actions:**
* View the Gameball Status from the top bar
* Access and view basic customer details (including segments and points transactions)
* View points earning and redeem history
* View notifications and access communication campaigns (emails, messages)
* View settings for accounts and manage communication preferences
**Disabled/Hidden Actions:**
* Premium features access is hidden (these features are restricted)
* Cannot update the Gameball Status
* Restricted from changing any settings (e.g., time zone, account setup, widget configurations)
* Widget configuration options are hidden
* All Campaigns are hidden
* Essentially, all actions involving changes to configurations or updates are restricted
The above actions are applied manually only to a single customer. They cannot execute this action on a bulk of customers.
As for the rest of the dashboard, the customer support role does not allow them to make edits; however, they can view all dashboard sections and buttons **except for**: Analytics, Update/import button, Admin Settings, Billing page, removing Gameball, writing a review, and workspaces they are not assigned to.
This role does not allow the user to execute any action on the dashboard. They can only view dashboard sections for information.
**Allowed Actions:**
* View the Gameball Status from the top bar
* View all customer details, points transactions, and referrals
* View notifications and communications campaigns to track customer interactions
* View automation and settings for general monitoring purposes (read-only)
* Access reports and dashboards for data analysis on customer activities
**Disabled/Hidden Actions:**
* Premium features access is hidden (these are restricted)
* Cannot update the Gameball Status
* Cannot adjust customer levels or manually modify points
* Cannot create or manage any automation
* Cannot edit any apps integrations or change any settings
* Widget configurations (e.g., branding, launcher settings) are hidden
* Essentially, all functionalities related to changing or modifying system settings are restricted
**Allowed Actions:**
* View the Gameball Status from the top bar
* Access all customer data, including points transactions and referral statistics (view-only)
* Access points earning and redeem history data for analysis
* View notifications and communications campaigns (e.g., email or push notifications sent to customers)
* View automation to monitor customer triggers and rules (but no editing allowed)
* Access reports for customer behavior, rewards data, and referrals
**Disabled/Hidden Actions:**
* Premium features access is hidden
* Cannot update the Gameball Status
* Cannot manually adjust customer levels or modify points
* Cannot create, edit, or manage automation
* Restricted from editing any settings or changing app integrations
* Widget configuration (launcher, languages) is hidden
* Any actions that allow making modifications to the platform are restricted
**Allowed Actions:**
* View the Gameball Status from the top bar
* Access all customer data, including points transactions and referral statistics (view-only)
* Add points to customers manually
* Access points earning and redeem history data for analysis
* View notifications and communications campaigns (e.g., email or push notifications sent to customers)
* View automation to monitor customer triggers and rules (but no editing allowed)
* Allowed to edit settings and change app integrations
* Access reports for customer behavior, rewards data, and referrals
**Disabled/Hidden Actions:**
* Premium features access is hidden
* Cannot update the Gameball Status
* Cannot manually adjust customer levels
* Cannot create, edit, or manage automation
* Widget configuration (launcher, languages) is disabled
* Any actions that allow making modifications to the platform are restricted
**Allowed Actions:**
* View the Gameball Status from the top bar
* Access all customer data, including points transactions and referral statistics
* Add points to customers manually
* Access points earning and redeem history data for analysis
* View and edit notifications and communications campaigns (e.g., email or push notifications sent to customers)
* View and edit automation to monitor customer triggers and rules
* View settings and change app integrations
* Access reports for customer behavior, rewards data, and referrals
**Disabled/Hidden Actions:**
* Premium features access is hidden
* Cannot update the Gameball Status
* Widget configuration (launcher, languages) is disabled
* Any actions that allow making modifications to the platform are restricted
***
## Customize Role
**Admins** can easily grant each user **precisely the permissions they need**, improving data security and operational control.
While inviting a new user, Admins can set permissions per dashboard section:
* **Hide**: Section hidden from the user.
* **Disabled**: The user can view but not edit it.
* **Allow**: User has full access (including create/delete, where applicable).
Permissions options are presented during invitation via toggles or radio buttons for each key section:
* Customers
* Campaigns
* Coupons
* Analytics
* Settings
* Notifications
* Integrations
* Billing
* And more…
Admins can modify any user's permissions later from the User Management page.
New users are granted **No Access** by default and must be explicitly assigned permissions.
***
## Changing Passwords
When the user signs in, they can change their password by navigating to the page, then next to your user email, click the **Three dots** icon, then **Reset Password**.
***
## Two-Factor Authentication (2FA)
Gameball supports two-factor authentication (2FA) for dashboard user accounts to add an extra layer of security at login.
Disabling 2FA is not a self-service action. If you need to disable 2FA for a user account, contact Gameball Support at [support@gameball.co](mailto:support@gameball.co) — this is handled manually on the backend.
***
## Editing, Deleting, and Resending Invitations
To execute any of these actions on another user account, your account must be under the **Admin** role.
Click on the **Three dots** icon next to the user you want to manage.
Choose between:
* **Resend Invitation** — only valid on pending accounts/users who have yet to sign in. The teammate will once again receive an email with their credentials.
* **Edit** — you can only change their **Role** and **Workspaces** they are allowed on.
* **Delete** — their account will be terminated, and they will no longer have access to the dashboard.
You cannot delete the account you are currently signed in to and using.
# How Do I Create Multiple Workspaces for Different Program Configurations?
Source: https://docs.gameball.co/product-documentation/admin-settings/creating-multiple-workspaces
Create a different workspace for every brand, branch, or platform in different country.
## Plan Availability
| Plan | Available |
| --------- | ------------ |
| All plans | Upon request |
| Platform | Available |
| -------- | ------------- |
| Shopify | Not available |
| Salla | Not available |
This feature is only available upon request on non-platforms only. Please get in touch with our customer support team. (Not available on Shopify and Salla.)
***
## Overview
Understanding how you would want to deploy entirely different loyalty and marketing programs for each platform, branch, or area your brand is in, we have created the **Workspaces** feature.
Workspaces allow you to create an entirely different program with different configurations and program calculations so that it suits customers who could be from different countries or accustomed to different loyalty systems in certain branches.
For example, if your brand is deployed in different countries, such as the US and Japan, you can create entirely different loyalty programs for each of the countries. This way, customers from the USA and Japan will each enjoy different rewards and communications.
When you create a new workspace under your account, you will be given access to an entirely new and clean dashboard that is awaiting your configurations and activation.
If your account has any user role other than **Owner**, you cannot create a new workspace. Please refer back to the account owner to create a new workspace. [Learn more](/product-documentation/admin-settings/create-user-assign-roles)
***
## How to Create a New Workspace
After contacting Gameball's support team and having this feature activated, you can create a new workspace by following these steps:
Go to **Gameball Dashboard**. Under the Gameball logo, you will find the workspace name you currently have. Click on the **current workspace name**, then select **Create new workspace**.
Type down the **name** for your new workspace and **choose your Channel**. Choose between:
* Web
* Android
* iOS
* React Native
* Retail
Click **Create**. You will be taken to a new dashboard with no data in it, so you can start creating your programs from scratch.
To navigate between workspaces, under the Gameball logo, you will find the name of the new workspace you have created. Click on it to see all workspaces, then choose the workspace you wish to access.
If your account has any user role other than **Owner**, then you will only see workspaces that you are given access to by the **Owner**. Other workspaces will be hidden. Please refer back to the owner to request access to other workspaces. [Learn more](/product-documentation/admin-settings/create-user-assign-roles)
You can copy configured campaigns as they are into different workspaces. [Learn more](/product-documentation/rewards-campaigns/reward-campaign-intro).
# What Is the Data Warehouse Ingestion Module?
Source: https://docs.gameball.co/product-documentation/admin-settings/data-warehouse-ingestion
Learn how the Data Warehouse (DWH) Ingestion Module enables you to automatically sync Gameball data with your own analytics and BI systems.
## Plan Availability
| Plan | Available |
| ---- | --------- |
| All | Yes |
| Plan | Available |
| ---- | --------- |
| All | Add-on |
| Plan | Available |
| ---- | --------- |
| All | Add-on |
***
## Overview
The **Data Warehouse Ingestion Module** allows you to push selected loyalty data directly into your own data warehouse. This enables you to combine Gameball data with data from other business systems and analyze everything in one centralized analytics environment.
This feature was designed primarily for you if you already rely on internal dashboards and BI tools (such as PowerBI, Metabase, or similar) for daily reporting and decision-making.
Instead of building and maintaining analytics separately inside each tool, businesses can centralize their data in a data warehouse and build unified dashboards across all systems.
***
## Why This Feature Exists
Most large organizations already store their operational data in a **data warehouse**, which acts as a single source of truth. Data from multiple systems—such as order management, inventory, CRM, and communication tools—is pushed into the warehouse and then consumed by analytics tools.
With the Data Warehouse Ingestion Module, Gameball becomes part of this ecosystem. You can now:
* Combine loyalty data with revenue, inventory, and customer communication data
* Build cross-system dashboards in one place
* Run advanced analysis without relying solely on Gameball's in-dashboard reports
***
## How You Typically Use It
A common setup looks like this:
| System | Data Pushed |
| -------------------------------------------- | ------------------------------- |
| Order / POS system (e.g. Microsoft Dynamics) | Revenue and order data |
| Inventory management system | Stock and product data |
| Customer engagement platform (e.g. Braze) | Communication and campaign data |
| Gameball | Loyalty and rewards data |
All of this data is stored in the **data warehouse**, and an analytics tool (such as PowerBI or Metabase) reads from it to create dashboards.
This allows you to answer questions like:
* How does revenue trend by loyalty tier?
* How many points were earned from completed orders?
* What is the distribution of customers across tiers?
* How do loyalty actions correlate with repeat purchases?
***
## Available Gameball Data Models
Gameball currently provides **four built-in data models** that can be pushed to a data warehouse. You can choose which models to enable during setup.
Contains customer-level loyalty data. Useful for segmentation, tier analysis, and customer-level reporting.
| Field | Description |
| -------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `customer_unique_id` | Customer identifier from the client's external system, used for integration and mapping |
| `display_name` | Customer's display name as shown in the loyalty program interface |
| `is_migrate` | Integer flag indicating if this customer was migrated from another system (1 = migrated, 0 = native) |
| `referred_by_unique_id` | Customer identifier of the person who referred this customer, if applicable |
| `referral_activation_date` | Date when the customer's referral was activated and confirmed |
| `is_referred_customer` | Integer flag indicating if this customer was referred by another customer (1 = referred, 0 = not referred) |
| `current_tier_name` | Current loyalty tier name the customer belongs to |
| `current_tier_order` | Current loyalty tier order the customer belongs to |
| `customer_points` | Current number of loyalty points the customer has available for use |
| `total_earned_points` | The lifetime amount of points that the customer have earned |
| `total_redeemed_points` | The lifetime amount of points that the customer have redeemed |
| `total_expired_points` | The lifetime amount of customer's points that have been expired |
| `customer_score` | Current customer score (frubies) value the customer has accumulated |
| `customer_pending_points` | Points that have been earned but not yet activated or confirmed for the customer |
| `tier_entry_date` | Date when the customer entered their current loyalty tier |
| `customer_type` | Customer lifecycle state: Registered (full customer profile) or Guest (limited profile) |
| `is_included` | Integer flag indicating if the customer is included in active program participation |
| `created_at` | Date when the customer record was created in the Gameball platform |
| `updated_at` | Date when the customer record was last updated |
| `is_deleted` | Indicates if this is a deleted row |
Represents all points and order-related movements. Use this model to analyze how points are earned and spent over time.
| Field | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------- |
| `gameball_transaction_id` | Unique identifier for the transaction |
| `transaction_id` | Unique identifier for the transaction in the client system |
| `customer_unique_id` | Identifier of the customer who did the transaction |
| `merchant_name` | The merchant name where this transaction happened |
| `branch_name` | The branch name where this transaction happened |
| `transaction_type` | The type of the transaction: cashback, redemption, expiry, etc. |
| `direction` | The direction of the points transaction: + or - |
| `tier_name` | The name of the tier the customer was on when this transaction happened |
| `tier_order` | The order of the tier the customer was on when this transaction happened |
| `points_amount` | The amount of points in the transaction |
| `points_used_amount` | The amount of points that has been used from this transaction (for positive transactions only) |
| `redemption_factor` | The factor used to calculate the value of points |
| `points_value` | The monetary value of the points at the time of the transaction |
| `transaction_status` | The status of the transaction: active or pending (for positive transactions only) |
| `points_expiry_date` | The date when the points will expire (for positive transactions only) |
| `created_at` | Timestamp when the transaction record was created in Gameball |
| `updated_at` | Timestamp when the transaction record was last updated in Gameball |
| `is_deleted` | Indicates if this is a deleted row |
Includes all loyalty events and campaign-related actions such as reward campaigns, referrals, and tier progressions. This data closely matches what is available in Gameball's activity logs and reports.
| Field | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `gameball_achievement_id` | Unique identifier for the achievement event |
| `customer_unique_id` | Identifier of the customer who earned the achievement |
| `achievement_type` | Broader grouping of the achievement type (e.g., Level, Campaign, Referral, Transaction, Manual) |
| `achievement_sub_type` | Detailed classification such as Level, Challenge, Milestone, Quest, Referral, Purchase Reward, Manual action |
| `campaign_name` | Identifier of the campaign associated with the achievement event |
| `is_coupon_rewarded` | Indicates whether a coupon was issued as part of the achievement |
| `current_tier_name` | Customer's current tier name at the time of achievement |
| `current_tier_order` | Customer's current tier order at the time of achievement |
| `achieved_tier_name` | The name of the tier reached by the customer if achievement type is related to tier progression |
| `achieved_tier_order` | The order of the tier reached by the customer if achievement type is related to tier progression |
| `achieved_points` | Number of points earned from this achievement event |
| `points_value` | Monetary equivalent of the achieved points in the client's currency |
| `achieved_score` | Score gained from this achievement (if the leveling method is based on score) |
| `created_at` | Timestamp when the achievement record was created in Gameball |
| `updated_at` | Timestamp when the achievement record was last updated in Gameball |
| `is_deleted` | Indicates if this is a deleted row |
Contains coupon assignment data with lifecycle status, discount amounts, and usage metrics. Supports reporting on reward redemption and coupon usage.
| Field | Description |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `gameball_unique_id` | Unique identifier for each coupon per customer per assignment |
| `coupon_code` | The actual coupon code that customers use to redeem the offer |
| `customer_unique_id` | Identifier of the customer who received this coupon assignment |
| `coupon_type` | Coupon discount mechanism: Fixed, Percentage, Free Shipping, Free Product, Store Credit, etc. |
| `coupon_source` | Source usage context: Online, POS, Permanent, Reward Campaign, or Automation |
| `coupon_sub_source` | Origin of the coupon creation: Campaign, Reaching a Tier, Referral, or Automation |
| `amount` | Discount amount — for fixed types this is the actual discount amount; for percentage types this is the percentage value |
| `total_paid_amount` | Total monetary value across all orders where this coupon was applied (only for used coupons) |
| `total_order_count` | Total number of orders where this coupon was applied (values > 1 indicate multiple uses if multi-use enabled) |
| `current_state` | Current lifecycle status: deleted, expired, used, or assigned (default) |
| `created_at` | Timestamp when the coupon was originally created |
| `updated_at` | Timestamp when the coupon was last updated |
| `is_deleted` | Indicates if this is a deleted row |
***
## Example Use Case
You may want to build a dashboard showing:
* Revenue from your order management system
* Points earned from those same orders (from Gameball)
By joining **order data** from your POS system with **transaction data** from Gameball inside the data warehouse, you can create a single dashboard that visualizes both revenue and loyalty performance together.
***
## How to Set Up the Integration
Go to **Admin Settings** in the Gameball dashboard, then navigate to **Data Warehouse Integration** and click **Set Up Connection**.
Choose your data warehouse provider (for example, Amazon Redshift), then click **Next**.
Enter the required account and connection details, then click **Next**.
Choose how often Gameball should push data:
* Daily
* Weekly
* Monthly
You will also define the exact time (for example, daily at midnight).
Higher frequencies come with higher costs.
Choose which Gameball data models you want to push: Members, Transactions, Achievements, or Coupons.
Once submitted, the request is sent to Gameball's technical team.
***
## What Happens After Submission
The connection is **not established automatically**.
| Stage | Detail |
| ------------------ | ------------------------------------------------------------------------ |
| Initial submission | Acts as a configuration and request flow |
| Technical setup | Gameball's technical team manually completes the integration |
| Connection live | Status changes to **Connected** |
| Ongoing pushes | Each scheduled push appears in the dashboard with its status and details |
After the connection is live, each scheduled data push (daily, weekly, or monthly) will appear in the dashboard with its status and details.
***
## Availability & Enablement
The Data Warehouse Ingestion Module is offered as an **add-on**.
The feature must be enabled on your account before use.
You should coordinate with your Customer Success Manager to start the implementation process.
# What Is the Events Log?
Source: https://docs.gameball.co/product-documentation/admin-settings/events-log
View the events you are sending to Gameball through the event log section on the Gameball dashboard.
## Platform Availability
| Feature | Available |
| ---------- | --------- |
| Events Log | All plans |
| Feature | Available |
| ---------- | --------- |
| Events Log | All plans |
| Feature | Available |
| ---------- | --------- |
| Events Log | All plans |
While integrating and setting up your Gameball experience, you can check your events log for the events your platform is sending to Gameball.
***
## Accessing the Events Log
On your Gameball dashboard, go to **Settings > Admin Settings > Events**. On the top right of the events page, click on **Events Logs**.
A small popup window opens where you can instantly see all live events your platform is sending to Gameball.
In the **Event Logs** window, you can find the following commands:
Refreshes connection in case of a connection error.
Copies all events shown in the window.
Clears your events log history.
***
## Connection Status
The **ACTIVE** or **INACTIVE** alert shows the status of your connection. Click **Reconnect** to refresh your connection when set to **INACTIVE**.
Check [Six Events you can Create on your E-Commerce Website](/product-documentation/guides-strategies-faqs/supportive-guides/ecommerce-events) to learn more about the events recommended for integration by Gameball.
***
## Related Articles
Understand the events associated with your customers' activity.
Learn how the event rule engine powers challenge-based rewards.
A practical guide to configuring and using events on Shopify.
# What Is the Gameball Family Wallet?
Source: https://docs.gameball.co/product-documentation/admin-settings/gameball-family-wallet
Learn how the Family Wallet lets customers pool loyalty points with family members or groups to earn and redeem rewards together.
| Platform | Plan |
| -------------------- | ------------------------------------------------------ |
| Shopify | Add-on (Contact [Support](mailto:support@gameball.co)) |
| Salla | Add-on (Contact [Support](mailto:support@gameball.co)) |
| Non-platform Clients | Add-on (Contact [Support](mailto:support@gameball.co)) |
**Gameball's Family Wallet** allows customers to link their loyalty accounts with family members or a group, combining all earned points into a single shared wallet. Everyone contributes to the same balance and any member can redeem from it — making it easier for groups to reach rewards faster.
***
## How It Works for Customers
The Family Wallet guides customers through three steps: copy their invite link, share it with a family member, and start earning rewards together.
The Family Wallet is accessible from the Gameball widget. Customers find it on their profile home screen alongside their points balance, tier progress, and referral section.
When a customer shares their invite link, the invited member lands on an acceptance page where they enter their email or mobile number and click **Accept Invitation**.
Once confirmed, they see a success screen letting them know they have joined the Family Wallet.
Each invite link can only be used by one person. A new link is generated automatically after each use.
***
## Family Wallet Roles
Every Family Wallet has two types of participants:
| Role | Permissions |
| ------------------------- | ----------------------------------------------------------------------------------------- |
| **Parent (Family Owner)** | Invites members, removes members, deletes the wallet, views full combined points history |
| **Member** | Earns and redeems from the shared wallet, views own points history, can leave at any time |
There is always one Parent per Family Wallet — the customer who created it. From your Gameball dashboard, you can transfer the Parent role to a different customer at any time.
***
## Earning, Redeeming, and Viewing Points
**Earning** — Points earned by the Parent and all members across all Gameball programs and modules are combined into the shared wallet. Groups accumulate points faster than they would individually.
**Redeeming** — Both the Parent and members can redeem from the combined wallet at any time, with no approval required from other members.
**Viewing the wallet** — Each member can see their individual points alongside the combined family balance. The Parent sees the full activity history; members see only their own.
Members can leave the Family Wallet at any time by tapping **Leave** on the My Family screen.
***
## Enabling the Family Wallet
The Family Wallet is an add-on feature. Once purchased, you can enable it from your dashboard:
In your Gameball dashboard, navigate to **Settings**.
Under **Customers**, locate the **Family Wallet** option.
Click the toggle to enable Family Wallet for your customers.
Once enabled, customers can create and join Family Wallets directly from the widget.
***
## Monitoring Family Wallets on Your Dashboard
From any customer profile in your Gameball dashboard, you can see that customer's Family Wallet details — including total family points, the number of members, and each member's role.
***
## Important Notes
**Maximum size:** A Family Wallet can have a maximum of 10 members, including the Parent.
**Parent account deletion:** If the Parent's account is deleted, the entire Family Wallet is deleted. All members revert to standard individual accounts and their points are no longer pooled.
**Changing the Parent:** If you need to transfer ownership to a different customer, a dashboard admin can make that change directly from the customer profile.
***
## Common Questions
No. Each customer can belong to only one Family Wallet at a time, either as a Parent or as a Member.
The member's account reverts to an individual account. Points they earned while in the Family Wallet remain in the shared wallet and are not returned to them.
Yes. Both the Parent and members can redeem from the combined wallet at any time without requiring approval from one another.
The Family Wallet is deleted and all members revert to standard individual accounts.
The Family Wallet is an add-on feature. Contact [Gameball support](mailto:support@gameball.co) to add it to your plan.
***
## Related Articles
Set up how customers earn points across your store.
Define how customers redeem their points for rewards.
View Family Wallet details and manage customer accounts from the dashboard.
Family redemption data is included in the activities export.
# How Do I Get My Account Integration Details: API Key and Secret Key?
Source: https://docs.gameball.co/product-documentation/admin-settings/get-api-keys
To start the integration process, this is where you can get your integration keys or activate your high security mode on Gameball dashboard.
## Plan Availability
| Feature | Available |
| -------------------- | --------- |
| API Key & Secret Key | Guru |
If you are on the Pro plan, API access is available as a paid add-on. Contact Gameball support to request a payment link.
| Feature | Available |
| -------------------- | --------- |
| API Key & Secret Key | All plans |
To start your account integration with your platform, you will need to access your Gameball API keys, Secret Key, as well as enable some security measures if needed, such as your High Security Mode, or apply key rotation. The following will show you where to find those keys and how to apply strong security measures.
***
## Accessing Account Integration Settings
You can access your **Account Integration** settings section in **Gameball Admin Dashboard** through **Settings > Admin Settings > Account Integration**.
***
## Integration Keys
This is your account key, which will be used in the integration between your platform and Gameball.
You will have a **Test API Key** and a **Live API Key**. Use the test one during your integration and the live one after going live. [Read more about Test/Live Data API Keys](/product-documentation/integrate-gameball/other-integration-notes/test-and-live-data)
This is your account key, which will be used for test environments.
This is your account points transactions key. It will be used with all points transactions APIs.
When enabled, this mode ensures that all API requests are verified and secure, preventing unauthorized access and data exposure. This feature is disabled by default and can be easily activated in the Integration settings within the Admin panel. Once enabled, any integration that previously required only an API key will now also require a Secret Key, ensuring that even if the API key is exposed, it cannot be misused.
You can now **secure your accounts by rotating keys** without affecting your existing platform connections, helping them comply with security best practices (e.g., periodic credential rotation) and mitigate potential key exposure risks.
Key features of rotation:
| Feature | Details |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| Individual Key Rotation | API keys and Secret Key can each be rotated separately with dedicated actions |
| Immediate Replacement | Upon rotation, a new key is generated instantly and the old key is immediately disabled |
| Automated Updates for Shopify & Salla | Rotated keys are automatically updated in connected Shopify and Salla stores — no manual update needed |
| Access Control | Only Admins, Workspace Owners, and Workspace Admins can rotate keys; configurable with custom roles |
***
## Related Articles
Understand the difference between test and live API keys and when to use each.
A complete guide to integrating Gameball with your web application.
A complete guide to integrating Gameball with your mobile application.
Learn how to publish the Gameball experience and widget on your store.
# How Do I Manage My Gameball Customer Attributes?
Source: https://docs.gameball.co/product-documentation/admin-settings/manage-customer-attributes
Get deeper insights on how to configure your customer profile attribute and target customers based on your segmentation.
## Plan Availability
| Feature | Available |
| ------------------ | --------- |
| Profile Attributes | Guru |
| Feature | Available |
| ------------------ | --------- |
| Profile Attributes | All plans |
You can access the **Player Profile Attributes** settings section in **Gameball Admin Dashboard** through **Settings > Admin Settings > Profile Attributes**.
Read more about [Customer Profile Attributes](/product-documentation/understanding-your-customers/customer-profile/customer-profile-attributes).
***
## Default Attributes
On this settings page, you will be able to see Gameball's default attributes. These **cannot be edited or deleted**:
| Attribute | Attribute |
| ------------------ | ---------------------- |
| Name | UTMs |
| First Name | Devices |
| Last Name | Total Amount Spent |
| Email | Last Order Date |
| Gender | Total Orders Count |
| Mobile Number | Average Order Value |
| Date of Birth | Channel |
| Join Date | Gameball Creation Date |
| Country | — |
| City | — |
| Zip Code | — |
| Preferred Language | — |
***
## Add or Delete Custom Customer Profile Attributes
You can add or delete a custom attribute by scrolling down to the custom profile attributes section, then create an attribute by adding its name and a data type from the following options:
Use for numeric values such as order counts, spending thresholds, or custom scoring metrics.
Use for text-based values such as customer preferences, referral codes, or custom labels.
Use for true/false flags such as whether a customer has completed onboarding or opted into a program.
Use for date-based values such as contract start dates, last activity dates, or custom milestones.
While using a custom attribute in the web/mobile integration, you should use the exact same name used when defining the attribute in the settings.
***
## Related Articles
Understand all available customer profile attributes and how they work in Gameball.
Learn how to organize and segment your customers using tags.
# How Do I Request Coupon Creation from My Couponing Engine?
Source: https://docs.gameball.co/product-documentation/admin-settings/request-coupon-creation
Allow Gameball to request creation of coupon from your couponing engine through few configuration steps.
## Overview
You can reward customers with points for every achievement they complete through your customized loyalty program. These points can then be redeemed in the form of coupons to be used later on new orders. Gameball allows you to choose the type of reward coupons customers can receive and enjoy. [Learn more](/product-documentation/programs/loyalty-points-redeem/launch-and-configure-your-redeem-pointing-system)
For a coupon to be created by Gameball, there must first be a backend connection between Gameball and your couponing engine to keep track of your coupons. This way, Gameball can ping your couponing engine to get the required information for a coupon creation like start date, expiry date, code, etc., and the created coupon can sync with real-time orders and be put into action.
If your platform is built using a third-party plugin such as Shopify, the couponing sync takes place automatically due to the existence of an already built-in couponing system. These internal coupon engines automatically manage your coupon creations without any effort from your side.
If your website is built in-house and you want to build your own coupon system, you will need to follow a few coupon configuration steps before you start rewarding customers with various types of coupons.
***
## How to Allow Gameball to Create Coupons
On your **Gameball Admin Dashboard**, on the left bar, choose **Settings > Admin Settings > Coupon Configurations** under **Coupons**.
Fill in the following details to establish the backend connection between Gameball and your couponing engine:
Define the parameters that will be included in the coupon creation request sent to your engine.
Set up the required headers for authenticating and routing the API request to your engine.
Specify any query parameters required by your couponing engine's API.
[Follow this technical integration guide for further help.](/tutorials/experiences/points-redemption/convert-points-to-coupons/your-engine)
Select the types of coupons that your gateway supports so Gameball knows which coupon formats to request.
***
## Related Articles
Learn how to upload and manage third-party coupon codes directly from your Gameball dashboard.
# How to Delete Your Data on Gameball?
Source: https://docs.gameball.co/product-documentation/admin-settings/reset-your-data
Learn how to permanently delete your customer data or full program data through the Gameball admin dashboard.
## Plan Availability
All Gameball customers can access the data deletion feature.
If you want to delete some or all data related to your loyalty program, Gameball allows you to do that through a few steps.
***
## Types of Data You Can Delete
Clears all per-customer activity while keeping every customer profile intact. This is useful for program relaunches or handing over a test environment without losing your customer base.
**What is cleared:**
* Points balances and redemptions
* Achievements
* Events and activities
* Orders and transactions
* Referrals
* Tags
* Segment memberships
**What is preserved:**
* Customer profiles (IDs, names, emails, phones, and custom attributes)
* All program definitions and workspace configuration
This action is permanent and cannot be undone.
Permanently deletes all customer data across both live and test environments. This includes:
* Customer profiles
* Points balances and redemptions
* Achievements
* Events and activities
* Orders and transactions
* Referrals
* Audit records
This action is permanent and cannot be undone. Before proceeding, consider backing up your data by exporting it as a CSV file. To learn more, read Step 2 of [importing customers' data](/product-documentation/guides-strategies-faqs/supportive-guides/import-customers-csv).
Permanently deletes all program definitions and all customer data.
**Program data removed:**
* All loyalty program configurations
* Earning and redemption rules
* VIP tier definitions
* Campaign setups
* Widget configurations
**Customer data removed:**
* Customer profiles, points, achievements, events, orders, transactions, referrals, and audit records
Once deleted, you will start the configuration wizard from the beginning with a fresh Gameball instance.
All data and configurations will be permanently removed and cannot be recovered.
***
## How to Delete Your Data
On **Gameball Admin Dashboard**, go to **Settings > Admin Settings > Delete Data**.
Click the relevant button — **Reset Customer Progress**, **Delete All Customers**, or **Delete Programs Data and All Customers**. Destructive actions are styled in red to indicate they are irreversible.
A two-step confirmation is required before Gameball proceeds:
1. Review the summary of everything that will be permanently removed.
2. Type your **workspace name** to confirm.
This action is restricted to super-admin and owner roles. A full audit log entry is recorded each time a deletion is triggered.
# What Is Third-Party Coupons Through the Gameball Dashboard?
Source: https://docs.gameball.co/product-documentation/admin-settings/third-party-coupons
Learn how to upload, organize, and manage third-party coupon codes directly from your Gameball dashboard for seamless distribution.
## Plan Availability
| Platform | Plan |
| -------- | ------------------------------------------------------------ |
| All | Upon Request ([Contact Support](mailto:support@gameball.co)) |
Gameball allows you to upload and manage third-party coupon codes efficiently through the dashboard. This feature helps you deliver coupon codes to customers automatically and track their redemption without manual work.
***
## Prerequisites
Ensure you have the necessary permission levels to access this feature. Only users with the roles of **Workspace Owner**, **Admin**, or **Merchant/Branch Manager** can manage third-party coupons.
***
## Step-by-Step Instructions
Go to your Gameball dashboard and click **Settings**, then navigate to the **Admin Settings** section.
Under the **Coupons** section, click on **3rd Party Coupons**.
To add a new coupon group, click **Add New Group**.
Enter the following details and then click **Save**:
* **Name**
* **Group URL**
* **Title**
* **Description**
* Upload Image under **Group Icon**
Once the coupon group is created, you can upload a CSV file that includes third-party coupon codes. Next to the new coupon group created, click **Upload CSV**.
The CSV file must include the following columns:
| Column | Required |
| ------------------------------- | -------- |
| Coupon Code | Required |
| Start Date | Optional |
| Expiry Date | Optional |
| Expiry Window | Optional |
| Capping | Optional |
| Minimum Order Value | Optional |
| Combine with Product Discounts | Optional |
| Combine with Order Discounts | Optional |
| Combine with Shipping Discounts | Optional |
The system will validate your file for any missing or duplicate codes. You will receive an email notification confirming whether the upload was successful or not.
Go to the **Coupon Inventory** tab to view all uploaded third-party coupons. The table displays each coupon along with its status:
| Status | Meaning |
| --------- | --------------------------------------------------- |
| Available | The coupon has not yet been claimed by any customer |
| Used | The coupon has already been redeemed |
Gameball automatically marks a coupon as **Used** once it is claimed by a customer. You can track redemption statuses directly from the dashboard.
***
## Common Questions
The system will reject duplicates during validation and notify you via email.
No, once a coupon is used, it cannot be reassigned or reused.
Ensure your CSV file is correctly formatted to avoid upload issues. Only users with the appropriate permission levels can manage coupons.
***
## Related Articles
Configure Gameball to request coupons from your custom couponing engine.
# How Do I Track User Activity on your Dashboard?
Source: https://docs.gameball.co/product-documentation/admin-settings/track-user-activity
Learn how to audit and have full visibility into your dashboard activities, helping your team track configuration and administrative changes across your Gameball workspace.
## Plan Availability
| Platform | Plan |
| -------------------- | ---- |
| Shopify | All |
| Salla | All |
| Non-platform clients | All |
Gameball has a built-in audit trail that provides full visibility into dashboard activities. This feature helps you maintain accountability and traceability by recording who made changes, what was changed, and when those changes occurred.
It is designed to support teams that manage complex configurations by offering a clear and reliable record of all critical administrative and configuration actions within a workspace.
***
## Accessing Team Activities
Log in to the Gameball dashboard using your credentials.
Go to **Settings > Admin Settings > Users**, then open the **Team Activities** tab.
Review the list of logged activities displayed in a centralized table. Use filters or search to narrow down results based on your needs.
***
## What's Logged in the Team Activities
Gameball tracks all critical dashboard actions, including:
* Creation, updates, and deletions of campaigns
* Creation, updates, and deletions of coupons
* Tier changes
* Segment changes
* Customer attribute changes
* API key rotations
* User invitations
* Role changes
* Workspace settings updates
### Log Entry Details
Each log entry includes:
| Field | Description |
| --------------- | -------------------------------------- |
| Action type | The type of action performed |
| Affected entity | The object that was changed |
| User | The user who performed the action |
| Date and time | When the action occurred |
| Change summary | Previous and new values when available |
### Filtering and Search
Logs can be filtered by:
* Action type
* User
* Date range
* Entity type
Search is supported using entity names or user email addresses.
***
## Important Notes
The activities provide visibility across configuration and administrative changes only.
Access to the team activities is restricted to:
* Workspace Owners
* Admins
* Workspace Admins
* When custom roles are enabled, access can be assigned through permissions.
Log retention follows the default retention period unless otherwise specified.
***
## Related Articles
Learn how to invite team members and configure their roles on the Gameball dashboard.
# How Do I Update Firebase Cloud Messaging (FCM) Configuration to HTTP v1 for Gameball Customers?
Source: https://docs.gameball.co/product-documentation/admin-settings/update-fcm-to-http-v1
Guide to help you update Firebase Cloud Messaging (FCM) Configuration to HTTP v1.
## Overview
To ensure continuous delivery of notifications to your mobile users, Gameball now requires an update to the Firebase Cloud Messaging (FCM) configuration, transitioning from the legacy API to the new HTTP v1 API. This article walks you through the steps needed to complete this migration.
***
## Migration Steps
Open your web browser and go to the Firebase Console. Log in using the Google account associated with your Firebase project.
In the Firebase Console, click on the **Settings (gear icon)** in the left sidebar. Select **Project Settings**, then go to the **Service Accounts** tab.
Click on **Generate New Private Key** to download a JSON file containing all necessary information for the migration.
**Sample FCM Private key JSON file:**
```json theme={null}
{
"type": "service_account",
"project_id": "fcm-test-*****",
"private_key_id": "*****4da92a*****031791732e*****",
"private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIB*****ASCBKcwggSjAgEAAoIBAQCnZZw4akn8XO2J\nYS*****RhTCxF+KyTNmp7q0GnuoEZweGyla6t*****PxSnh\nfX5w1wxD7r1iGxJCG8******",
"client_email": "firebase-a*****est-7ce24.iam.gserviceaccount.com",
"client_id": "*****38150929365",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-8j******.iam.gserviceaccount.com",
"universe_domain": "googleapis.com"
}
```
Access your Gameball dashboard using your credentials.
Navigate to your **Gameball Admin Dashboard > Settings > Admin Settings**. Locate the **Integration** then go to **Mobile Integration**.
The old attributes such as **Sender ID**, **Web API Key**, and **Server Key** should be left unchanged.
Using the downloaded JSON file, fill in the following fields in the Gameball dashboard:
| Field | Source in JSON file |
| --------------- | -------------------------------------------------------------------------------------- |
| **projectId** | Copy the value of `project_id` |
| **privateKey** | Copy the entire value of `private_key` (including "BEGIN" and "END PRIVATE KEY" lines) |
| **clientEmail** | Copy the value of `client_email` |
After entering all three fields, click **Save** to apply the changes.
By following these steps, you will ensure your notifications continue to work seamlessly with the new Firebase API requirements.
***
## Need Help?
If you have any questions or need further assistance, please contact our support team at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Set up Firebase Cloud Messaging for push notifications in Gameball.
# How Do I Upload your Stores' Products and Collections through a CSV File?
Source: https://docs.gameball.co/product-documentation/admin-settings/upload-products-collections-csv
Upload, download, or delete your stores' data on Gameball.
## Overview
If you want to create loyalty events that involve specific products or collections, Gameball will need some information about them first. To provide this data, you can easily upload a CSV file containing all the details of your products or collections.
***
## How to Access
Go to **Dashboard > Settings > Admin Settings > Products and Collections** under **Integrations**.
Under **Products** or under **Collections**, click **"Click to upload"** or drag and drop your file.
***
## CSV File Formats
Follow this column format for your **Products** CSV file:
| Column | Field |
| -------- | ------------ |
| Column 1 | Product ID |
| Column 2 | Product Name |
| Column 3 | Variant ID |
| Column 4 | Variant Name |
| Column 5 | Price |
| Column 6 | URL |
Follow this column format for your **Collections** CSV file:
| Column | Field |
| -------- | --------------- |
| Column 1 | Collection ID |
| Column 2 | Collection Name |
| Column 3 | URL |
***
## Manage Uploaded Files
To download or delete the previously uploaded file, click on the **Download Current File** option or the **Delete Icon**. The latest uploaded CSV file will be downloaded instantly.
# How Do I Integrate ActiveCampaign with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/activecampaign-integration
Keep your customers in sync across Gameball and ActiveCampaign, and target them based on your loyalty data.
## Why Integrate ActiveCampaign with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Segment your contact lists** based on Gameball customer attributes.
* **Trigger automations** based on Gameball customer attributes.
* **Send personalized emails** by including Gameball customer information in email templates, such as the customer's current tier.
***
## How to Configure ActiveCampaign on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **ActiveCampaign**.
1. Install ActiveCampaign from the Shopify App Store.
2. In your ActiveCampaign account, go to **Settings > Developer**.
3. Copy the **URL** and **API Key**.
Paste the URL and API Key into your Gameball account and click **Next**.
Click **Add** so the list of customer attributes will be automatically added to your ActiveCampaign account.
Make sure you use these attributes with the notation provided on your Gameball Admin Dashboard, as described below.
***
## Using Gameball Data in ActiveCampaign
Once connected, go to your ActiveCampaign account to leverage Gameball loyalty data in your marketing.
### Check Customer Fields
View Gameball customer profile attributes in a customer's contact details.
### Segment Customers
While creating a campaign, segment customers based on a Gameball customer profile attribute.
### Split Automations
Split an automation based on Gameball customer profile attributes.
***
Explore all available Gameball integrations.
Connect Gameball with thousands of apps via Zapier.
# How Do I Integrate Adjust with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/adjust-integration
Use Adjust as your dynamic link provider for Gameball referral programs.
| Platform | Plan |
| ------------ | --------- |
| Non-Platform | All Plans |
Gameball supports **Adjust** as a dynamic link provider for referral programs. This integration enables you to generate dynamic links that track referrals and enhance your user acquisition strategy.
## How It Works
When integrated, Gameball uses Adjust to generate referral links that:
* **Track referrals** across devices and platforms.
* **Deep link** users into your mobile app from referral links.
* **Attribute** new user acquisitions back to the referring customer.
***
## Setup Guide
For the full step-by-step integration guide, including how to retrieve your Adjust credentials and configure the dynamic link provider, refer to the technical tutorial:
Complete technical guide to set up Adjust as your dynamic link provider in Gameball.
***
## Frequently Asked Questions
Yes. The referral process can be completed without a deep link generator. In that case, you provide your own referral link and Gameball appends the referral code to it in this format:
`{referralLink}?GbReferral={referralCode}`
You will then need to handle the referral logic manually, including capturing the referral code and passing it in the *create customer* request.
# How Do I Integrate Attentive with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/attentive-integration
Integrate Gameball with Attentive to Enhance Your SMS Marketing Campaigns.
Gameball and Attentive integration allows you to leverage customer engagement data from Gameball to power your SMS marketing campaigns in Attentive. Follow this guide to seamlessly connect the two platforms and maximize the impact of your loyalty and marketing efforts.
***
## Prerequisites
Before starting the integration, ensure the following:
* You have an active **Gameball** account.
* You have an active **Attentive** account.
* Access to admin permissions in both platforms.
***
## How to Configure Attentive on Gameball
1. Log in to your **Gameball Dashboard**.
2. Navigate to the **Integrations** section from the left menu.
3. Select **Attentive** and click **Connect**, then **Next**.
4. You will be redirected to the **Attentive dashboard**. Scroll down and click **Authorize**.
5. Go back to the integration section on the dashboard to ensure that the Attentive app is now connected to your Gameball account.
The following customer attributes are synced to Attentive:
| Attribute | Description |
| -------------------------- | ----------------------------- |
| Customer ID | Unique customer identifier |
| Date of Birth | Customer's birthday |
| Join Date | When the customer joined |
| Tier Name | Current loyalty tier |
| Wallet Points | Available points balance |
| Pending Points | Points awaiting confirmation |
| Tier Progress | Progress toward next tier |
| Tier ID | Current tier identifier |
| Completed Reward Campaigns | Number of completed campaigns |
| Referral Code | Customer's referral code |
| Referral Link | Customer's referral link |
| Tags and Segments | Assigned tags and segments |
Save your settings once configured.
Before launching your campaigns, test the integration to ensure it works as expected:
1. Perform a test action in Gameball (e.g., award points to a test user).
2. Check if the event appears in Attentive under the corresponding profile.
3. Send a test SMS using the synced data in Attentive.
***
## Create SMS Campaigns in Attentive
Now that the integration is live, use Gameball data to personalize your Attentive campaigns:
1. Navigate to **Campaigns** in Attentive.
2. Create a new campaign and select your target audience based on Gameball data (e.g., customers who achieved a certain tier or redeemed rewards).
3. Use dynamic variables (e.g., `{total_points}`, `{current_level}`) to personalize your messages.
4. Launch your campaign.
***
## Troubleshooting
If you encounter issues:
1. Verify that the API key and webhook URL are correctly configured.
2. Check the integration logs in Gameball for error messages.
3. Contact Gameball support or Attentive support for further assistance.
***
## Frequently Asked Questions
We've built a retry mechanism for quick data synchronization. However, if you encounter delays, check your integration settings or contact support.
Yes, only Gameball-related loyalty data is passed to Attentive, ensuring data safety and compliance with privacy regulations.
***
Integrate Gameball with MoEngage for engagement campaigns.
Automate loyalty workflows with Shopify Flow.
# How Do I Integrate Bloomreach with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/bloomreach-integration
Leverage customer engagement data from Gameball to power your email marketing campaigns in Bloomreach.
Gameball and Bloomreach integration allows you to leverage customer engagement data from Gameball to power your email marketing campaigns in Bloomreach. Follow this guide to seamlessly connect the two platforms and maximize the impact of your loyalty and marketing efforts.
## Why Integrate Bloomreach with Gameball?
By integrating Bloomreach with Gameball, you unlock the ability to target and segment customers based on their loyalty to your app. This powerful integration allows you to:
* **Segment contact lists** based on Gameball customer attributes (e.g., points balance, tier) and events created.
* **Send personalized emails** by including loyalty-related data, such as customer tier and reward points, in your email templates.
* **Track and trigger campaigns** based on specific customer events, such as coupons created, orders placed, and reward achievements.
***
## Data Import Scenarios
The integration between Gameball and Bloomreach ensures that your customer data is always up-to-date. Gameball's customer attributes will be imported into Bloomreach whenever a customer is created or performs any action.
**Trigger:** Upon customer creation or after any new action (e.g., achievement, transaction, points expiry).
Gameball's customer attributes will be imported and updated in Bloomreach automatically. The following data is synced:
| # | Gameball Attribute |
| --------- | ----------------------------------------------------------------------------------------- |
| 1 | Account State |
| 2 | Join Date |
| 3 | Birthday |
| 4 | Country |
| 5 | City |
| 6 | Tier Name |
| 7 | Wallet Points |
| 8 | Pending Points |
| 9 | Active Points |
| 10 | Tier Progress |
| 11 | Tier ID |
| 12 | Completed Reward Campaigns |
| 13 | Referral Code |
| 14 | Referral Link |
| 15 | Tags and Segments |
| 16 | Latest Created Coupon |
| 17 | Latest Used Coupon |
| 18 | Total Net Amount of Transactions |
| 19 | Earned Points |
| 20 | Expired Points |
| 21 | Redeemed Points |
| 22 | Next Expiring Points Amount |
| 23 | Next Expiring Points Value |
| 24 | Next Expiring Points Date |
| 25 | Starting Store |
| 26 | Average Basket Size |
| 27 | First Captured Order Date |
| 28 | Connecting Store |
| 29 | Store of First Transaction |
| 30 | Transactions Amount in the Last Rolling Year |
| 31 | Unit per Transaction |
| 32 | Last Order Awarded Points |
| 33 | Currency |
| 34 | Source |
| **Other** | Count of Rewarded Campaigns, Starting Store, Connecting Store, Store of First Transaction |
**Trigger:** Order placed by customer and received by Gameball.
Once an order is placed, the following order data is sent to Bloomreach:
| Attribute | Description |
| ----------------------- | --------------------------------- |
| Order ID | Unique order identifier |
| Order Date | Date the order was placed |
| Total Paid | Amount paid by the customer |
| Total Price | Full order price |
| Total Shipping | Shipping cost |
| Total Tax | Tax amount |
| Total Discount | Discount applied |
| Discount Codes | Codes used |
| Redeemed Amount | Points redeemed as currency |
| Rewarded Points | Points earned from order |
| Equivalent Points Value | Monetary value of rewarded points |
**Trigger:** Coupon created for the customer.
The following coupon details will be available on Bloomreach linked to the customer's data:
* Coupon Code
* Type
* Value
* Coupon Name
**Trigger:** Customer used a coupon while placing an order.
The following details will be available on Bloomreach:
* Coupon Code, Type, Value, Coupon Name
* Order ID, Order Quantity
* Channel (POS, Online, etc.)
**Trigger:** Customer achieved a reward campaign.
The following details will be available on Bloomreach:
* Internal Name, Name
* Reward (Points, Points & Score, Coupon Values)
* Coupon Type (if the reward was a coupon)
* Equivalent Value of Rewarded Points
* Achievement Date
**Trigger:** Customer redeemed their saved points.
Each `points_redeemed` event includes:
* Redeemed Points
* Redemption Amount
* Redemption Transaction ID (if available)
**Trigger:** Order received by Gameball.
A "Purchase" event is sent to Bloomreach for each line item with the following attributes:
* Order ID, Product Title, Unit Price, Vendor Name
* Product ID, Weight, Quantity, SKU
* Collections Array, Tags Array, Taxonomy Array
* Any extra attributes added to the object
**Trigger:** Customer removed from Gameball.
Once a customer is deleted from Gameball, the customer gets deleted from Bloomreach after **24 hours**.
You have the option to disable the deletion feature from Bloomreach.
***
## How to Configure Bloomreach on Gameball
Not publishing the widget could impact the integration process, so ensure it's live before proceeding.
Navigate to **Integrations** in your **Gameball Admin Dashboard** menu. Scroll down to **Bloomreach** and click **Connect**.
1. In your **Bloomreach** account, go to **Settings > Project Settings > Access Management > API**.
2. Copy the **API Base URL**.
3. Go back to your Gameball dashboard and paste the URL.
1. In your **Bloomreach** account, go to **Settings > Project Settings > Access Management > API**.
2. Copy the **Project Token**.
3. Go back to your Gameball dashboard and paste the Token.
1. In your **Bloomreach** account, go to **Settings > Project Settings > Access Management > API**.
2. Scroll down and click **New Group**.
3. Choose **Private Access**, add a group name, and click **Create Group**.
4. Give permissions to the new API Group:
* **Customer Attributes:** Get and Set
* **Events:** Set
Not giving Get and Set permissions to the API Group may prevent the integration from functioning properly.
1. Choose the new group created from the last step.
2. Click **Add Key**.
3. Enter a key name.
1. Copy the **API Key ID** and **API Secret**.
2. Paste both keys in Gameball accordingly.
Gameball tracks various customer events (e.g., points earned, redeemed, tiers achieved). Map these events to Bloomreach to use them in your campaigns.
1. In the Gameball Dashboard, go to **Integrations**.
2. Select **Bloomreach** from the list of available integrations.
3. Map the following events:
* Coupon Created
* Coupon Redeemed
* Reward Campaign Achieved
* Order Placed
4. Confirm the event mappings and save.
Syncing customer data ensures Bloomreach receives real-time updates about customer actions.
1. In the Gameball Dashboard, navigate to **Integrations > Bloomreach**.
2. Enable the **Customer Sync** toggle.
3. Choose the customer attributes to sync (Customer ID, Date of Birth, Join Date, Tier Name, Wallet Points, Pending Points, Tier Progress, Tier ID, Completed Reward Campaigns, Referral Code, Referral Link, Tags and Segments).
4. Save your settings.
In Bloomreach, go to **Data and Assets > Customers** to find a table with all automatically synced Gameball customers.
You will also see real-time Gameball events such as Coupon Created, Coupon Used, Reward Campaign Achieved, Order Placed, Order Cancelled, and Refund Created. Each event is synced in real-time, allowing you to send highly targeted campaigns and flows in Bloomreach.
***
Connect Gameball with thousands of apps via Zapier.
Explore all available Gameball integrations.
# How Do I Integrate Branch.io with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/branch-io-integration
Use Branch.io as your dynamic link provider for Gameball referral programs.
| Platform | Plan |
| ------------ | --------- |
| Non-Platform | All Plans |
Gameball supports **Branch.io** as a dynamic link provider for referral programs. This integration enables you to generate dynamic links that track referrals and enhance your user acquisition strategy.
## How It Works
When integrated, Gameball uses Branch.io to generate referral links that:
* **Track referrals** across devices and platforms.
* **Deep link** users into your mobile app from referral links.
* **Attribute** new user acquisitions back to the referring customer.
***
## Setup Guide
For the full step-by-step integration guide, including how to retrieve your Branch.io credentials and configure the dynamic link provider, refer to the technical tutorial:
Complete technical guide to set up Branch.io as your dynamic link provider in Gameball.
***
## Frequently Asked Questions
Yes. The referral process can be completed without a deep link generator. In that case, you provide your own referral link and Gameball appends the referral code to it in this format:
`{referralLink}?GbReferral={referralCode}`
You will then need to handle the referral logic manually, including capturing the referral code and passing it in the *create customer* request.
# How Do I Integrate Drip with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/drip-integration
Keep your customers in sync across Gameball and Drip, and target them based on your loyalty data.
## Why Integrate Drip with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Check Gameball customer attributes** directly in Drip.
* **Send personalized emails** by including Gameball customer information in email templates, such as the customer's current tier.
***
## How to Configure Drip on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **Drip**.
1. Install Drip from the Shopify App Store.
2. In your Drip account, go to **Settings > Developer**.
3. Copy the **URL** and **API Key**.
Paste the URL and API Key into your Gameball account and click **Next**.
Click **Add** so the list of customer attributes will be automatically added to your Drip account.
***
## Using Gameball Data in Drip
Once connected, go to your Drip account to leverage Gameball loyalty data.
### Check Customer Tags
View Gameball customer profile custom tags through **People > Choose customer**.
### Personalize Email Campaigns
Go to **Personalize** and choose one of Gameball's custom profile attributes.
# How Do I Integrate Google Wallet with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/google-wallet-integration
Let customers use their Google Wallet loyalty card with Gameball.
| Platform | Plan | Channel |
| -------- | ------------ | ------- |
| All | Upon Request | Mobile |
Gameball now supports **Google Wallet loyalty cards**, allowing your customers to easily access their loyalty points directly from their phones, and even receive nearby store notifications.
Previously, loyalty interactions were limited to the Gameball platform or your store system. With Google Wallet integration, customers can now engage with your loyalty program seamlessly in real life, improving retention and convenience.
***
## Benefits
* **Boost customer engagement** with easy access to loyalty details.
* **Strengthen your brand** with a custom, branded digital card.
* **Ensure a seamless omnichannel experience** across web, mobile, and in-store.
***
## How Does It Work?
* Each customer can generate a **unique Google Wallet loyalty card** from their Gameball account.
* The card displays key loyalty details:
* Customer name
* Current points balance
* Tier/level
* QR or barcode for scanning
* Client-branded design (logo, colors, theme)
* Customers can **add the card to Google Wallet** directly from your loyalty portal.
* **Automatic synchronization:** points balance and tier updates reflect in near real-time.
* **POS compatibility:** cards can be scanned at checkout to earn or redeem points instantly.
# How Do I Integrate HubSpot with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/hubspot-integration
Keep your customers in sync across Gameball and HubSpot, and target them based on your loyalty data, like current tier and points balance.
## Why Integrate HubSpot with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Check Gameball custom attributes** on HubSpot.
* **Trigger workflows** based on Gameball customer attributes.
***
## How to Configure HubSpot on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **HubSpot**.
1. Install HubSpot from the Shopify App Store.
2. In your HubSpot account, go to **Settings > Integrations**.
3. Copy the **API token**.
Paste the API token on your Gameball Admin Dashboard and click **Next**.
Click **Add** so the list of customer attributes will be automatically added to your HubSpot account.
Make sure you use these attributes with the notation provided on your Gameball Admin Dashboard, as described below.
***
## Using Gameball Data in HubSpot
### Check Customer Attributes
Go to **Contacts > Select a specific contact** to view the custom attributes.
### Trigger Workflows
Go to **Automation > Workflows > Actions > Set Enrollment Trigger > Contact Properties** to trigger a workflow based on a Gameball customer attribute.
# How Do I Integrate Insider with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/insider-integration
Leverage customer engagement data from Gameball to power your marketing campaigns in Insider.
Gameball and Insider integration allows you to leverage customer engagement data from Gameball to power your marketing campaigns in Insider. Follow this guide to seamlessly connect the two platforms and maximize the impact of your loyalty and marketing efforts.
## Why Integrate Insider with Gameball?
By integrating Insider with Gameball, you unlock the ability to target and segment customers based on their loyalty to your app. This powerful integration allows you to:
* **Segment contact lists** based on Gameball customer attributes (e.g., points balance, tier) and events created.
* **Send personalized emails** by including loyalty-related data, such as customer tier and reward points, in your email templates.
* **Track and trigger campaigns** based on specific customer events, such as coupons created, orders placed, and reward achievements.
***
## Data Import Scenarios
The integration between Gameball and Insider ensures that your customer data is always up-to-date. Gameball's customer attributes will be imported into Insider whenever a customer is created or performs any action.
**Trigger:** Upon customer creation or after any new action (e.g., achievement, transaction, points expiry).
Gameball's customer attributes will be imported and updated in Insider automatically. The following data is synced:
| # | Gameball Attribute | Insider Attribute |
| -- | -------------------------------------------- | ------------------------------------------------------ |
| 1 | Account State | gb\_state |
| 2 | Join Date | gb\_join\_date |
| 3 | Birthday | birthday |
| 4 | Country | gb\_country |
| 5 | City | gb\_city |
| 6 | Tier Name | gb\_level\_name |
| 7 | Wallet Points | gb\_wallet\_points |
| 8 | Pending Points | gb\_pending\_points |
| 9 | Active Points | gb\_active\_points |
| 10 | Tier Progress | gb\_level\_progress |
| 11 | Tier ID | gb\_level\_id |
| 12 | Completed Reward Campaigns | gb\_completed\_challenges |
| 13 | Referral Code | gb\_referral\_code |
| 14 | Referral Link | gb\_referral\_link |
| 15 | Tags and Segments | gb\_tags\_and\_segments |
| 16 | Latest Created Coupon | gb\_latest\_created\_coupon |
| 17 | Latest Used Coupon | gb\_latest\_used\_coupon |
| 18 | Total Net Amount of Transactions | gb\_total\_net\_amount |
| 19 | Earned Points | gb\_total\_earned\_points |
| 20 | Expired Points | gb\_total\_expiry\_points |
| 21 | Redeemed Points | gb\_total\_redeemed\_points |
| 22 | Next Expiring Points Amount | gb\_next\_expiring\_points\_amount |
| 23 | Next Expiring Points Value | gb\_next\_expiring\_points\_value |
| 24 | Next Expiring Points Date | gb\_next\_expiring\_points\_date |
| 25 | Starting Store | gb\_starting\_store |
| 26 | Average Basket Size | gb\_average\_basket\_size |
| 27 | First Captured Order Date | gb\_first\_order\_date |
| 28 | Connecting Store | gb\_connecting\_store |
| 29 | Store of First Transaction | gb\_first\_trasnction\_store |
| 30 | Transactions Amount in the Last Rolling Year | gb\_transactions\_amount\_in\_the\_last\_rolling\_year |
| 31 | Unit per Transaction | gb\_unit\_per\_transaction |
| 32 | Last Order Awarded Points | gb\_last\_order\_awarded\_points |
| 33 | Currency | gb\_currency |
| 34 | Source | source |
**Trigger:** Order placed by customer and received by Gameball.
Once an order is placed, the following order data is sent to Insider:
| Attribute | Description |
| ----------------------- | --------------------------------- |
| Order ID | Unique order identifier |
| Order Date | Date the order was placed |
| Total Paid | Amount paid by the customer |
| Total Price | Full order price |
| Total Shipping | Shipping cost |
| Total Tax | Tax amount |
| Total Discount | Discount applied |
| Discount Codes | Codes used |
| Redeemed Amount | Points redeemed as currency |
| Rewarded Points | Points earned from order |
| Equivalent Points Value | Monetary value of rewarded points |
**Trigger:** Coupon created for the customer.
The following coupon details will be available on Insider:
* Coupon Code
* Type
* Value
* Coupon Name
**Trigger:** Customer used a coupon while placing an order.
The following details will be available on Insider:
* Coupon Code, Type, Value, Coupon Name
* Order ID, Order Quantity
* Channel (POS, Online, etc.)
**Trigger:** Customer achieved a reward campaign.
The following details will be available on Insider:
* Internal Name, Name
* Reward (Points, Points & Score, Coupon Values)
* Coupon Type (if the reward was a coupon)
* Equivalent Value of Rewarded Points
* Achievement Date
**Trigger:** Customer redeemed their saved points.
Each `points_redeemed` event includes:
* Redeemed Points
* Redemption Amount
* Redemption Transaction ID (if available)
**Trigger:** Order received by Gameball.
A "Purchase" event is sent to Insider for each line item with the following attributes:
* Order ID, Product Title, Unit Price, Vendor Name
* Product ID, Weight, Quantity, SKU
* Collections Array, Tags Array, Taxonomy Array
* Any extra attributes added to the object
**Trigger:** Customer removed from Gameball.
Once a customer is deleted from Gameball, the customer gets deleted from Insider after **24 hours**.
You have the option to disable the deletion feature from Insider.
***
## How to Configure Insider on Gameball
Not publishing the widget could impact the integration process, so ensure it's live before proceeding.
Navigate to **Integrations** in your **Gameball Admin Dashboard** menu. Scroll down to **Insider** and click **Connect**.
1. In your **Insider** account, go to **Settings > "App Name" Settings > Account Settings**.
2. Copy the **Partner Name**.
3. Go back to your Gameball dashboard and paste the name.
1. In your **Insider** account, go to **Settings > "App Name" Settings > Integration Settings**.
2. Scroll down and click **Generate API key**.
3. Choose **Unified Customer Database** and click **Next**.
Choosing a different type for the API Key may prevent the integration from functioning properly.
1. Once you've generated the API key in Insider, copy it.
2. Go back to your Gameball dashboard, paste the key, and click **Next**.
Gameball tracks various customer events (e.g., points earned, redeemed, tiers achieved). Map these events to Insider to use them in your campaigns.
1. In the Gameball Dashboard, go to **Integrations**.
2. Select **Insider** from the list of available integrations.
3. Map the following events:
* Coupon Created
* Coupon Redeemed
* Reward Campaign Achieved
* Order Placed
4. Confirm the event mappings and save.
Syncing customer data ensures Insider receives real-time updates about customer actions.
1. In the Gameball Dashboard, navigate to **Integrations > Insider**.
2. Enable the **Customer Sync** toggle.
3. Choose the customer attributes to sync (Customer ID, Date of Birth, Join Date, Tier Name, Wallet Points, Pending Points, Tier Progress, Tier ID, Completed Reward Campaigns, Referral Code, Referral Link, Tags and Segments).
4. Save your settings.
In the **User Profiles** section, you will find a table with all automatically synced Gameball customers.
You will also see real-time Gameball events such as Coupon Created, Coupon Used, Reward Campaign Achieved, Order Placed, and Purchase.
Each event is synced in real-time, allowing you to send highly targeted campaigns and flows in Insider.
***
Connect Gameball with thousands of apps via Zapier.
Explore all available Gameball integrations.
# Boost Business Growth: Leveraging Judge.me Integration with Your App
Source: https://docs.gameball.co/product-documentation/apps-integrations/integration-use-cases/judge-me-use-cases
Check out some use cases and learn how to boost your business growth by leveraging Judge.me Integration with your app.
**Need help making the best out of your Gameball and Judge.me integration? [Book a Call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=judgeme-article) with one of our experts now!**
In the fiercely competitive realm of commerce, building and nurturing customer loyalty is pivotal for sustained success and customer retention. Integrating Judge.me, a powerful review and rating platform, with a robust loyalty and retention platform like Gameball can significantly enhance customer engagement and amplify brand advocacy.
***
## Use Cases
Integrate Judge.me with Gameball to encourage customers to leave reviews and ratings in exchange for loyalty points or rewards. This enhances customer engagement and generates valuable user-generated content, fostering trust and credibility.
Offer exclusive rewards through Gameball to customers who provide detailed and insightful reviews via Judge.me. This encourages active participation and strengthens loyalty.
Utilize the reviews and ratings collected through Judge.me to segment customers based on their preferences and feedback. Leverage this segmentation data within Gameball to personalize communication and rewards.
Implement automated email campaigns through Judge.me and Gameball to request and remind customers to leave reviews.
Integrate Judge.me's reviews within Gameball communications to showcase customer experiences and testimonials. Highlighting positive reviews can influence potential customers and foster trust.
Reward customers with loyalty points for providing helpful and informative reviews that aid other shoppers in making informed purchasing decisions.
***
## Example Scenarios
* **Reward on 5th review** - Set a flow through Gameball to send customers a special reward once they complete five reviews, encouraging continued engagement.
* **Reward on first review** - Set a reward campaign that triggers on the first review, encouraging customers to leave more positive reviews on future purchases.
By integrating Judge.me with Gameball, your business will cultivate stronger customer relationships, bolster brand loyalty, and drive sustained growth.
**If you need further assistance, [book a call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=judgeme-article) now!**
***
Leverage Mailchimp integration.
Leverage Klaviyo integration.
Leverage Omnisend integration.
# Boost Business Growth: Leveraging Klaviyo Integration with Your App
Source: https://docs.gameball.co/product-documentation/apps-integrations/integration-use-cases/klaviyo-use-cases
Check out some use cases and learn how to boost your business growth by leveraging Klaviyo Integration with your app.
**Need help making the best out of your Gameball and Klaviyo integration? [Book a Call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=klaviyo-article) with one of our experts now!**
In the dynamic world of commerce, fostering customer loyalty is essential for sustainable growth and brand success. Integrating Klaviyo, a renowned marketing automation platform, with a robust loyalty and retention platform like Gameball can significantly enhance customer engagement and drive sales.
***
## Use Cases
Utilize Klaviyo's powerful communication tools to send personalized messages, exclusive offers, and targeted promotions to customers, emphasizing the benefits of the loyalty program. This drives customer participation and fosters a deeper emotional connection with the brand.
Implement Klaviyo's advanced segmentation capabilities to categorize customers based on their purchasing behavior, engagement with the loyalty program, and preferences.
Set up automated email flows and campaigns through Klaviyo to welcome new members, acknowledge milestones with different rewards, and encourage them to redeem rewards with special offers for their next purchases.
Leverage Klaviyo's comprehensive analytics and reporting features to track customer engagement tiers, measure campaign effectiveness, and use data-driven insights to refine loyalty program strategies.
Utilize Klaviyo to announce exclusive loyalty promotions and sales, creating a sense of urgency and excitement among customers and fostering a sense of belonging.
***
## Example Scenarios
* **Segment by points balance** - Segment your contact list based on Gameball's points balance, then send this segment a campaign with special offers to encourage customers to redeem their points and make more purchases.
* **Trigger flows from custom properties** - Since Gameball sends custom properties to Klaviyo, use those properties to trigger a flow of communication to remind customers to re-order using the rewards they've received through Gameball.
**If you need further assistance, [book a call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=klaviyo-article) now!**
***
Leverage Mailchimp integration.
Leverage Judge.me integration.
Leverage Omnisend integration.
# Boost Business Growth: Leveraging Mailchimp Integration with Your App
Source: https://docs.gameball.co/product-documentation/apps-integrations/integration-use-cases/mailchimp-use-cases
Check out some use cases and learn how to boost your business growth by leveraging Mailchimp Integration with your app.
**Need help making the best out of your Gameball and Mailchimp integration? [Book a Call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=mailchimp-article) now!**
In today's competitive marketplace, fostering customer loyalty is crucial for the sustained growth and success of any commerce business. Integrating Mailchimp, a leading email marketing platform, with a robust loyalty program can significantly amplify customer engagement and drive sales.
By leveraging the combined strengths of Mailchimp and Gameball, businesses can create a dynamic ecosystem that nurtures lasting customer relationships and boosts brand advocacy.
One of the key benefits of integrating Mailchimp with Gameball lies in its ability to facilitate targeted and personalized communication. Mailchimp's segmentation capabilities enable businesses to categorize customers based on their purchase history, demographics, and engagement with the loyalty program.
***
## Use Cases
By segmenting customers on Mailchimp using Gameball's tier progress attribute, businesses can create a segment of customers with the highest tier of progress. This allows them to send a special reward or discount campaign for Black Friday offers, enticing and rewarding loyal customers during this critical sales period.
By creating a campaign with personalized special rewards for customers upon unlocking a new, higher tier on Gameball, businesses can foster a sense of achievement and exclusivity. Segmenting the contact list based on tier progression allows for targeted communication, reinforcing customer engagement.
Set up automated email workflows to welcome new customers, acknowledge enrollment in the loyalty program, celebrate milestones, and send points redemption reminders.
Utilize Mailchimp's segmentation capabilities to categorize customers based on purchase history, demographics, and loyalty program engagement, facilitating tailored messages and rewards.
***
**If you need further assistance, [book a call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=mailchimp-article) now!**
***
Leverage Klaviyo integration.
Leverage Judge.me integration.
Leverage Omnisend integration.
# Boost Business Growth: Leveraging Omnisend Integration with Your App
Source: https://docs.gameball.co/product-documentation/apps-integrations/integration-use-cases/omnisend-use-cases
Check out some use cases and learn how to boost your business growth by leveraging Omnisend Integration with your app.
**Need help making the best out of your Gameball and Omnisend integration? [Book a Call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=omnisend-article) now!**
In the fast-evolving landscape of commerce, fostering customer loyalty and retention is pivotal for sustained growth and brand success. Integrating Omnisend, a powerful marketing automation platform, with a robust loyalty and retention platform like Gameball can significantly enhance customer engagement and drive long-term sales.
***
## Use Cases
Create personalized email workflows triggered by customer actions within the loyalty program, such as welcoming new members, acknowledging milestones, and offering exclusive rewards based on loyalty status.
**Example:** Tailor email content to reflect the customer's loyalty tier, previous purchase history, and preferred product categories. Incorporate dynamic product recommendations to encourage repeated sales.
Design targeted email and SMS campaigns specifically for inactive customers. Offer personalized incentives such as **bonus points** or **exclusive discounts** to encourage re-engagement.
**Example:** Use customer data to identify reasons for inactivity (expired points, missed rewards) and tailor messaging to address these pain points.
Set up automated email and SMS notifications to inform customers about their current loyalty points, upcoming rewards, and special promotions based on their loyalty program status.
**Example:** Include personalized product recommendations and encourage customers to take actions to unlock additional rewards or bonus points.
Create targeted email campaigns for specific customer segments based on engagement tiers, such as regular purchasers, high-tier loyalty members, or customers approaching a milestone.
**Example:** Highlight the benefits of reaching the next loyalty tier, showcasing exclusive perks and rewards they can unlock.
Implement a cohesive marketing strategy leveraging email, SMS, and social media to communicate about the loyalty program, upcoming rewards, and member-exclusive events.
**Example:** Coordinate messaging across all platforms for a consistent customer experience. Use social media to build anticipation for loyalty program events.
Incorporate feedback surveys within email communications, inviting customers to share thoughts about the loyalty program experience.
**Example:** Offer a small loyalty point bonus or discount for completing the survey, then use the feedback to improve the loyalty program.
***
**If you need further assistance, [book a call](https://meetings.hubspot.com/dania-osama/meet-with-dania?utm_source=gameball-dashboard\&utm_medium=homepage\&utm_campaign=omnisend-article) now!**
***
Leverage Klaviyo integration.
Leverage Mailchimp integration.
Leverage Judge.me integration.
# How Do I Integrate Intercom with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/intercom-integration
Keep your customers in sync across Gameball and Intercom, and target them based on your loyalty data, like current tier and points balance.
## Why Integrate Intercom with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Segment your contact lists** based on Gameball customer attributes.
* **Send personalized emails** by including Gameball customer information in email templates.
***
## How to Configure Intercom on Gameball
Go to **Apps** on your **Gameball Admin Dashboard** and click **Connect** under **Intercom**.
1. Install Intercom from the Shopify App Store.
2. Go to your **Intercom Developers Hub > Configure > Authentication**.
3. Copy the **API Key**.
Paste the API key into your Gameball account and click **Next**.
Click **Add** so the list of customer attributes will be automatically added to your Intercom account.
Make sure you use these attributes with the notation provided on your Gameball Admin Dashboard, as described below.
***
## Using Gameball Data in Intercom
Once connected, go to your Intercom account to segment lists using Gameball customer profile attributes, send personalized emails with Gameball attributes, and more.
# Gameball Apps Integration
Source: https://docs.gameball.co/product-documentation/apps-integrations/introduction-to-apps-integrations
Learn more about Gameball apps integration which can be used to push Gameball data or reward players based on actions from other apps.
Empower your loyalty and rewards program through one-click integrations with apps that help you retain your customers and ease so many of your daily tasks along with Gameball!
***
## Available Integrations
Email marketing and customer segmentation.
Customer messaging and support.
CRM and workflow automation.
Email marketing with loyalty data.
Reward customers for reviews.
Marketing automation and CRM.
Ecommerce marketing automation.
Product reviews and rewards.
Omnichannel marketing automation.
Customer data platform.
Connect with thousands of apps.
Customer engagement platform.
Deep linking for referrals.
Mobile attribution and deep links.
Subscription billing and rewards.
SMS marketing with loyalty data.
SMS marketing for Shopify.
Cross-channel customer engagement.
Personalized email campaigns.
Digital loyalty cards.
***
If you have any apps in mind that you would love to see integrated with Gameball, kindly email us at [support@gameball.co](mailto:support@gameball.co) with your app request.
# How Do I Integrate Judge.me with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/judge-me-integration
Create reward campaigns and rewards based on your customers' reviews that are done through your Judge.me app.
## Why Integrate Judge.me with Gameball?
This integration allows you to reward your customers based on their placed reviews, driving more reviews for your business and building trust with your customers.
To integrate Gameball with Judge.me, you must be on the **Awesome** plan on Judge.me.
***
## How to Configure Judge.me on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **Judge.me**.
1. Install Judge.me from the Shopify App Store.
2. In your Judge.me account, go to **Settings > Integrations**.
3. Copy the **API token**.
Paste the API key into your Gameball account and click **Verify Key**.
Click **Add** to automatically add the review event in the customers' events section on your Gameball Admin Dashboard.
Go to **Rewards > Reward Campaigns** and create the "review/judge me" campaign.
The `review_judgeme` event includes the following metadata: **Product ID**, **Product Title**, **Rating**, **has\_pictures** (true/false), and **has\_videos** (true/false).
To reward customers specifically for **photo reviews**, configure your campaign to filter on the `has_pictures` metadata property set to `true`. This lets you offer a higher reward for reviews that include a photo versus a text-only review.
Learn more about how to [configure your reward campaign](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign).
# How Do I Integrate Klaviyo with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/klaviyo-integration
Keep your customers in sync across Gameball and Klaviyo, and target them effectively based on their loyalty data and events.
| Platform | Plan |
| ---------- | ---- |
| Shopify | All |
| Self-serve | All |
Gameball and Klaviyo integration allows you to leverage customer engagement data from Gameball to power your email marketing campaigns in Klaviyo. Follow this guide to seamlessly connect the two platforms and maximize the impact of your loyalty and marketing efforts.
## Why Integrate Klaviyo with Gameball?
By integrating Klaviyo with Gameball, you unlock the ability to target and segment customers based on their loyalty to your app. This powerful integration allows you to:
* **Segment contact lists** based on Gameball customer attributes (e.g., points balance, tier) and events created.
* **Send personalized emails** by including loyalty-related data, such as customer tier and reward points, in your email templates.
* **Track and trigger campaigns** based on specific customer events, such as coupons created, orders placed, and reward achievements.
***
## How to Connect Klaviyo to Gameball
In your Gameball Admin Dashboard, navigate to **App Integrations** from the left-side menu. You will see a card for each available native integration.
Find the **Klaviyo** card and click **Connect**. You will be redirected to a Klaviyo OAuth screen asking you to authorize the connection.
Gameball will request access to the following scopes in your Klaviyo account:
| Scope | Permission |
| ------------ | --------------------------------------------------------- |
| **Accounts** | View account details |
| **Events** | Create, view, edit, and delete events |
| **List** | Create, view, edit, and delete lists and list memberships |
| **Profiles** | Create, view, edit, and delete profiles |
| **Webhooks** | Create, view, edit, and delete webhooks |
Click **Allow** to grant Gameball access. You can revoke this access at any time from your Klaviyo app settings.
Once authorized, the Klaviyo card will display a **Connected** badge confirming the integration is active.
***
## Using Gameball Data in Klaviyo
### View Custom Properties
In Klaviyo, view Gameball customer attributes under **Profile > Information > Custom Properties** of a specific customer.
### Use Attributes in Campaigns
When creating a campaign in Klaviyo, insert Gameball attributes by selecting **Insert Property**.
### Trigger Flows Based on Events
You can trigger automated flows in Klaviyo based on real-time Gameball events such as Coupon Created, Coupon Redeemed, Reward Campaign Achieved, Order Placed, and Points Redeemed.
Each event is synced in real-time, allowing you to send highly targeted campaigns and flows in Klaviyo.
***
Integrate Gameball with MoEngage for engagement campaigns.
Explore all available Gameball integrations.
# How Do I Integrate Klaviyo Reviews with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/klaviyo-reviews-integration
Create campaigns and rewards based on your customers' reviews that are done through your Klaviyo Reviews app.
Integrating Klaviyo Reviews with Gameball allows you to automatically receive review events, enabling you to reward customers, send notifications, and create custom automation campaigns.
## Setup Requirements
Ensure the Klaviyo Reviews app is installed in your store. [Learn More.](https://apps.shopify.com/klaviyo-reviews)
***
## Step-by-Step Integration
Log in to your Klaviyo account and select the **Flows** tab from the side menu.
Click **Create Flow**, choose **Build Your Own**, and enter a name for the flow when prompted.
1. Select **Metrics** as the trigger type.
2. Choose **Klaviyo** as the metric source.
3. Select **Submitted Review** as the event.
4. Click **Save**.
To exclude store-level reviews, add a trigger filter:
1. Click **Add** on the Trigger Filters card.
2. Select **Add Trigger Filter**.
3. Set the field `is_store_review` to **false**.
4. Click **Save**.
Set up the webhook action to send review event data to Gameball:
1. Select **Webhook Action**.
2. Set the Destination URL to: `https://api.gameball.co/api/v3/integrations/event`
3. Add the following header:
* **ApiKey**: `#{{Gameball API Key}}`
4. Add the JSON body:
```json theme={null}
{
"playerUniqueId": "#{{ person.external_id|default:'' }}",
"events": {
"review_submitted": {
"rating": "#{{ event.review_rating|default:'' }}",
"productId": "#{{ event.structured_product.id|default:'' }}",
"productTitle": "#{{ event.structured_product.product_name|default:'' }}",
"hasMedia": "#{{ event.review_has_media|default:'' }}"
}
}
}
```
5. Click **Save**.
After completing the setup, switch the flow to **Live** to start receiving events.
***
## Gameball Use Cases
With this integration, you can enhance your customer engagement by:
* **Reward Customers for Reviews** - Use Reward Campaigns to automatically grant points, discounts, or other incentives when customers leave a review. [Learn More](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign).
* **Automated Follow-Up Messaging** - Create Communication Campaigns that send targeted emails or notifications in response to customer reviews. [Learn More](/product-documentation/communication-campaigns/create-and-configure-email-campaigns).
* **Review-Triggered Automations** - Incorporate review events as triggers in Automation Campaigns to personalize customer journeys. [Learn More](/product-documentation/automation-campaigns/how-to-create-an-automation-campaign).
***
Set up the main Klaviyo integration with Gameball.
Reward customers for Judge.me reviews.
# How Do I Integrate Mailchimp with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/mailchimp-integration
Send email communications to your customers and segment lists based on your loyalty data, like current tier and points balance.
## Why Integrate Mailchimp with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Segment your contact lists** based on Gameball customer attributes.
* **Trigger automations** based on Gameball customer attributes.
* **Send personalized emails** by including Gameball customer information in email templates, such as the customer's current tier.
***
## How to Configure Mailchimp on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **Mailchimp**.
1. Install Mailchimp from the Shopify App Store.
2. In your Mailchimp account, go to **Settings > Integrations**.
3. Copy the **API key**.
Paste the API key into your Gameball account and click **Next**.
Choose a list you would like your Gameball customer attributes to be synced to.
Click **Add** so the list of customer attributes will be automatically added to your Mailchimp account.
Make sure you use these attributes with the notation provided on your Gameball Admin Dashboard, as described below.
You're all set! Now segment your contact list and add reward information to your campaigns.
# How Do I Integrate MoEngage with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/moengage-integration
Enhance Your Customer Engagement with Gameball Integration with MoEngage
[MoEngage](https://www.moengage.com/) is an Intelligent Customer Engagement Platform that allows brands to personalize every customer interaction, driving better engagement, retention, loyalty, and lifetime value. The MoEngage and Gameball integration enables you to harness the full potential of both platforms to enhance your customer engagement strategies.
***
## Data Import Scenarios
The integration between Gameball and MoEngage ensures that your customer data is always up-to-date. Gameball's customer attributes will be imported into MoEngage whenever a customer is created or performs any action.
**Trigger:** Upon customer creation or after any new action (e.g., achievement, transaction, points expiry).
Gameball's customer attributes will be imported and updated in MoEngage automatically. The following data is synced:
| # | Gameball Attribute |
| -- | -------------------------------------------- |
| 1 | Account State |
| 2 | Join Date |
| 3 | Birthday |
| 4 | Country |
| 5 | City |
| 6 | Tier Name |
| 7 | Wallet Points |
| 8 | Pending Points |
| 9 | Active Points |
| 10 | Tier Progress |
| 11 | Tier ID |
| 12 | Completed Reward Campaigns |
| 13 | Referral Code |
| 14 | Referral Link |
| 15 | Tags and Segments |
| 16 | Latest Created Coupon |
| 17 | Latest Used Coupon |
| 18 | Total Net Amount of Transactions |
| 19 | Earned Points |
| 20 | Expired Points |
| 21 | Redeemed Points |
| 22 | Next Expiring Points Amount |
| 23 | Next Expiring Points Value |
| 24 | Next Expiring Points Date |
| 25 | Starting Store |
| 26 | Average Basket Size |
| 27 | First Captured Order Date |
| 28 | Connecting Store |
| 29 | Store of First Transaction |
| 30 | Transactions Amount in the Last Rolling Year |
| 31 | Unit per Transaction |
| 32 | Last Order Awarded Points |
| 33 | Currency |
| 34 | Source |
**Trigger:** Order placed by customer and received by Gameball.
Once an order is placed, the following order data is sent to MoEngage:
| Attribute | Description |
| ----------------------- | --------------------------------- |
| Order ID | Unique order identifier |
| Order Date | Date the order was placed |
| Total Paid | Amount paid by the customer |
| Total Price | Full order price |
| Total Shipping | Shipping cost |
| Total Tax | Tax amount |
| Total Discount | Discount applied |
| Discount Codes | Codes used |
| Redeemed Amount | Points redeemed as currency |
| Rewarded Points | Points earned from order |
| Equivalent Points Value | Monetary value of rewarded points |
**Trigger:** Coupon created for the customer.
The following coupon details will be available on MoEngage:
* Coupon Code
* Type
* Value
* Coupon Name
**Trigger:** Customer used a coupon while placing an order.
The following details will be available on MoEngage:
* Coupon Code, Type, Value, Coupon Name
* Order ID, Order Quantity
* Channel (POS, Online, etc.)
**Trigger:** Customer achieved a reward campaign.
The following details will be available on MoEngage:
* Internal Name, Name
* Reward (Points, Points & Score, Coupon Values)
* Coupon Type (if the reward was a coupon)
* Equivalent Value of Rewarded Points
* Achievement Date
**Trigger:** Customer redeemed their saved points.
Each `points_redeemed` event includes:
* Redeemed Points
* Redemption Amount
* Redemption Transaction ID (if available)
**Trigger:** Order received by Gameball.
An "Item Purchased" event is sent to MoEngage for each line item with the following attributes:
* Order ID, Product Title, Product Price, Vendor Name
* Product ID, Weight, Quantity, SKU
* Collections Array, Tags Array, Categories Array
* Any extra attributes added to the object
**Trigger:** Customer removed from Gameball.
Once a customer is deleted from Gameball, the customer gets deleted from MoEngage after **24 hours**.
You have the option to disable the deletion feature from MoEngage.
Workspace context is included in both customer events and attributes, giving you greater flexibility in segmentation and personalization.
* **`gameball_workspace`**: a string containing the workspace name or ID.
* **Gameball Workspace**: a string attribute storing the associated workspace.
***
## How to Set Up the Integration
Go to the **App Store** on Gameball's dashboard and select **MoEngage** from the list of available app integrations.
Enter the **App ID** and **Data API Key** from MoEngage's settings page.
Select your **Data Center**.
If you're unsure which data center you're on, you can find your code in your dashboard's URL.
Complete the setup and start leveraging the powerful combination of Gameball and MoEngage.
***
## How to Use the Data on MoEngage
Once the data from Gameball is imported into MoEngage, you can leverage it to create more personalized and effective customer engagement strategies:
1. **Personalized Campaigns** - Use customer attributes such as name, email, birthday, and purchase history to create highly personalized marketing campaigns.
2. **Segmentation** - Utilize synced segments and tags to group customers based on their behavior, preferences, and activity.
3. **Event-Triggered Campaigns** - Set up automated campaigns triggered by specific events such as order placement, coupon creation, or coupon usage.
4. **Customer Journey Mapping** - Track and analyze the customer journey using imported data to identify key touchpoints.
5. **Retention Strategies** - Monitor points balance, tier progress, and achievements to identify loyal customers and those at risk of churning.
***
Connect Gameball with thousands of apps via Zapier.
Explore all available Gameball integrations.
# How Do I Integrate Omnisend with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/omnisend-integration
Keep your customers in sync across Gameball and Omnisend, and target them based on your loyalty data.
## Why Integrate Omnisend with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Segment your contact lists** based on Gameball customer attributes.
* **Trigger automations** based on Gameball customer attributes.
* **Send personalized emails** by including Gameball customer information in email templates, such as the customer's current tier.
***
## How to Configure Omnisend on Gameball
Go to **Integrations** on your **Gameball Admin Dashboard** and click **Connect** under **Omnisend**.
1. Install Omnisend from the Shopify App Store.
2. In your Omnisend account, go to **Store Settings > Integrations & APIs**.
3. Copy the **API Key**.
Paste the API key into your Gameball account and click **Next**.
Click **Add** so the list of customer attributes will be automatically added to your Omnisend account.
Make sure you use these attributes with the notation provided on your Gameball Admin Dashboard, as described below.
***
## Using Gameball Data in Omnisend
### Check Custom Properties
Go to your Omnisend account to check customer contact details, including Gameball customer profile attributes.
### Send Personalized Emails
Use Gameball custom attributes by clicking **Insert Personalization > Contact > Custom Properties** and choosing a Gameball custom property.
# How Do I Integrate Postscript with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/postscript-integration
Integrate Gameball with Postscript to Enhance Your SMS Marketing Campaigns.
Gameball and Postscript integration allows you to leverage customer engagement data from Gameball to power your SMS marketing campaigns in Postscript. Follow this guide to seamlessly connect the two platforms and maximize the impact of your loyalty and marketing efforts.
## Key Benefits
* **Increase Engagement:** Use loyalty data to deliver messages at pivotal moments in a customer's journey.
* **Boost Conversion Rates:** Tailor SMS campaigns with Gameball data for higher conversions.
* **Automate for Consistency:** Set automated flows to keep your brand top-of-mind with your customers.
## Integration Highlights
This integration enables you to:
1. **Add Loyalty Data to Subscriber Profiles** - Gameball loyalty data, like points balance and loyalty tier, appears as custom properties within Postscript.
2. **Automate Messaging with Loyalty Triggers** - Trigger flows based on loyalty events, such as points earned.
3. **Segment for Targeted Campaigns** - Use Gameball properties to create specific customer segments in Postscript.
4. **Personalize Communication Campaigns** - Customize SMS content using Gameball properties.
***
## Prerequisites
Before starting the integration, ensure the following:
* You have an active **Gameball** account.
* You have an active **Postscript** account.
* Access to admin permissions in both platforms.
***
## How to Configure Postscript on Gameball
1. Log in to your **Postscript Dashboard**.
2. Go to **Settings > API**.
3. Click **Create Security Key Pair**.
4. Once the new key is generated, enter the label.
5. Click **Show** and copy the private key.
1. Log in to your **Gameball Dashboard**.
2. Navigate to **Integrations** from the left menu.
3. Select **PostScript** and click **Connect**.
4. Paste the **Generated API Key** from PostScript and click **Next**.
***
## Synced Events
Gameball automatically maps the following events to Postscript:
* **Coupon Created**
* **Coupon Redeemed**
* **Reward Campaign Achieved**
* **Order Placed**
***
## Synced Customer Data
The following customer attributes are automatically synced:
| Attribute | Property Key |
| -------------------------- | ------------------------- |
| Customer ID | `gb_id` |
| Date of Birth | `gb_birthday` |
| Join Date | `gb_join_date` |
| Tier Name | `gb_level_name` |
| Wallet Points | `gb_wallet_points` |
| Pending Points | `gb_pending_points` |
| Tier Progress | `gb_level_name` |
| Tier ID | `gb_level_id` |
| Completed Reward Campaigns | `gb_completed_challenges` |
| Referral Code | `gb_referral_code` |
| Referral Link | `gb_referral_link` |
| Tags and Segments | `gb_tags_and_segments` |
***
## Creating Segments Based on Loyalty Data
1. From your Postscript Dashboard, go to **Messaging**.
2. Click **Segments > Create Segment**.
3. Enter the name of your new segment.
4. Below **Segment Criteria**, click on the pre-selected filter to replace it.
1. From the dropdown menu, select any of the Gameball available attributes.
2. Optionally, click **+ Add Rule** to add an `or` connector within the same filter.
3. Optionally, add more filters for your segment if needed.
4. Click **Save Segment**.
***
## Other Suggested Setups
1. **Trigger Automation Flows** - Within Postscript, set up an automation flow. Choose from the Gameball events listed (e.g., **Points Earned**) and configure personalized SMS content for each event.
2. **Personalize Communication Campaigns** - Use Gameball properties directly in SMS content, enabling unique and relevant messages for each customer's loyalty journey.
***
## Frequently Asked Questions
We've built a retry mechanism for quick data synchronization. However, if you encounter delays, check your integration settings or contact support.
Yes, only Gameball-related loyalty data is passed to Postscript, ensuring data safety and compliance with privacy regulations.
***
Integrate Gameball with MoEngage for engagement campaigns.
Automate loyalty workflows with Shopify Flow.
# How Do I Integrate Recharge with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/recharge-integration
Reward your customers with Subscription-Based coupons by connecting Gameball & Recharge Subscription app
| Platform | Plan |
| -------- | ------------------- |
| Shopify | Starter, Pro & Guru |
[Recharge](https://getrecharge.com/) is a leading subscription billing platform that enables merchants to offer flexible subscription options to their customers, including recurring billing, customer management, and more.
Integrating your Gameball account with Recharge allows you to create, manage, and distribute subscription-based coupons directly through the Recharge platform. This integration helps you offer flexible, subscription-based incentives like fixed-rate or percentage-based discounts.
***
## How to Set Up the Integration
1. Log in to your **Gameball Dashboard**.
2. Navigate to **Integrations** from the left-side menu.
3. Select **Recharge** from the app list, then click **Connect**.
Add your Recharge account **API Key** and click **Next**.
Once authenticated, Recharge will appear in the list of your connected apps.
With the Recharge integration enabled, you can now create two types of Recharge-specific rewards from your Gameball dashboard, whether you're creating a **redemption rule** or a **campaign reward**:
* **RechargeFixed** - Offers a fixed discount amount to subscribers (e.g., \$50 discount). [Learn More](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types)
* **RechargePercentage** - Provides a percentage-based discount on subscription plans (e.g., 50% discount). [Learn More](/product-documentation/rewards-campaigns/faqs/understanding-rewards-types)
***
## Use Cases
1. **Enhance Customer Retention with Subscription-Based Rewards** - Use the integration to offer exclusive discounts on subscriptions. For example, create a `RechargeFixed` reward to give loyal customers a flat discount on their next month's subscription.
2. **Boost Subscriptions with Limited-Time Discounts** - Create `RechargePercentage` rewards to offer percentage-based discounts for a limited period, driving new sign-ups and encouraging upgrades.
3. **Target High-Value Subscribers** - Leverage Gameball's segmentation capabilities to identify and reward high-value subscribers with tailored discounts through the Recharge platform.
***
Set up how customers redeem their points.
Learn about the different reward types in Gameball.
# How Do I Integrate Segment with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/segment-integration
Save yourself the hassle of having to go through a technical integration with the help of developers with Segment integration.
## Why Integrate Segment with Gameball?
This integration allows you to target and segment your customers based on how loyal they are to your app. With this integration, you can:
* **Segment your contact lists** based on Gameball customer attributes.
* **Trigger automations** based on Gameball customer attributes.
* **Send personalized emails** by including Gameball customer information in email templates, such as the customer's current tier.
***
## How to Configure Segment on Gameball
Add the events you want to track in the **Gameball Admin Dashboard**. For more info on how to do that, [check out this article](/product-documentation/admin-settings/create-and-send-events).
Add the Gameball app as a destination from the Segment catalog. Then add your Gameball API Key in the destination settings on Segment. Learn [where to find your Gameball API key](/product-documentation/admin-settings/get-api-keys).
Ensure that the events you track reach Gameball through the Event Tester on Segment with the Event Builder.
In this example, the Event name is "Buy product" and the type is "shoes".
The **Event Name** in Event Tester on Segment must match the Event Name in the **Gameball Admin Dashboard**, and you must include the `userId`.
You can also verify events through the Event Tester in Segment using the JSON Builder.
The only properties supported for updating through events at the moment are: ID, Join Date, Level Name, Type ID, Points, Score Balance, Level ID, and Completed Challenges.
# How Do I Set Up Gameball on Shopify Flow?
Source: https://docs.gameball.co/product-documentation/apps-integrations/shopify-flow/introduction-to-shopify-flow
Use Gameball's triggers and actions in your automated workflows with Shopify Flow
| Platform | Plan |
| -------- | --------- |
| Shopify | All Plans |
Shopify Flow is available on all Shopify plans, including Free — as long as your Shopify account has Shopify Flow enabled.
With Gameball's integration into Shopify Flow, you can now automate and enhance your customer loyalty and engagement programs more effectively. This article walks you through the available triggers and actions, how to set them up, and examples of how to use Gameball with Shopify Flow.
***
## Triggers
This trigger activates when a customer tiers up or down, either manually or automatically.
*Example: When a customer's tier changes to the Gold tier.*
This trigger activates when a customer achieves a new Reward Campaign, either manually or automatically.
*Example: When a customer earns a new reward campaign when they complete their First Order.*
This trigger activates once a customer is added to a new Segment.
*Example: When a customer is placed in the Inactive segment.*
This trigger activates once a customer adds their birthday to Gameball's widget.
***
## Actions
This action allows you to send a custom event to Gameball. [Learn how to set it up.](#send-an-event-setup)
*Example: A customer completed a survey, so we will send this event (Survey\_Completed) to Gameball.*
This action is only available on the **Guru Plan**.
This action rewards a customer with a specified Reward Campaign manually. [Learn how to set it up.](#reward-a-campaign-setup)
*Example: Rewarding a customer with the 'Completed First Order' Reward Campaign.*
This action deducts a specified number of points from a customer's account for a given reason. [Learn how to set it up.](#deduct-points-setup)
*Example: Deducting 50 points from a customer's balance for a reward they got in-store.*
This action adjusts a customer's tier to a specified tier name. [Learn how to set it up.](#adjust-customer-tier-setup)
*Example: Adjusting the customer tier from the Bronze tier to the Gold tier.*
This action adds a specified number of points to a customer's account for a given reason. [Learn how to set it up.](#add-points-setup)
*Example: Adding 100 points for a customer for adding a review on your product.*
***
## Action Setups
### Send an Event Setup
This action allows you to send a custom event to Gameball.
**Attributes:**
* **Customer Email**: Skip the email if the trigger already passes the ID. Select it from "Add a variable".
* **Event Name**: The event name to be sent to Gameball.
* **Event Attribute Name X**: The event attribute name (up to 5 attributes).
* **Event Attribute Value X**: The event attribute value.
This action is only available on the **Guru Plan**.
### Reward a Campaign Setup
This action rewards a customer with a specified Reward Campaign manually.
**Attributes:**
* **Customer Email**: Skip the email if the trigger already passes the ID. Select it from "Add a variable".
* **Campaign ID**: Copy the ID next to the title on the campaign details page in Gameball.
### Deduct Points Setup
This action deducts a specified number of points from a customer's account.
**Attributes:**
* **Customer Email**: Skip the email if the trigger already passes the ID.
* **Points to be deducted**: Number of points to deduct.
* **Reason**: Reason for deducting the points.
### Adjust Customer Tier Setup
This action adjusts a customer's tier to a specified level name. You can choose the level behavior (forever, until a specific date, or evaluated normally).
**Attributes:**
* **Customer Email**: Skip the email if the trigger already passes the ID.
* **Tier Order**: The tier number in Gameball (e.g., 1, 2, 3).
* **Tier Behavior**:
* **System Evaluate**: Based on Gameball's evaluation according to the chosen tiering-up method.
* **Forever**: The customer stays on this tier unless manually reassigned.
* **Temporarily till Specific Date**: The customer stays on the tier until a specific date.
* **Temporarily Specific Date**: If selected, add the date in format `yyyy-MM-dd`.
* **Reason**: The reason for the tier adjustment.
### Add Points Setup
This action adds a specified number of points to a customer's account.
**Attributes:**
* **Customer Email**: Skip the email if the trigger already passes the ID.
* **Points to be added**: Number of points to add.
* **Reason**: Reason for adding the points.
***
## Setting Up Gameball Triggers and Actions in Shopify Flow
From your Shopify admin, go to **Apps > Shopify Flow**.
Click **Create Workflow** and choose a trigger from the Gameball triggers listed above.
Set up the trigger by selecting the appropriate variables and conditions.
Select an action from the Gameball actions listed above and configure it with the necessary details.
Test your workflow to ensure it works as expected, then activate the workflow.
***
## Use Cases
### 1. Rewarding Customers Who Gave a Review
* **Trigger:** Use an external reviews app like Reviews.io to trigger the action whenever a customer leaves a review.
* **Action:** Use Gameball's **Reward a Campaign** action to reward customers for their feedback.
See a live example: [Reviews.io integration via Shopify Flow](/product-documentation/apps-integrations/shopify-flow/reviews-io-integration).
### 2. Adding Points for Survey Completion
* **Trigger:** Use an external survey app, such as Okendo, to trigger the action when a customer completes a survey.
* **Action:** Gameball will automatically **Add Points** to the customer's account.
### 3. Celebrate Customer's 3-Year Anniversary
* **Trigger:** Set a date trigger to recognize when a customer has been with your store for three years.
* **Action:** Use Gameball's **Send Event** action to trigger a personalized communication campaign.
***
Reward customers for Reviews.io reviews.
Reward customers for Yotpo reviews.
# How Do I Integrate Reviews.io Through Shopify Flow?
Source: https://docs.gameball.co/product-documentation/apps-integrations/shopify-flow/reviews-io-integration
Reward your customers for their valuable feedback using Gameball's integration with Reviews.io via Shopify Flow.
With Gameball's integration with Reviews.io through Shopify Flow, you can automatically reward customers for leaving reviews. This integration helps boost customer engagement and loyalty by offering incentives for valuable feedback.
## Benefits
* **Increased Engagement** - More reviews lead to higher interaction with your brand.
* **Strengthened Loyalty** - Rewarding customers for their feedback builds stronger relationships.
* **Valuable Insights** - Gain more insights through increased review volume.
***
## Setup Guide
1. Log in to the **Gameball Dashboard**.
2. Navigate to **Campaigns > Rewards > Create Reward Campaign**.
3. Select the **Shopify Flows' Write a Review** template under **Social Sharing & Reviews**.
4. Configure your campaign settings and click **Save**.
5. Copy the **Campaign ID**.
1. Open Shopify Flow and create a new workflow.
2. Set **Reviews.io** as your **trigger**.
3. Choose Gameball's **Reward a Campaign** as the **action**. [Learn More](/product-documentation/apps-integrations/shopify-flow/introduction-to-shopify-flow)
* Add your customer **email** by clicking **Add variable**.
* Copy and paste the **Campaign ID** from the campaign details page on Gameball.
4. Activate your workflow and track its impact on customer engagement.
***
Learn more about Shopify Flow triggers and actions.
Set up Yotpo reviews integration.
# How Do I Integrate Yotpo Through Shopify Flow?
Source: https://docs.gameball.co/product-documentation/apps-integrations/shopify-flow/yotpo-integration
Use Gameball's integration with Yotpo through Shopify Flow to reward your customers for their valuable feedback.
Through Gameball's integration with Yotpo via Shopify Flow, you can automatically reward customers for leaving reviews. This seamless integration enhances customer engagement and loyalty by providing incentives for their valuable feedback.
## Benefits
* **Increased Engagement** - More reviews lead to higher interaction with your brand.
* **Strengthened Loyalty** - Rewarding customers for their feedback builds stronger relationships.
* **Valuable Insights** - Gain more insights through increased review volume.
***
## Setup Guide
1. Log in to the **Gameball Dashboard**.
2. Navigate to **Campaigns > Rewards > Create New Reward Campaign**.
3. Select the **Shopify Flows' Write a Review** template under **Social Sharing & Reviews**.
4. Configure your campaign settings and click **Save**.
5. Copy the **Campaign ID**.
1. Open Shopify Flow and create a new workflow.
2. Set **Yotpo** as your **trigger**.
3. Choose Gameball's **Reward a Campaign** as the **action**. [Learn More](/product-documentation/apps-integrations/shopify-flow/introduction-to-shopify-flow)
* Add your customer **email** by clicking **Add variable** (skip the email if the trigger already passes the ID).
* Copy and paste the **Campaign ID** from the campaign details page on Gameball.
4. Activate your workflow and track its impact on customer engagement.
***
Learn more about Shopify Flow triggers and actions.
Set up Reviews.io reviews integration.
# How Do I Integrate Zapier with Gameball?
Source: https://docs.gameball.co/product-documentation/apps-integrations/zapier-integration
Connect Gameball with other apps on Zapier to create Zaps where you can send events or exchange customer data with Gameball.
If you are using Zapier on your platform for workflows or automation, use Gameball to engage and reward your customers with a few simple clicks.
## Why Integrate Zapier with Gameball?
Using Gameball with Zapier allows you to send events to Gameball in order to reward your customers for completing and performing certain actions on hundreds of other platforms, like subscribing to a newsletter, clicking on a link inside an email, and much more!
Before you log in to your Zapier account and start connecting other apps to Gameball, make sure to create and configure these events through the Gameball dashboard. To learn more about recommended events and how to configure them, check this [article](/product-documentation/guides-strategies-faqs/supportive-guides/ecommerce-events).
***
## Quick Start Example
Here's how to connect Judge.me to Gameball, where Judge.me sends an event to Gameball every time a new review is written so that Gameball can reward your customers for writing reviews.
Log in to your **Zapier Dashboard** and search for Judge.me and Gameball to connect them.
Make sure you use Gameball V1.1.
Select the **trigger New Review** on Judge.me and **Send Event** action on Gameball.
You have now successfully connected Judge.me with Gameball. Your customers will be rewarded according to your Gameball configuration.
Enjoy connecting more apps to Gameball to reward your customers or to keep data synced.
***
Explore Gameball templates and use cases on Zapier.
Step-by-step guide to connect Gameball with any app on Zapier.
# How Do I Connect Gameball with Apps on Zapier?
Source: https://docs.gameball.co/product-documentation/apps-integrations/zapier/connect-gameball-with-apps
Step by step guide to creating a connection between Gameball and any other app on Zapier.
Learn how to use Zapier to let Gameball reward your players after completing actions on other apps like subscribing, submitting a survey, reactivating an account, completing payments, and more.
A Zap consists of a trigger and an action. Gameball works as an action. Read more on [Gameball on Zapier](/product-documentation/apps-integrations/zapier-integration).
***
## How to Create a Zapier Connection
1. Go to [zapier.com](http://zapier.com).
2. In the left box, search for any app you want to set as the [trigger app](/product-documentation/apps-integrations/zapier/connecting-gameball-to-zapier).
In this guide, we will use **SurveyMonkey** as the trigger app to reward players upon survey form submission. You must be on a paid plan on SurveyMonkey to use this feature.
3. Search for **Gameball** in the right box.
4. Select a trigger, then choose **Send Event** as the Gameball action.
5. Click **Try it**.
A **trigger** is any event that starts a Zap. Read more on [triggers](https://zapier.com/help/create/basics/set-up-your-zap-trigger) on Zapier.
In this use case, make sure your players submit their email addresses in the survey. The email address submitted must match the one stored at Gameball.
**A. Choose App and Event** - Select SurveyMonkey and "New Response Notification" as the trigger event.
**B. Choose Account** - Select the SurveyMonkey account you are expecting campaigns through.
**C. Customize Response** - Choose the name of the survey you're expecting the response to.
**D. Choose Collector** - Choose the collector you're expecting this response on.
A collector on SurveyMonkey is a shorthand for describing the way responses are being collected.
**E. Test Trigger** - Click "Test trigger" to make sure your trigger is working fine before customizing your Zap.
An **action** is a job your Zap does once your trigger event occurs. Read more on [actions](https://zapier.com/help/create/basics/set-up-your-zap-action) on Zapier.
**A. Choose App & Event** - Choose Gameball as the app and "Send Event" as the action.
**B. Choose Gameball Account**
You might need to add your API key. Learn [where to find your Gameball API key](/product-documentation/admin-settings/get-api-keys).
**C. Customize Event** - Add the event name, event metadata (if needed), and player email.
Make sure you add the name in this format: `appname_eventname`. Leave metadata empty if not needed. Add the player email to choose the player you want to reward.
If you enter an email for a player that is not already created on Gameball, the player will be created automatically.
**D. Send Data** - Click **Test & Review** or **Test & Continue**.
Without testing the connection between the two apps and solving all errors, the trigger event will not be sent to Gameball, and you will not be able to reward your players even if they complete the required action.
Finally, click **Turn on Zap**.
Log in to your **Gameball Admin Dashboard**, go to **Programs > Challenges**, and click **Add New Challenge**.
**A. Set Challenge Type** - Choose **Event-based** as the challenge type and click **Next**.
**B. Set Challenge Details and Rewards** - Set the challenge details (internal name, displayed badge, displayed information) and choose the reward size (points and score).
**C. Set Challenge Settings** - Click the **Edit Icon** next to **Challenge Settings** to configure activation, visibility, unlocking, repeatability, and notification settings.
**D. Set Event Settings** - From the event list, choose the corresponding **Event Name** you added during the "Customize Event" step. Make sure the number of times to complete is **one**.
Review the configured steps, make edits if needed, then click **Save**. Your players will start earning this challenge upon survey form submission!
***
Explore Gameball templates and use cases on Zapier.
# How Do I Connect and Use Gameball on Zapier?
Source: https://docs.gameball.co/product-documentation/apps-integrations/zapier/connecting-gameball-to-zapier
Learn why and how to use Zapier with Gameball and explore the different Gameball use cases that you can apply on Zapier.
Zapier is one of the most popular tools that lets you connect two or more different apps or services to send and receive various types of information between them, and automatically execute actions based on your pre-given instructions. This helps you automate repetitive tasks, saving you time and effort.
If for example, you want Gameball to reward players when they make a specific action on a different app, Zapier is the perfect tool to help with that.
***
## How Does Zapier Work?
If you are connecting two different applications using Zapier, Zapier can execute an action on one of the two applications when a certain trigger happens on the other one. For example, once you receive a certain type of email on Gmail (trigger application), Zapier can then send you a message on Slack notifying you of the email.
Zapier now lets you connect Gameball with thousands of other apps. You can let Zapier execute actions on Gameball when a trigger is pulled from any other app.
***
## Gameball Templates on Zapier
Gameball created ready-to-use integration templates between some apps and Gameball. By clicking on any of the templates, you will be redirected to Zapier with the configuration set and ready to be deployed.
* [Give rewards to Gameball players with new Mailchimp subscriptions](https://zapier.com/app/editor/113440029?simple=true)
* [Relay Gameball rewards for new links clicked through Mailchimp emails](https://zapier.com/app/editor/113440316?simple=true)
* [Give rewards to players in Gameball for new Drip subscriptions](https://zapier.com/app/editor/113440815?simple=true)
* [Reward Gameball players when new ReCharge subscriptions are created](https://zapier.com/app/editor/113441392?simple=true)
* [Reward players in Gameball when ReCharge subscriptions are reactivated](https://zapier.com/app/editor/113441611?simple=true)
* [Reward players through Gameball for new PayPal completed payments](https://zapier.com/app/editor/113441868?simple=true)
* [Send rewards from Gameball to new GoToWebinar attendees](https://zapier.com/app/editor/113442223?simple=true)
* [Give rewards to new GoToWebinar registrants with Gameball](https://zapier.com/app/editor/113443063?simple=true)
* [Relay rewards to new Crowdcast registrants through Gameball](https://zapier.com/app/editor/113443492?simple=true)
* [Provide Gameball rewards to new Crowdcast webinar attendees](https://zapier.com/app/editor/113443695?simple=true)
* [Send rewards to Gameball players with new Crowdcast recording views](https://zapier.com/app/editor/113443909?simple=true)
* [Give Gameball rewards for new orders in Facebook Shops](https://zapier.com/app/editor/113445071?simple=true)
* [Reward new customers in Stripe through Gameball](https://zapier.com/app/editor/113444055?simple=true)
* [Reward Gameball players for scheduling events through Calendly](https://zapier.com/app/editor/113444331?simple=true)
* [Reward players through Gameball for new form submissions in Unbounce](https://zapier.com/app/editor/113444541?simple=true)
* [Reward Gameball players for scheduling meetings in Google Calendar](https://zapier.com/app/editor/113444765?simple=true)
***
Step-by-step guide to connect Gameball with any app on Zapier.
# What Are Attributes Across Automation Nodes?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/attributes-across-automation-nodes
Find all the events and attributes you will find while creating an automation.
You can use attributes to set your own rules for each trigger, action, or control. Here is how attributes work in automations.
By clicking the **Plus Icon** inside any trigger or actions, a small pop-up will appear giving you a list of attributes under 3 different tabs:
Dynamic attributes passed by previously chosen Event, Condition, or API (such as Order ID, Points Earned, or Friend Name). Variables depend on attributes used in the previous trigger or action.
All customer-related variables such as name, ID, number, referral link, etc.
Variables related to your general configurations, like chosen currency, points name, score name, etc.
Here is a list of attributes you will find while creating your automation:
Dynamic attributes passed from the preceding node. Available variables depend on what was used in the prior trigger or action — see the [event-specific tables below](#subsequent-variables-by-event-type).
| Variable |
| -------------------------- |
| Unique ID |
| First Name |
| Last Name |
| Display Name |
| Customer's Mobile |
| Referral Link |
| Mobile Referral Link |
| Points |
| Tier Up Total Progress |
| **Remaining to Next Tier** |
| Score Name |
| Coupon Code |
| Coupon Value |
| Reward Campaign Reward |
| Tier Entry Reward |
| Tier Lifetime Reward |
| location |
| membershipLevel |
| graduationDate |
| isMarried |
| occupation |
| company |
| hobbies |
| Variable |
| -------------------------------- |
| Equivalent Value of Total Points |
| Currency |
| Points Name |
| Referral Link |
| Mobile Referral Link |
***
## Carry Over Attributes Across Automation Nodes
Dynamic attributes are passed from one node to another, such as Order ID, Points Earned, or Friend Name, from one node to another inside your automations. This enables richer personalization, smarter branching, and more context-aware automation actions.
### Why This Matters
Previously, attributes generated in one node (e.g., an event or Add Points) couldn't be reused later in the same automation. That meant messages and actions couldn't dynamically reflect the context of the customer's previous interactions.
Now, attributes flow seamlessly across nodes, allowing for **smarter, fully contextual automation journeys**.
***
## How It Works
Attributes created or received in one node (Event, Condition, or API) are automatically available to all subsequent nodes in the same automation branch. Attributes remain accessible for personalization in later actions.
Action nodes (e.g., Send Email, Send SMS, Assign Points) can now reference these carried-over attributes. The variable picker in the dashboard displays available attributes grouped by source node.
If an earlier node is edited or removed, any dependent attributes trigger a warning: "This attribute is no longer available." Missing attributes are safely replaced with placeholders to prevent automation errors.
***
## Subsequent Variables by Event Type
Here are some examples of what you will find as a subsequent of a chosen first attribute:
### Place Order
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `place_order` | `channel_type`, `paymentMethod`, `subClass`, `discount_codes`, `campaign`, `title`, `branch_name`, `merchant_name`, `cart_id`, `unique_items`, `total_items`, `source`, `product_sku`, `product_id`, `Weight`, `product_vendor`, `Tag`, `product_category`, `order_id`, `total_price`, `total_discount`, `collection_id` |
### View Product Page
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `view_product_page` | `product_category`, `product_vendor`, `product_title`, `product_id`, `customer_id`, `shop_name`, `collection_id` |
### Friend Referred
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Friend Referred | `discount_codes`, `total_discount`, `merchant_name`, `merchant_id`, `total_price`, `referred_friend_name`, `referred_friend_id` |
### Add to Cart
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `add_to_cart` | `cart_id`, `collection_id`, `product_id`, `unique_items`, `vendor`, `total_items`, `total_discount`, `total_price` |
### Order Refunded
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ------------------------------------------------------------- |
| `order_refunded` | `order_id`, `refunded_points`, `refunded_amount`, `refund_id` |
### Points Redeemed
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ---------------------------------------------------------------- |
| Points Redeemed | `reference_transaction_id`, `redeemed_amount`, `redeemed_points` |
### Tier Changes
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | -------------------------------------------------------------------------------- |
| Tier Changes | Tier Lifetime Reward, Tier Entry Reward, Previous Tier, Next Tier, Achieved Tier |
### Reward Campaign Achieved
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------- |
| Reward Campaign Achieved | How to redeem Instructions, Coupon Code, Campaign Reward Value, Campaign Reward, Campaign Name |
### Expiring Points
| Event/attribute chosen in the first Node | Subsequent variables in the next nodes under "Previous Steps" |
| ---------------------------------------- | --------------------------------------------------------------------------- |
| Expiring Points | Next Expiring Points Date, Next Expiring Points Value, Next Expiring Points |
# What Are Automation Actions?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/automation-actions
Learn more about Gameball's Automation Campaigns actions, and how to use them.
Automation actions are the building blocks of effective workflows, allowing you to deliver personalized experiences and drive engagement. In this article, we'll explore the diverse range of automation actions offered by Gameball, providing detailed insights into their functionalities and implementation.
## Exploring Automation Actions
Automation actions enable you to automate tasks and deliver targeted communications to customers based on specific triggers and conditions.
Send customers a customized email once a workflow is triggered or a condition is met. With Gameball, you can craft compelling email messages tailored to your audience, maximizing the impact of your communication efforts.
### How to compose an email
Click on **Configure Email** on the card.
From the pop-up window to the side, fill in the email header fields:
* **From Name:** the name of your business, or representative.
* **From Email:** the email you want to appear in the email header. No need to write the domain here.
* **Domain:** pick the email address's domain. If the domain is not saved on Gameball, click **Change domain** and add it through **Gameball's Admin Settings**.
* **Subject:** write a single line appealing for more open rates. Make sure it's descriptive of the email content.
Write the body content of your email.
Press **Save**.
#### Sending Test Email
You can send a test email to yourself when using the "**Send Email**" as an action to a trigger in an automation. Click **Send test Message** after composing your email to review it before you launch the automation campaign.
### View Sent & Clicked Email Analytics Within Automation
You can view **email performance metrics**, including **Sent** and **Clicked** counts, directly inside each **Send Email** action node in your automations.
Each **Send Email** action node now displays:
* **Emails Sent**: the total number of successfully delivered emails (excluding bounces and failures).
* **Emails Clicked**: the number of unique customers who clicked the email.
Data refreshes in **real-time** (or within a few minutes).
Deliver personalized mobile push messages to customers, enhancing engagement and driving action. Gameball enables you to create mobile push notifications that resonate with your audience, driving meaningful interactions with your app or platform.
You need to set up your Firebase integration first to be able to send out Push Notifications.
### How to compose a mobile push
Click on **Configure Push** on the card.
From the pop-up window to the side, fill in the **Internal Name** (this name does not show to customers through the message).
* **Message title:** a short bolded header that grabs the customer's attention.
* **Write your message here:** compose a short line that is straight to the point and persuasive.
Press **Save**.
Engage customers with targeted web messages delivered directly to their browsers. Whether it's announcing promotions, providing updates, or delivering personalized recommendations, Gameball allows you to craft compelling web messages that capture attention and drive engagement.
### How to compose a web message
Click on **Configure Message** on the card.
From the pop-up window to the side, fill in the **Internal Name** (this name does not show to customers through the message).
Select or upload the **Message Icon**.
* **Message title:** a short bolded header that grabs the customer's attention.
* **Write your message here:** compose a short line that is straight to the point and persuasive.
* **Button Text:** A few words that describe where this button leads to when clicked on.
* **Redirection URL:** insert the link of the page you want the customer to land on when they click on the button.
Press **Save**.
Incentivize customer behavior by rewarding them with coupons once a workflow is triggered or a condition is met. With Gameball, you can choose from a drop-down list of existing coupons or create new ones to drive conversions and loyalty.
### How to set up the Reward a Coupon action
Click on **Add Coupon** on the card.
From the side pop-up, **Choose the Coupon Type**.
Set up the **Advanced Rewards Options**.
Press **Save**.
Motivate customers by rewarding them with a badge once a workflow is triggered or a condition is met. Gameball enables you to choose from a drop-down list of existing badges or create new ones to encourage continuous engagement and progression.
### How to set up the Reward a Badge action
Click on **Choose Badge** on the card.
From the side pop-up, **Choose the badge**.
Press **Save**.
Recognize customer achievements by granting them a certain number of points once a workflow is triggered or a condition is met. You can easily specify the number of points to be added and provide a reason for the reward, fostering a sense of accomplishment and motivation.
### How to set up the Add Points action
Click on **Add Points** on the card.
From the side pop-up, set the **Number of Points**.
Add the **Reason** for the points being added.
Press **Save**.
Maintain balance and fairness by deducting points from customers when necessary. Gameball allows you to specify the number of points to be removed and provide a reason for the deduction, ensuring transparency and accountability in your rewards program.
### How to set up the Deduct Points action
Click on **Deduct Points** on the card.
From the side pop-up, set the **Number of Points**.
Add the **Reason** for the deduction.
Press **Save**.
Segment customers effectively by applying specific tags once a workflow is triggered or a condition is met. With Gameball, you can choose from a drop-down list of existing tags to categorize customers based on their behavior, preferences, or characteristics.
### How to set up the Add Tag action
Click on **Choose Tag** on the card.
From the side pop-up, **Select the Tag**.
Press **Save**.
Refine customer segmentation by removing specific tags once a workflow is triggered or a condition is met. Gameball enables you to choose from a drop-down list of existing tags, ensuring that your customer data remains organized and actionable.
### How to set up the Remove Tag action
Click on **Choose Tag** on the card.
From the side pop-up, **Select the Tag**.
Press **Save**.
Integrate seamlessly with external apps and services by sending customers' information via webhooks. Gameball allows you to set up webhooks to transfer data securely, enabling real-time communication and synchronization between systems. [Learn how to set up the Send Webhook action](/product-documentation/automation-campaigns/webhooks-in-automation).
Mastering automation actions is key to unlocking the full potential of your automation campaigns. By leveraging the diverse range of automation actions provided by Gameball, you can create personalized experiences, drive engagement, and achieve your goals effectively.
***
### Related Articles
Step-by-step guide to building your first automation campaign.
Learn about all available triggers that can initiate your automation workflows.
Learn about conditions and branching logic available in automations.
# What Are Automation Controls?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/automation-controls
Learn more about Gameball's Automation Campaigns controls, and how to use them.
Automation controls play a crucial role in orchestrating seamless workflows, allowing businesses to customize and optimize automation campaigns effectively. In this article, we'll delve into the various automation controls offered by Gameball, providing detailed insights into their functionalities and applications.
## Exploring Automation Controls
Automation controls provide businesses with the flexibility to tailor their workflows based on specific conditions or events.
Wait for Event enables you to pause workflow execution until a specific customer action occurs, and a certain amount of time (e.g., wait for a customer to place an order within the upcoming 7 days). This control allows for the creation of two action paths:
* **Received**: The expected event occurs within the specified timeframe, triggering the subsequent action.
* **Elapsed**: The specified event does not occur within the timeframe, prompting an alternative action.
Time Delay introduces a specified period of time before executing the next action in the workflow. This control is ideal for scheduling actions to occur after a certain delay, enabling businesses to sequence tasks effectively.
Conditional Splits allow businesses to evaluate whether a previous event meets specified criteria or not. Based on the result, businesses can create two action paths:
* **Yes**: The condition is met, triggering one set of actions.
* **No**: The condition is not met, prompting an alternative set of actions.
A powerful feature that lets you test, compare, and optimize your customer engagement strategies directly within Gameball.
### How does it work?
* **Split audiences into groups** (A & B) with a fully customizable ratio (e.g., 50/50, 70/30).
* **Build distinct automation paths** for each group with different actions, rewards, or communications.
* **Ensure stable testing** with random but consistent customer assignment to each group.
* **Measure performance side by side**, with detailed reporting on engagement, redemption, and revenue uplift for each branch.
* **Optimize your strategy** by identifying which path performs better and scaling it across your campaigns.
***
### Related Articles
Step-by-step guide to building your first automation campaign.
Learn about all available triggers that can initiate your automation workflows.
Explore all actions you can execute when automation conditions are met.
# What Are Automation Triggers?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/automation-triggers
Learn more about Gameball's Automation Campaigns triggers, and how to use them.
Automation triggers serve as the backbone of efficient workflows, enabling businesses to automate tasks seamlessly. In this article, we delve into the various automation triggers offered by Gameball, exploring their functionalities and applications in detail.
## Exploring Automation Campaign Triggers
Automation triggers are the catalysts that initiate predefined actions within workflows. Understanding these triggers is essential for maximizing the efficiency of automation campaigns.
Triggered once a customer creates an account, the Account Created trigger marks the beginning of a user's journey with your business. This trigger presents an opportunity for you to initiate onboarding processes, welcome new users, and provide valuable information or incentives to encourage further engagement.
Start automation on a specific date/time with the OnDate Trigger. This feature allows businesses to schedule automation campaigns in advance, ensuring the timely execution of tasks and communications. For example, Black Friday, flash sale, brand anniversary, etc.
### How to set up the On Date trigger
Click on **Set Date** on the card.
From the side pop-up, **Select an Option (Birthday, Join Date, or Custom)**.
If you chose custom, then select the **Date/Time**.
Press **Save**.
This trigger is activated when a customer completes a specific action on the platform. Whether it's making a purchase, writing a review, filling out a survey, viewing a product, or engaging with content, the Receive Event trigger allows you to respond promptly to user interactions.
### How to set up the Received an Event trigger
Click on **Add Event** on the card.
From the side pop-up, **Choose Event**.
**Apply** the **Filters** you need.
Press **Save**.
When selecting "Receive Event," you'll need to pick the exact event criteria using the Event Engine.
Activated when a customer tiers up or down, the Tier Changed trigger enables businesses to tailor experiences based on a customer's progression within a game or application. This trigger is invaluable for delivering personalized messages or rewards to users as they advance through different tiers.
### How to set up the Tier Changed trigger
Click on **Add Tier** on the card.
From the side pop-up, **Choose Tier**.
Press **Save**.
Initiated upon the completion of a designated reward campaign. This trigger empowers businesses to recognize and reward customers accomplishments effectively. Whether it's conquering a difficult task or achieving a milestone, this trigger allows for timely acknowledgment and incentivization.
### How to set up the Reward Campaign Achieved trigger
Click on **Choose Badge** on the card.
From the side pop-up, **Choose the badge**.
Press **Save**.
Triggered when a customer joins a specific segment, the Segment Entered trigger enables businesses to target users based on their characteristics or behaviors. This trigger facilitates targeted communication and engagement strategies.
### How to set up the Segment Entered trigger
Click on **Choose Segment** on the card.
From the side pop-up, **select the Segment**.
Press **Save**.
Triggered when a customer leaves a specific segment, the Segment Exited trigger enables businesses to re-engage dormant customers; this trigger also facilitates targeted communication and engagement strategies.
### How to set up the Segment Exited trigger
Click on **Choose Segment** on the card.
From the side pop-up, **Select the Segment**.
Press **Save**.
Activated when a specific tag is applied to a customer, the Tag Added trigger allows businesses to categorize and track users based on predefined criteria. This trigger is invaluable for implementing targeted marketing campaigns or segmenting users for personalized experiences.
### How to set up the Tag Added trigger
Click on **Choose Tag** on the card.
From the side pop-up, **Select the Tag**.
Press **Save**.
Activated when a specific tag is removed from a customer, the Tag Removed trigger allows businesses to categorize and track users based on predefined criteria. This trigger is also invaluable for implementing targeted marketing campaigns or segmenting users for personalized experiences.
### How to set up the Tag Removed trigger
Click on **Choose Tag** on the card.
From the side pop-up, **Select the Tag**.
Press **Save**.
Initiated by an external app via webhook, the Webhook Trigger enables seamless integration with third-party platforms and services. This trigger opens up a world of possibilities for automating workflows across different systems, enhancing efficiency and connectivity. [Learn how to set up the Webhook Trigger](/product-documentation/automation-campaigns/webhooks-in-automation).
The **Automation Completed** trigger helps you to seamlessly link multiple automations, ensuring a smooth transition from one workflow to the next. When a customer completes an automation, you can **automatically trigger the next one**, eliminating manual intervention and enhancing engagement, ensuring a fluid, connected customer journey, allowing you to build dynamic, multi-stage automation workflows that drive engagement and retention.
### How to set up the Automation Completed trigger
Click on **Completed Automation** on the card.
From the side pop-up, **Select the automation**.
Press **Save**.
### Use Cases
Guide new users through a structured onboarding experience by triggering the next step upon completion of the previous one. For example, once a customer completes their profile setup, they can be automatically enrolled in a tutorial about earning rewards.
Encourage deeper engagement by unlocking exclusive benefits as customers progress. After a customer completes a milestone (e.g., making their first purchase), they can be automatically added to a VIP automation that grants them bonus rewards.
Keep customers engaged with a multi-step retention strategy. If a customer completes a re-engagement campaign, they can be seamlessly transitioned into a follow-up automation that offers a personalized discount or gamified challenge.
With Gameball's comprehensive suite of automation triggers, you can embark on a journey towards automation excellence, driving growth and success in the digital landscape.
***
### Related Articles
Step-by-step guide to building your first automation campaign.
Explore all actions you can execute when automation conditions are met.
Learn about conditions and branching logic available in automations.
# How to Create an Automation Campaign?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/how-to-create-an-automation-campaign
Learn how to use Gameball Automation Campaigns to create workflows that will increase productivity and efficiency.
Automated workflows streamline customer-business communications and activities. Gameball's automation engine offers a robust solution for creating pre-set actions triggered by specific events. [Learn more about Automation Campaigns](/product-documentation/automation-campaigns/introduction-to-automation-campaigns).
## Creating an Automated Workflow
### Create a New Automation Campaign
Open your Gameball Admin Dashboard.
From the left bar, click on **Automation** under **Campaigns**. You will land on the page that displays all previously **configured** and **Live** Automations.
Click **Create Automation** from the top right of the Automation section. You will be taken to the **automation engine**, where you can create endless workflows.
***
### Choose Your Audience and Set Entry Frequency and Exit Rule
You can decide which of your customers this automation will apply to. You can also decide when a customer will exit this automation.
Click on **Settings**.
Under **Audience**, choose between:
* All Customers
* Guest Customer
* Registered Customers
* Specific Customer (choosing specific Segments, RFM Segments, Tags, or Customer Attributes)
Determine how frequently customers can enter the automation:
* Once (Default)
* Every Time the Criteria Met
* Custom Frequency
* When **OFF**: Customers are evaluated **only once** with each cycle when they enter the flow (at the time the campaign is triggered).
* When **ON**: Customers are **re-evaluated before each step**. If they **no longer match the audience** criteria or have **exceeded their entry frequency**, they are **automatically exited** from the automation.
Each automation supports defining **one goal** from any Gameball event (custom or predefined). You can add optional filters (e.g., order value, product category) and set a measurement window such as 7, 14, or 30 days. Goals can be added or edited in draft mode, with changes to published automations applying only to new participants.
**Automated Goal Tracking for Each Customer:**
* After a customer completes the automation, Gameball automatically tracks whether they perform the defined goal event within the selected timeframe. Each customer is marked as **Achieved**, **Pending**, or **Not Achieved**, with full visibility inside customer logs.
**Goal Performance Analytics & Reports:**
* A new **Goal Performance** tab has been added to automation insights. It displays total participants, completions, goal achievements, and conversion trends over time. All goal results can be exported to CSV for deeper analysis.
Click **Add Rule** under **Exit Automation Rule.**
**What is an Exit Rule?**
It is a condition or a set of conditions that, if met by a member of the audience, the automation will no longer be applied. For example, if a guest registers and becomes a registered customer, the automation events will no longer be applied to them.
From the dropdown list, choose between:
* **Event:** The customer will exit the automation when they complete a specified action.
* **Profile Attribute:** The customer will exit the automation when their profile has a specified type of information.
***
## How to Create an Automated Workflow
Before diving into your first automated workflow, here's what you need to understand:
Automated workflows comprise three key elements: Triggers, Actions, and Controls.
A workflow always begins with a trigger initiated by the customer.
These are the responses or actions you define when triggers are activated by the customer.
Optionally, you can incorporate conditions before executing actions using controls.
Now, let's walk through the steps to build an automation:
Start by giving your automation a distinct name to easily identify it on the dashboard.
Select a trigger event to kickstart your automation. Simply drag and drop your preferred trigger from the list. Available triggers include:
* **Account Created**
* **Receive Event**
* **Level Changed**
* **Challenge Achieved**
* **Segment Entered**
* **Segment Exited**
* **Tag Added**
* **Tag Removed**
* **Webhook Trigger**
* **OnDate Trigger**
* **Automation Completed**
* **Expiring Points**
Define specific criteria for the chosen trigger event. Click on the selected trigger and choose criteria from the dropdown list. Remember to save your selections. [Learn more about Triggers and their criteria](/product-documentation/automation-campaigns/automation-triggers).
At this stage, you have two choices:
* **Direct Action**: Add an action to be executed immediately after the trigger is activated.
* **Control Mechanisms**: Alternatively, you can use control mechanisms to manage the workflow before executing actions. Choose from:
1. **Wait for Event**: Delay the next action until a specific event is completed by the customer.
2. **Time Delay**: Introduce a waiting period before the next action is triggered.
3. **Conditional Split**: Create divergent paths within the workflow based on different conditions.
4. **A/B Test:** Split audiences into groups (A & B) with a fully customizable ratio (e.g., 50/50, 70/30).
[Learn how each of the controls works.](/product-documentation/automation-campaigns/automation-controls)
Actions are commands executed by Gameball when specific conditions are met within the workflow. These actions can be triggered when the workflow is initiated or when predetermined criteria are fulfilled.
Available actions include:
* **Send Email**
* **Send Mobile Push**
* **Send Web Message**
* **Reward a Coupon**
* **Reward a Challenge**
* **Add Points**
* **Deduct Points**
* **Add Tag**
* **Remove Tag**
* **Send Webhook**
[Learn more about the actions and how you can set them up.](/product-documentation/automation-campaigns/automation-actions)
You can send a test email to yourself when using the "**Send Email**" as an action to a trigger in an automation.
You can expand your automation as necessary, as long as it maintains coherence, streamlines manual tasks, saves time, and serves its intended purpose. Below is an illustrative example of an interconnected workflow.
***
## Using Attributes in Automation
You can use attributes to set your own rules for each trigger, action, or control. Here is how attributes work in automations.
By clicking the **Plus Icon** inside any trigger or actions, a small pop-up will appear giving you a list of attributes under 3 different tabs:
* **Previous Steps:** Dynamic attributes passed by previously chosen Event, Condition, or API (such as Order ID, Points Earned, or Friend Name) from one node to another inside your automations. Variables here will be dependant on attributes used in the previous trigger or action.
* **Customer Variables:** All customer-related variables such as name, ID, number, referral link, etc.
* **Global Variables:** Variables that have to do with your general configurations, like chosen currency, points name, score name, etc.
Here is a list of attributes you will find while creating your automation:
| Previous Steps | Customer Variables | Global Variables |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- |
| Depends on the previously used variables in the former step. ([Check this article for more details](/product-documentation/automation-campaigns/attributes-across-automation-nodes)) | Unique ID, First Name, Last Name, Display Name, Customer's Mobile, Referral Link, Mobile Referral Link, Points, Tier Up total progress, Score Name, Points, Coupon Code, Coupon Value, Reward Campaign Reward, Tier Entry Reward, Tier Lifetime Reward, location, membershipLevel, graduationDate, isMarried, occupation, company, hobbies | Equivalent value of total points, Currency, Points Name, Referral Link, Mobile Referral Link |
***
## Email Customization with Block Variables
Now, you have the ability to incorporate block variables directly into your email variables, enabling the creation of highly personalized and contextually relevant email content.
Each block within the automation is assigned a unique identifier in the form of a 4-digit ID, displayed in uppercase. For instance, if a block rewards a coupon, users can easily reference the coupon code variable under the email variables section, denoted by its ID, such as \[CP02] Reward a coupon.
Moreover, if there are multiple instances of the "Reward a coupon" block within the automation, all relevant coupon code variables are conveniently listed under the email variables, allowing for comprehensive customization.
These variables will only appear in the email variables list if they precede the block being edited.
***
## Tracking Customers' Progress in Automation
### On the Main Automation Page
Check the data list beside each automation. This bar displays:
* The targeted audience chosen under **Audience**.
* The number of customers who started or had the automation applied to them under **Customers Started**.
* Information about which stage of the automation the customers have reached under **Customers Currently in**.
* The count of customers who have completed all automation stages under **Customers Completed**.
### Detailed View
To check a detailed view, select an **automation** and click **Show More Details**.
You'll be directed to a page showing details of all customers who entered the automation flow and their current stage.
***
## Where to Find the Inactive Automation
Navigate to the Automation main page from the left sidebar.
Click **Draft** to filter to inactive automations.
You will find a list of all your saved inactive automations.
### Managing Existing Automation
For Automation **Deactivation, Duplication, Editing, or Deletion**:
Hover over the **3 dots icon** next to any existing automation.
Choose from the **menu** the action that you want to do:
* Deactivate
* Duplicate
* Edit
* Delete
By following these steps, you can efficiently create, track, and manage automated workflows using Gameball's Automation Campaigns.
***
## Export Customers from All Automation Action & Control Nodes
You can now export customers who reach any **Action** or **Control** node inside an automation flow.
This enhancement allows teams to run deeper analysis, build external segments, integrate with other tools, or take manual actions outside Gameball.
### Export Availability
All **Action** and **Control** nodes now include a new option: **Export Customers**. Supported node types:
Send Email, Send Web Message, Grant Reward, and others.
Wait, Time Delay, Condition, A/B Test.
### Export Behavior
* Selecting **Export Customers** initiates a CSV file export of all customers who have **successfully reached** the selected node.
* The export includes **full historical data**, not just recent activity.
* Once prepared, the system sends the CSV file to you via **email**.
# What Is Automation Campaigns?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/introduction-to-automation-campaigns
Explore Gameball's Automation Campaigns to streamline workflows and revolutionize customer tasks.
| Platform | Plan |
| -------------------- | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-platform Clients | Add-On |
**Active automation limits by plan:**
* **Shopify Pro**: Up to **2 active automations** at a time.
* **Shopify Guru**: **Unlimited** active automations.
Automation Campaigns in Gameball serve as an indispensable tool, designed to streamline essential and repetitive customer-related tasks, thereby eliminating manual interventions and boosting overall efficiency. By leveraging automation, you can establish seamless processes and enhance productivity significantly.
## Understanding Gameball Automation Campaigns
Gameball Automation empowers you to create a series of predefined actions triggered by specific events, thus automating routine tasks effectively.
### How Gameball Automation Campaigns Work
Creating an automated workflow involves defining three fundamental components:
The criteria that initiate the workflow. Once trigger conditions are met, Gameball starts the predetermined sequence of actions.
Commands executed by Gameball once trigger conditions are met, such as sending messages or granting rewards.
Conditions that must be met before subsequent actions in the workflow are executed.
***
### Ready-to-Use Templates for Instant Deployment
In addition to empowering you to create custom automated workflows, Gameball also provides a selection of ready-to-use automation campaign templates. These templates are designed to expedite the automation setup process, allowing businesses to quickly implement effective strategies without the need for extensive configuration.
Whether you're new to automation or seeking time-saving solutions, these pre-built templates offer a convenient starting point for maximizing efficiency and communication within your operations. [Check out the automation campaign templates](/product-documentation/automation-campaigns/templates/introduction-to-automation-templates).
***
### When to Use Automation
Automation can be utilized in some scenarios to optimize processes and strengthen customer engagement:
Welcome customers to new levels and guide them through their first experience with your loyalty program.
Upsell products to interested customers based on their browsing and purchase behavior.
Retain at-risk customers and re-engage dormant ones before they churn.
Encourage guest users to create accounts and join your rewards program.
Resolve cart abandonment issues by reaching customers with timely incentives.
Tailor automation to cater to different RFM segments and reward customers for actions on external apps.
***
### Related Articles
Step-by-step guide to building your first automation campaign from scratch.
Learn what happens to customer journeys when you edit a live automation.
# How Do I Make Edits on Active Automation?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/making-edits-on-active-automation
Learn what happens to customers engaged with a running automation when you make changes to the workflow.
Understanding the impact of editing active automation is essential for maintaining a smooth customer experience. This article outlines how edits affect both existing and new participants in Gameball automation.
Changes generally **do not affect** customers already in the automation unless stated otherwise. **Newly enrolled** customers always follow the **updated version**.
***
## General Behavior
* If **"Auto-exit on audience or frequency mismatch"** is enabled, existing customers are **re-evaluated** before each step and may exit if they no longer qualify.
* These rules apply whether the automation is **active or inactive**, as long as it is **not a draft**.
***
## Settings
**Existing customers:**
* Customers already inside the automation will **stay** and continue their flow.
* New audience rules apply **only to new entrants**.
**If "Auto-exit on mismatch" is enabled:**
* Existing customers are **re-evaluated** before the next step.
* If they no longer match the updated audience, they are **automatically exited** from their current cycle.
**If the new limit is higher (e.g., from one-time to multiple):**
* Customers can re-enter if they trigger the automation again.
* Ongoing cycles continue normally.
**If the new limit is lower (e.g., from multiple to one-time):**
* Customers already at the new limit will complete their current cycle and will not re-enter.
**If "Auto-exit on mismatch" is enabled while frequency is edited:**
* Customers are re-evaluated before their next step. Those exceeding the updated frequency are automatically exited.
| State | Behavior |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Enabled** | Existing customers are re-evaluated before each step. If they no longer match the audience or exceed entry frequency, they are automatically exited. |
| **Disabled** | Customers continue their journey without re-checks once they start a cycle, even if they no longer meet the original criteria. |
| Field | Rule |
| -------------- | ------------------------------------------------------ |
| **Start Date** | Can be edited if it has not passed yet. |
| **End Date** | Can be changed anytime, regardless of campaign status. |
When an exit rule is **added or edited**:
* Existing customers are **re-evaluated before their next step**.
* If they now match the exit condition, they are **automatically exited** from the automation.
***
## Trigger & Actions
**Updating or Changing the Trigger:**
* Existing customers already in the automation are **not affected**.
* The new trigger applies **only to new entrants**.
* If a customer has already passed this step, they are not affected.
* The new action or values apply to all customers who have not yet reached that step.
***
## Controllers
| Scenario | Behavior |
| ----------- | ---------------------------------------------------------------------------------------------------- |
| **Updated** | Customers already waiting follow the **original delay**. The new delay applies only to new entrants. |
| **Deleted** | All customers currently in this step are **exited** from the automation. |
| Scenario | Behavior |
| -------------------- | ------------------------------------------------------------------------------------------------- |
| **Duration updated** | Existing customers continue based on the original duration. New entrants follow the new duration. |
| **Event updated** | Allowed only in draft. Once the campaign is live, this cannot be changed. |
| **Node deleted** | All customers in this step are **exited** from the automation. |
***
## Deactivating an Automation
When **deactivated**, customer progress is saved. Customers resume from the same step when the automation is reactivated.
When **reactivated**, customers are re-evaluated based on the following rules:
**If the customer was in a Time Delay:**
1. If the wait time **has passed** while inactive, the next step is triggered immediately.
2. If the wait time **has not passed**, the customer continues waiting as expected.
3. If the wait time was **edited while inactive**, customers waiting in this block resume based on the **original duration**. The new duration applies only to new entrants.
**If the customer was in a Wait for Event:**
1. If the wait time has elapsed and the event did not occur, the customer is exited.
2. If the event happens during inactivity and the wait time has passed, the step is marked as elapsed.
3. Events that occur while the automation is inactive are not detected or counted.
***
## Related Articles
Step-by-step guide to building and launching automation workflows.
Overview of all available ready-to-use automation templates.
# How Do I Acquire New Customers?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/acquire-new-customers
Attract new customers with Gameball's Automation Templates
This article covers the **Acquire New Customers** automation templates, designed to drive first purchases and encourage loyal customers to spread the word.
***
## Welcome Series Template
### Goal
Encourage new customers to complete their first purchase by giving them a surprise gift — a 20% discount — when they create an account.
### Flow
They receive an email about the discount right away, and if they do not make a purchase within 3 days, they get a reminder email encouraging them to take advantage of the discount.
### Trigger
Account Created
### Instructions
* Avoid using the "Create Account" challenge with this automation to prevent customers from earning rewards twice.
* Make sure to disable any other welcome email upon account creation to prevent duplicate emails from being sent.
***
## Ask Repeated Customers for Referrals Template
### Goal
Encourage loyal customers (those with more than 2 orders) to refer their friends after making a purchase.
### Flow
This automation triggers when a customer places an order and waits for 14 days. It then sends an email inviting the customer to refer a friend and earn rewards. If no successful referrals are received within 2 days, a reminder email is sent.
### Trigger
Placed Order
### Instructions
* Enable the referral program and set up rewards for both your customers and their friends.
* Ensure that you activate the notification emails for both the customer and their friend upon successful referral.
* Adjust the 14-day wait to match your process. It is set to ensure that the customer received the order; change it if needed.
This template nudges existing customers to make referrals. It does not send reminders to the referred friend who hasn't signed up yet, and it does not support referrer-initiated follow-ups to specific friends.
***
## Related Articles
Step-by-step guide to building and launching automation campaigns.
Overview of all available ready-to-use automation templates.
# How Do I Boost Sales and Upselling?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/boost-sales-and-upselling
Discover and understand the automation templates designed to boost your sales and upselling your customers
Upselling and cross-selling are powerful strategies to increase revenue by encouraging customers to purchase additional or complementary products. This article covers the **Boost Sales and Upselling** automation templates.
***
## Promote Product Cross-Sell
Capitalize on recent purchases by suggesting complementary products to customers. When a customer buys Product X, this automation starts. After a day, an email is sent suggesting related products they might like based on their purchase. This personalized approach improves their shopping experience and can boost sales by showing them items they are interested in.
### Trigger
Placed Order (Filter: Product X)
### Instructions
* Be sure to include the product ID of the item you are waiting for the customer to purchase in the trigger.
* Adjust the email content to mention both the purchased product (the same product specified in the trigger) and the additional product you want to cross-sell.
***
## Promote Collection Cross-Sell
Encourage customers who recently bought from a specific collection to explore a complementary collection. When a customer buys from Collection X, the next day an email recommends a complementary collection. After three days, if they have not made a purchase, a 20% discount valid for seven days is offered that applies only to the complementary collection.
### Trigger
Placed Order (Filter: Collection X)
### Instructions
* Be sure to include the collection ID of the collection you are awaiting the customer to purchase in the trigger.
* Edit the add coupon block to ensure the reward applies only to specific collections. Select the complementary collection as the purchase.
* Adjust the email content to reference both the purchased collection (the same collection specified in the trigger) and the additional collection you want to cross-sell.
***
## Increase Average Order Value (AOV)
Encourage customers to increase their order value with tiered discounts based on their purchase amount. This automation triggers on a specific date to offer different discounts to each customer based on their average order value (AOV). If your AOV is less than \$500, you will receive a 10% discount.
### Trigger
OnDate
### Instructions
Select the date from the trigger block, and you are good to go!
***
## Promote New Arrivals
Promote new arrivals to customers and encourage purchases from specific collections. On a specific date, this automation sends an email to the user promoting new arrivals. It then waits 7 days for the customer to place an order. If no order is made during this period, a follow-up email is sent.
### Trigger
OnDate
### Instructions
* Select the date from the trigger block.
* Ensure to include the collection ID of the new arrivals in the Wait for Event block.
***
## Related Articles
Step-by-step guide to building and launching automation campaigns.
Overview of all available ready-to-use automation templates.
# What Are Encourage Repurchase Automation Templates?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/encourage-repurchase
Effortlessly re-engage your customers and entice them to make additional purchases with Encourage Repurchase Automation Templates.
Encouraging repeat purchases is vital for sustaining business growth and fostering customer loyalty. This article covers the **Encourage Repurchase** automation templates designed to boost your sales.
***
## First Purchase Upsell
### Goal
Turn one-time buyers into repeat customers with an enticing 10% offer to encourage them to shop again. This offer includes a 14-day waiting period to ensure customers receive their orders.
### Trigger
Placed Order
### Instructions
* Consider turning off any other active upsell automation for customers who have placed only one order to prevent duplicate emails from being sent.
* Adjust the 14-day wait to match your process. It is set to ensure that the customer received the order; change it if needed.
***
## Customer Win-Back
Re-engage inactive customers. If the customer becomes inactive (no logins for the last 60 days or no orders for the last 90 days), they are offered a 20% discount valid for 14 days, communicated via email. A reminder is also sent two days before the offer expires.
### Trigger
Segment Entered (Inactive Customers)
### Instructions
You are good to go!
***
## \[Shopify] Abandoned Checkout
Encourage customers who abandoned their checkout to complete their purchases by creating a sense of urgency. When a customer starts checkout, the automation waits 2 hours for an order placement. If no order is placed, a 10% discount valid for 2 days is offered to create urgency and encourage the customer to complete the purchase.
### Trigger
Checkout Started
### Instructions
Only Shopify users can access this template.
***
## \[Self Serve] Abandoned Cart
Encourage customers who abandoned their carts to complete their purchases by creating a sense of urgency. When a customer adds a product to their cart, the automation waits 2 hours for an order placement. If no order is placed, a free shipping coupon valid for 2 days is offered to encourage the customer to complete the purchase.
### Trigger
Add to Cart
### Instructions
You are good to go!
***
## \[Salla] Abandoned Cart
Encourage customers who abandoned their carts to complete their purchases by creating a sense of urgency. When a customer abandons their cart, a free shipping coupon valid for 2 days is offered to encourage them to complete the purchase.
### Trigger
Abandoned Cart
### Instructions
You are good to go!
***
## Related Articles
Drive sales with time-sensitive offers and flash sales.
Automate onboarding and first-purchase incentives.
# What Is Automation Templates?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/introduction-to-automation-templates
Streamline Your Workflow with Ready-to-Use Automation Campaign Templates
| Platform | Plan |
| -------------------- | ---------- |
| Shopify | Pro & Guru |
| Salla | Pro & Guru |
| Non-platform Clients | Add-on |
With Gameball's ready-to-use automation templates, you can streamline your workflow and enhance customer engagement effortlessly. These templates are designed to showcase predefined workflows so you can leverage automation effectively from day one.
***
## Exploring Our Objective-Based Templates
Black Friday deals, Flash Sales, Double Points on Weekends, and Points Expiry Reminders.
Welcome Series and Ask Repeated Customers for Referrals.
First Purchase Upsell, Customer Win-back, Abandoned Cart, Abandoned Checkout, and Abandoned Browse.
Promote Product Cross-Sell, Collection Cross-Sell, Increase AOV, and Promote New Arrivals.
Ask for Reviews, Reward for Reviews, and Collect Feedback/Survey.
Happy Birthday, Anniversary, and First Purchase Anniversary.
***
## Template Overviews
* **Black Friday:** Capitalize on Black Friday with a limited-time 10% discount communicated via email.
* **Flash Sale:** Drive sales with a 10% discount for 7 days, communicated via email.
* **Double Points on Weekends:** Encourage weekend purchases with double points offered only during weekends, communicated via email.
[Dive into more details about Time-Limited Promotions Templates.](/product-documentation/automation-campaigns/templates/time-limited-promotions)
* **Welcome Series:** Welcome new customers with a 20% discount upon account creation. Follow up with a reminder email if they do not purchase within 3 days.
* **Ask Repeated Customers for Referrals:** Encourage loyal customers to refer friends after a purchase. Send a referral email with rewards and a reminder if no referrals are received within 2 days.
[Dive into more details about Acquire New Customers Templates.](/product-documentation/automation-campaigns/templates/acquire-new-customers)
* **First Purchase Upsell:** Offer one-time buyers a 10% discount to encourage repeat purchases with a 14-day waiting period.
* **Customer Win-back:** Offer inactive customers a 20% discount for 14 days to encourage them to return and make a purchase.
* **Abandoned Cart:** Encourage customers who abandoned their carts to complete their purchases with a 10% discount valid for 2 days.
* **Abandoned Checkout:** Encourage customers who abandoned their order at checkout to complete their purchases with a 10% discount valid for 2 days.
* **Abandoned Browse:** Offer a 10% discount valid for 2 days to customers who visited a product page but did not add items to their cart within 2 hours.
[Dive into more details about Encourage Repeated Purchases Templates.](/product-documentation/automation-campaigns/templates/encourage-repurchase)
* **Promote Product Cross-Sell:** Suggest related products to customers based on their purchase, enhancing their shopping experience and potentially increasing sales.
* **Promote Collection Cross-Sell:** Encourage customers who bought from one collection to explore another, offering a 20% discount on the complementary collection.
* **Increase Average Order Value (AOV):** Offer tiered discounts based on purchase amount to encourage customers to increase their order value.
* **Promote New Arrivals:** Promote new arrivals to customers and encourage purchases from specific collections with timely emails and follow-ups.
[Dive into more details about Boost Sales & Upselling Templates.](/product-documentation/automation-campaigns/templates/boost-sales-and-upselling)
* **Ask for Reviews:** Incentivize customers to leave reviews by offering incentives like points, sent 14 days after their purchase.
* **Reward for Reviews:** Reward customers for writing reviews with 200 points and a special badge as recognition, triggered by a webhook when a user writes a review.
* **Collect Feedback/Survey:** Incentivize feedback participation and survey completion with 200 points and a special badge as recognition, triggered by a webhook when a customer leaves feedback or fills out a survey.
[Dive into more details about Reviews & Data Collection Templates.](/product-documentation/automation-campaigns/templates/reviews-and-data-collection)
* Happy Birthday
* Anniversary
* First Purchase Anniversary
***
## Benefits of Ready-to-Use Templates
| Benefit | Description |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Time-Saving** | Eliminate the need to create workflows from scratch using pre-designed templates tailored to specific business objectives. |
| **Effortless Implementation** | Easily integrate templates into your existing automation modules with minimal setup required. |
| **Enhanced Customer Engagement** | Deliver personalized and targeted messages to customers at various stages of their journey, fostering stronger relationships and driving conversions. |
| **Improved ROI** | Maximize the effectiveness of your automation efforts with proven templates designed to achieve specific objectives, ultimately increasing revenue and ROI. |
***
## Related Articles
Step-by-step guide to building and launching automation workflows.
Understand how changes to a live automation affect your customers.
# What Are Reviews & Data Collection Automation Templates?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/reviews-and-data-collection
Understand customer satisfaction levels by collecting reviews and data using Automation Campaigns.
Reviews and feedback are invaluable for businesses to understand customer satisfaction and improve products or services. This article covers the **Reviews & Data Collection** Automation Templates.
***
## Ask for Reviews
### Goal
Ask customers to leave reviews for purchased products by offering incentives.
### Flow
After a waiting period of 14 days following a customer's purchase, an email is sent inviting them to leave a review. In return, customers are offered X points as an incentive.
### Trigger
Placed Order
### Instructions
* Along with this automation, you need to reward a customer upon adding a review by enabling the "Reward for Reviews" automation series or activating the "Write a Review" challenge.
* Adjust the 14-day wait to match your process. It is set to ensure that the customer received the order; change it if needed.
***
## Reward for Reviews
### Goal
Reward customers for writing reviews to incentivize and encourage feedback on products.
### Flow
This automation is triggered by a webhook when a user writes a review. The customer then receives 200 points and a special badge as recognition for their contribution.
### Trigger
Webhook
### Instructions
* Avoid using the "Write a Review" challenge with this automation to prevent customers from earning rewards twice.
* Configure the webhook trigger to notify Gameball when someone leaves a review.
***
## Collect Feedback/Survey
### Goal
Incentivize feedback participation and survey completion to enhance customer engagement and satisfaction.
### Flow
This automation is triggered by a webhook when a customer leaves feedback or fills out a survey. The customer then receives 200 points and a special badge as recognition for their contribution.
### Trigger
Webhook. [Learn how to set it up](/product-documentation/automation-campaigns/webhooks-in-automation).
### Instructions
Configure the webhook trigger to notify Gameball when someone leaves feedback or fills out a survey.
***
## Related Articles
Step-by-step guide to building automation campaigns.
Overview of all available automation templates.
# What Are Time-Limited Promotions Automation Templates?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/templates/time-limited-promotions
Discover the power of time-limited promotions with Gameball's automation templates.
This article covers the **Time-Limited Promotions** automation templates designed to drive sales and boost customer engagement.
***
## Black Friday Template
### Goal
Capitalize on Black Friday with limited-time discounts.
### Flow
On Black Friday, this automation provides a 10% discount valid for 7 days. Customers are notified about the discount via email and the automation waits for them to place an order. If no order is made, a reminder email is sent one day before the discount expires.
### Trigger
On Date (November 29)
### Instructions
The date (November 29) is already pre-selected on the trigger block — you are good to go!
***
## Flash Sale Template
### Goal
Drive sales with flash sale discounts and reminders.
### Flow
On a set date, this automation activates a 20% discount for 7 days, communicated via email. It then waits for the customer to place an order. If no order is placed, a reminder email is sent one day before the discount expires.
### Trigger
On Date
### Instructions
Select the desired date from the trigger block, and you are all set!
***
## Double Points on Weekends Template
### Goal
Encourage weekend purchases by offering double points to customers.
### Flow
This automation is triggered specifically on weekends to promote the double points offer, which is available only during the weekend and is communicated through email.
### Trigger
On Date
### Instructions
Select the date you want to activate the promotion from the trigger block, and you are ready to boost weekend sales!
***
## Points Expiry Reminder
### Goal
Gives you full control over **when and how to notify customers about their expiring points**, helping you drive engagement while reducing liability.
### Flow
This automation is triggered specifically when a customer's points are near expiration, sending them any type of chosen notification.
### Trigger
**"Points to Expire"**
* Available in the **Automation Builder**.
* Detects when a customer's points are **approaching expiration**.
### Instructions
Set a **custom timeframe** (e.g., 30, 15, 7, or X days before expiry).
Select one or more actions to notify customers:
* Send Email
* Send SMS
* Send Push Notification
* Send Webhook
***
## Related Articles
Step-by-step guide to building automation campaigns.
Overview of all available automation templates.
# What Is Webhooks in Automation?
Source: https://docs.gameball.co/product-documentation/automation-campaigns/webhooks-in-automation
Use actions that your players do on external apps to build you custom automation.
| Platform | Plan |
| -------------------- | ----------------------------- |
| Shopify | Guru |
| Salla | Guru |
| Non-platform Clients | Included in Automation Add-on |
***
Webhooks in Gameball let you send and receive customer information to and from external applications, all within your automation flows. You can use webhooks as both **triggers** (to start an automation from an external event) and **actions** (to push customer data to another platform). [Learn more about Automated Workflows](/product-documentation/automation-campaigns/how-to-create-an-automation-campaign).
***
## Using Webhooks as a Trigger
You can create an automation triggered by an action the player initiates on an external app. For example, you want to reward your customers with 100 points for each review they leave on your review app.
From the Triggers panel, drag **Webhook Trigger** and drop it onto the canvas.
Set up the webhook configuration:
* Copy the **Webhook URL** that Gameball provides and paste it into the integration section of your external app, along with your API key for authentication.
* Select how you want to **identify your players** (Email, External Customer ID, or Mobile Number).
* Fill in the **payload** based on the selected identifier to confirm the format (e.g., `{payload.data.email}`).
* Press **Save**.
Connect your trigger to the **Add Points** action:
* Click **Add Points**.
* Fill in the reward information.
* Press **Save**.
Press **Save** to finalize your automation.
***
## Using Webhooks as an Action
You can use webhooks as an action within your automation to send customer information to an external app. For example, you want to send a welcome email using your external mailing app to a new customer who just created an account.
Drag the **Account Created** trigger onto the canvas.
Connect it to the **Send Webhook** action.
Set up the webhook configuration:
* Paste your external app's webhook URL in the **Webhook URL** field.
* Choose your **HTTP method** (POST, GET, or PUT).
* Add the player information you want to send in the **Webhook body**. You can use JSON format, the visual builder, or select from customer variables.
* Add the required **Headers**.
* Press **Save**.
Press **Save** to finalize your automation.
**Payload Configuration:**
* If the action is to send an email within Gameball, add a configuration field to specify the payload part for the customer's email (`{payload.data.email}`).
* If the action is external, add all required details for the webhook link and payload in JSON format.
```json theme={null}
{"email": "email"}
```
***
## Related Articles
Learn the fundamentals of Gameball's automation campaign system.
Step-by-step guide to building and launching automation workflows.
Understand how changes to a live automation affect your customers.
# What Are Email Campaigns Templates?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/templates/email-campaigns-templates
Elevate Your Email Marketing with Gameball's Ready-Made Communication Campaign Templates.
Email marketing remains a powerful tool for engaging customers and driving conversions. With Gameball's ready-made email communication campaign templates, you can effortlessly create impactful email campaigns to promote various initiatives, from loyalty programs to flash sales. [Learn more about creating and configuring email campaigns](/product-documentation/communication-campaigns/create-and-configure-email-campaigns).
***
## Available Email Templates
| Field | Value |
| -------------- | ------------------------------------ |
| **Trigger** | Scheduled based — One Time |
| **Scheduling** | Now (Once the campaign goes live) |
| **Audience** | All Customers |
| **Subject** | Introducing Our New Loyalty Program! |
| Field | Value |
| -------------- | --------------------------------- |
| **Trigger** | Scheduled based — One Time |
| **Scheduling** | Now (Once the campaign goes live) |
| **Audience** | Registered Customers |
| **Subject** | Spread the Love and Earn Rewards! |
| Field | Value |
| -------------- | --------------------------------- |
| **Trigger** | Scheduled based — One Time |
| **Scheduling** | Now (Once the campaign goes live) |
| **Audience** | All Customers |
| **Subject** | Flash Sale Alert! 20% Discount |
| Field | Value |
| -------------- | ----------------------------------------------- |
| **Trigger** | Scheduled based — One Time |
| **Scheduling** | Now (Once the campaign goes live) |
| **Audience** | All Customers |
| **Subject** | Double Your Points with Our Exclusive Campaign! |
***
## How to Use the Templates
Log in to your **Gameball Dashboard** and navigate to the **Campaigns** section.
Choose **Communication Campaigns**.
Choose the desired template from the list.
Send a **test email** to preview the template and make any necessary adjustments.
Once satisfied, set the campaign **live**.
Check this article for a [detailed guide on how to create a new email](/product-documentation/communication-campaigns/create-and-configure-email-campaigns) or make edits on a template.
***
## Benefits of Using Ready-Made Templates
| Benefit | Description |
| ----------------- | ---------------------------------------------------------------------------------------------------- |
| **Time-Saving** | Eliminate the need to design email campaigns from scratch, saving valuable time and resources. |
| **Consistency** | Maintain brand consistency across all communication channels with professionally designed templates. |
| **Effectiveness** | Leverage proven email templates optimized for user engagement and conversion. |
***
## Related Articles
Explore pre-built web message templates for on-site customer engagement.
Explore push notification templates to re-engage your mobile audience.
# What Are Push Notification Campaigns Templates?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/templates/push-notification-campaigns-templates
Keep your customers engaged with Gameball's Ready-Made Push Notification Communication Campaign Templates.
Effective communication with your audience is essential for driving engagement and achieving your business goals. With Gameball's Push Notifications Campaign Templates, you can effortlessly create targeted messages to boost customer interaction and drive desired actions. [Learn more about creating and configuring push notification campaigns](/product-documentation/communication-campaigns/create-and-configure-mobile-push-campaigns).
***
## Available Push Notification Templates
| Field | Value |
| ---------------------- | -------------------------- |
| **Trigger** | Scheduled — One Time — Now |
| **Audience** | Specific Audience |
| **Customer Attribute** | Total Orders = 2 |
| Field | Value |
| ------------ | -------------------------- |
| **Trigger** | Scheduled — One Time — Now |
| **Audience** | All |
| Field | Value |
| ------------ | -------------------------- |
| **Trigger** | Scheduled — One Time — Now |
| **Audience** | All |
***
## How to Use the Templates
Log in to your **Gameball Dashboard** and navigate to the **Campaigns** section.
Choose **Communication Campaigns**.
Select the desired **template** from the list.
Check the **preview**, and make any necessary adjustments.
Once satisfied, set the campaign **live**.
Check this article for a [detailed guide on how to create a new push notification](/product-documentation/communication-campaigns/create-and-configure-mobile-push-campaigns) or make edits on a template.
***
## Benefits of Using Push Notification Templates
| Benefit | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Personalization** | Tailor messages to specific audience segments based on their behavior or attributes. |
| **Automation** | Set triggers and targeting criteria to automate message delivery and maximize efficiency. |
| **Engagement** | Capture users' attention with timely and relevant messages, encouraging interaction and action. |
| **Conversion** | Drive desired actions such as achieving new reward campaigns, capitalizing on offers, or purchasing restocked items to increase customer loyalty and sales. |
***
## Related Articles
Explore pre-built web message templates for on-site customer engagement.
Explore email templates to reach customers directly in their inbox.
# What Are Web Messages Campaigns Templates?
Source: https://docs.gameball.co/product-documentation/communication-campaigns/templates/web-messages-campaigns-templates
Keep your customers engaged with Gameball's Ready-Made Communication Campaign Templates.
Effective communication with your audience is essential for driving engagement and achieving your business goals. With Gameball's Web Messages Campaign Templates, you can effortlessly create targeted messages to boost customer interaction and drive desired actions. [Learn more about creating and configuring web message campaigns](/product-documentation/communication-campaigns/create-and-configure-web-message-campaigns).
***
## Available Web Messages Templates
| Field | Value |
| ---------------------- | ------------------------------------------------------------------------------- |
| **Trigger** | On Page visit — URL contains "/cart" (**Update your URL and add the cart URL**) |
| **Audience** | Specific Customer |
| **Customer Attribute** | Points > 100 |
| Field | Value |
| ------------ | -------------------- |
| **Trigger** | Action-based |
| **Event** | "Place an order" |
| **Audience** | Registered Customers |
***
## How to Use the Templates
Log in to your **Gameball Dashboard** and navigate to the **Campaigns** section.
Choose **Communication Campaigns**.
Choose the desired template from the list.
Check the **preview**, and make any necessary adjustments.
Once satisfied, set the campaign **live**.
Check this article for a [detailed guide on how to create new web messages](/product-documentation/communication-campaigns/create-and-configure-web-message-campaigns) or make edits on a template.
***
## Benefits of Using Web Message Templates
| Benefit | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| **Personalization** | Tailor messages to specific audience segments based on their behavior or attributes. |
| **Automation** | Set triggers and targeting criteria to automate message delivery and maximize efficiency. |
| **Engagement** | Capture users' attention with timely and relevant messages, encouraging interaction and action. |
| **Conversion** | Drive desired actions, such as points redemption or referral link shares, to increase customer loyalty and sales. |
***
## Related Articles
Explore email templates to reach customers directly in their inbox.
Explore push notification templates to re-engage your mobile audience.
# How Do I Create a Coupon Manually with Gameball?
Source: https://docs.gameball.co/product-documentation/coupons/creating-coupon-manually
Easily create customized coupons tailored to your marketing strategies and customer needs directly through the Gameball Dashboard.
| Platform | Plan |
| --------- | ------------------------------------------------------ |
| Selfserve | Add-on ([Contact Support](mailto:support@gameball.co)) |
With Gameball's couponing engine, you can manually create unique coupons to reward your customers or drive specific business objectives. This article walks you through accessing the coupon creation feature and setting up a coupon manually.
***
## Accessing the Coupon Creation Feature
Log in to your **Gameball Dashboard**.
From the left-side menu, navigate to **Coupons**.
Click on the **Create Coupon** button at the top of the page.
***
## How to Create a New Coupon
Define the type of coupon you want to create:
* **Free Product**
* **Free Shipping**
* **Fixed Amount-Based Discount** (e.g., \$10 off)
* **Percentage Amount-Based Discount** (e.g., 15% off)
* **Buy X Get Y** (for automatically applied coupons only)
* **Percentage-Based Cashback**
* **Fixed Amount-Based Cashback**
* **Percentage Amount-Based Fees Discount**
1. **Set how the coupon will be applied:** Choose between Discount Code or Automatic.
* **Discount Code:** A code shared with customers to use at checkout.
* **Automatic:** A discount applied automatically once the customer qualifies.
2. **Internal Name:** Provide a unique name for your coupon for better monitoring on the dashboard.
3. **Coupon Code:** Manually enter a code or allow Gameball to auto-generate it.
4. **External Name:** Customers see the **localized display name** in their widget, emails, and web messages.
5. **Terms & Conditions:** Add localized Terms & Conditions for manual coupons to clearly communicate coupon rules and usage limits in each customer's preferred language.
6. **Coupon Value:** Enter the value based on the type chosen.
7. **Minimum Purchase Amount:** Define the minimum amount required for the coupon to apply.
8. **Apply the Coupon:** Decide whether it applies to **All Orders** or **Specific Collections**.
Clients can specify whether the coupon should apply to **both merchants and collections (AND)** or **either merchants or collections (OR)**.
**General notes on "Display Name" and "Terms & Conditions":**
* Supports **multiple languages**, matching your widget's configured languages.
* **Customer-Facing Experience:** Customers see the **localized display name** in their widget, emails, and web messages. If no translation exists for a customer's language, the **default language name** is shown instead.
* **API Updates:** `displayName` is included in coupon API responses as a **multi-language object (key-value pairs)**. No breaking changes for existing API integrations.
* **Terms & Conditions Field:** A dedicated "Terms & Conditions" section is available when creating or editing manual coupons. The coupon API includes a `termsAndConditions` object containing multilingual key-value pairs with no impact on existing coupon API consumers.
#### How to distinguish regular coupons from automatic promotions
The **Customer Coupons API** makes it easier to distinguish **automatic promotions** from **regular coupons** and to display **promotion rules** that define how customers qualify for each offer:
* **`"isPromotion": false`** — Regular or manually issued coupon.
* **`"isPromotion": true`** — Promotion or rule-based discount (e.g., "Buy 2 Get 1 Free", "50% Off Collection").
A `promotionRules` object provides promotion details:
```json theme={null}
"promotionRules": {
"type": "Buy X Get Y",
"description": "Buy 2 items from Summer Collection, get 1 free T-shirt",
"conditions": {
"buyQuantity": 2,
"getQuantity": 1,
"applicableCollections": ["Summer Collection"],
"minOrderValue": 0
}
}
```
Includes promotion type and description, applicable collections or products, and minimum order value or eligibility rules.
Select the target audience for the coupon:
* **All Customers:** The coupon is accessible to all customers.
* **Specific Customers:** Target specific customer groups using:
* **Segments:** Based on predefined customer behaviors.
* **RFM Segments:** Utilizing Recency, Frequency, and Monetary metrics.
* **Tags:** Assign tags to filter customers.
* **Customer Attributes:** Filter by Customer ID or Customer Email.
Add optional configurations to customize the coupon further:
| Option | Description |
| -------------------------------------- | -------------------------------------------------------------- |
| **Start Date** | Specify when the coupon becomes active. |
| **End Date** | Specify when the coupon expires. |
| **Coupon Usage Per Customer Limit** | Set how many times an individual customer can use the coupon. |
| **Coupon Usage Limit** | Establish a total usage cap for the coupon. |
| **Reward Combined with Other Coupons** | Specify whether the coupon can be used alongside other offers. |
Once all details have been added, click the **Save** button to finalize your coupon.
***
## Manage Your Coupons Efficiently
### Edit Each Coupon
Click the **three-dot icon** beside any coupon to access management shortcuts:
| Action | Description |
| ----------------------- | ----------------------------------------------------------------------------------- |
| **Duplicate** | Create an identical copy of an existing coupon for similar campaigns or promotions. |
| **Activate/Deactivate** | Toggle the coupon's status to control its availability. |
| **Edit** | Update the coupon's details, including name, value, usage limits, and more. |
| **Delete** | Permanently remove a coupon. Deleted coupons cannot be recovered. |
### Configure Locking Coupon Duration
To set the duration during which coupons should be locked before they are usable, click **Settings** on the top right of the page.
Set up the time and click **Save**.
### Export Created Coupons
Click **Export**, then **Extract**.
***
## Related Articles
Learn about all the capabilities of Gameball's couponing engine.
Request coupon creation from your couponing engine via API.
# What Is Gameball's Coupon Engine?
Source: https://docs.gameball.co/product-documentation/coupons/introduction-to-coupon-engine
Explore Gameball's new Couponing Engine, your one-stop solution for creating, managing, and utilizing coupons.
| Platform | Plan |
| --------- | ------------------------------------------------------ |
| Selfserve | Add-on (Contact [Support](mailto:support@gameball.co)) |
Managing coupons effectively is a vital part of any successful loyalty and marketing strategy. With Gameball's Couponing Engine, you can create, distribute, and track a variety of coupons seamlessly.
***
## Types of Coupons in Gameball
Coupons can be generated automatically through Gameball features such as:
* **Reward Campaigns:** Reward customers with discounts for completing campaigns. [Learn more.](/product-documentation/rewards-campaigns/introduction-rewards-campaigns)
* **Automations:** Automate coupon generation based on triggers like customer anniversaries or purchases. [Learn more.](/product-documentation/automation-campaigns)
* **Referrals:** Reward advocates with unique coupon codes for successful referrals. [Learn more.](/product-documentation/programs/referral-program/launching-referral-program)
* **Tiers:** Celebrate customers' loyalty with exclusive tier-based coupons. [Learn more.](/product-documentation/programs/vip-tiers/configuring-gameball-vip-tiers)
* **Redemption Rules:** Allow customers to redeem points for tailored discounts. [Learn more.](/product-documentation/programs/redemption/launch-configure-redeem-pointing-system)
Create independent coupons that can be distributed directly to customers without any specific actions required:
* **Fixed Value Coupons:** Offer a set discount amount (e.g., \$10 off).
* **Percentage-Based Coupons:** Provide a percentage discount (e.g., 15% off).
***
## Key Features of Gameball's Couponing Engine
Automatically mark coupons as used, expired, or inactive. Validate coupon eligibility, ensure accuracy in coupon application, and prevent duplicate coupon names for streamlined tracking.
Add prefixes or specific characters to coupon codes, set usage limits (global or per customer), specify start and expiry dates, and activate, deactivate, or duplicate coupons effortlessly.
Coupons integrate seamlessly with all Gameball modules, making it easier to reward, engage, and incentivize your customers.
***
## How to Create & Manage Coupons
Log in to your Gameball Dashboard.
Navigate to the **Coupons** section. Inside, you can create new coupons. [Learn More.](/product-documentation/coupons/creating-coupon-manually)
***
## Customer's List: Coupon Insights Tab
To learn more about each coupon's performance and which customers are engaging with it, pick any created coupon and go to **Customer List**.
This tab is available only under **manually created coupons**.
You can track coupon usage with detailed order- and customer-level data, helping you measure impact and optimize promotional strategies.
Available only for **manually created coupons and promotions**. Accessible when you navigate to the **Coupons page** and click on the coupon you want to check.
Each coupon redemption displays:
| Field | Description |
| ------------------ | ---------------------------------- |
| **Customer ID** | Unique identifier for the customer |
| **Customer Email** | Email address of the customer |
| **Discount Value** | The discount applied at redemption |
| **Date of Use** | When the coupon was redeemed |
Export coupon insights data to **CSV** for further reporting or analysis.
Only users with access to the **Coupons section** can view insights.
***
## Coupon Source Visibility in Widget
Customers can see exactly where each coupon came from, directly inside the Gameball loyalty widget. When a customer views their available coupons in the **Redeem Tab**, each coupon displays its **source** — whether it was issued through a reward campaign, a game, an automation, a VIP tier reward, or a referral.
This transparency helps customers understand how they earned their rewards and encourages them to engage more with your loyalty programs.
***
## Why Use Gameball's Couponing Engine?
| Benefit | Description |
| --------------- | ------------------------------------------------------------------------------------------- |
| **Efficiency** | Simplify the process of creating and managing coupons in one unified platform. |
| **Flexibility** | Generate coupons tailored to your business needs, whether tied to customer actions or not. |
| **Control** | Gain full oversight of coupon usage, ensuring fair use and accurate tracking. |
| **Scalability** | Support for multiple use cases across different Gameball modules and standalone promotions. |
***
## Related Articles
Step-by-step guide to creating and configuring coupons manually.
Request coupon creation from your couponing engine via API.
# What Is the Gameball Customer Widget?
Source: https://docs.gameball.co/product-documentation/customer-widget/introduction-to-customer-widget
Learn about what your customer will see, interact with, and achieve through Gameball Customer Widget.
The **Gameball Customer Widget** is the main interface displayed to your customers during their time on your platform. This interface encourages customer engagement and interaction by allowing them to:
* Track their progress
* View the required actions to complete challenges
* Receive more rewards
Explore how the Gameball widget appears in a live store environment by visiting our [demo shop](https://gameball-loyalty.myshopify.com/).
***
## Explore the Gameball Widget Features
Learn about the different sections and features your customers can access directly through the Gameball widget.
The Gameball widget provides your customers with a centralized space to track their progress, redeem rewards, engage with your loyalty program, and more. Here's an overview of each section they will find inside the widget:
This section displays the customer's current points balance and its equivalent monetary value.
If a customer has **pending points** — points earned but not yet activated — they appear alongside the balance with a clock icon. The pending points display is conditional: it only appears when the customer actually has pending points and is hidden when there are none.
Customers can explore how to earn more rewards. This tab includes:
1. **Cashback Section**: Shows how customers earn points through purchases.
2. **Badges Section**: Displays all active non-game reward campaigns — such as action-based or time-based challenges — along with progress indicators and completion status for each. Game campaigns (e.g., Spin the Wheel) are **not** shown here; they appear exclusively in the **Play & Win** tab.
Play & Win is a widget section that displays all active game campaigns in one place. It helps customers quickly discover games and clearly separates games from standard earning actions. The section appears automatically when at least one game is active and disappears when no games are available.
Here, customers can exchange their collected points for different types of discount coupons or other available rewards. Each coupon displays its source — whether it was issued through a reward campaign, a game, an automation, a VIP tier reward, or a referral — so customers always know where their rewards came from.
This tab shows the customer's current level, the upcoming levels they can unlock, and the benefits and rewards associated with each level.
Gameball's referral feature allows customers to refer your platform to their friends. Once a referred friend signs up, the referring customer receives rewards. The more friends they refer, the bigger the rewards they can earn.
Customers can view the full history of their points activity, including how and when they earned or redeemed points.
You can use a **deep link** to open the Gameball widget directly in the **Customer History** section.
**Deep Link Identifier:** `#gameball-history`
**Use Case:** Include the link in your message campaigns:
"Check your latest rewards here: [YourWebsite.com#gameball-history](http://YourWebsite.com#gameball-history)"
A log of real-time updates related to the customer's progress, such as earning a badge or reaching a new level.
If any game campaigns are activated, such as Spin the Wheel, they will appear as interactive sections within the widget for the customer to engage with.
***
## How Will Gameball Customer Widget Be Displayed on Your Platform?
Gameball's customer profile can be integrated into your mobile app in two ways:
**A. As a new tab in your app**
**B. As an overlay accessed by any button in the app**
***
## What's Next?
Control which tabs appear in your widget and in what order they are displayed.
Adjust colors, fonts, icons, and identity to align the widget with your platform's look and feel.
Set a default language and add additional languages to serve a multilingual audience.
# How Do I Update Referral Tab Content in Gameball Customer Widget?
Source: https://docs.gameball.co/product-documentation/customer-widget/player-profile-tabs/update-referral-tab
Learn how to update the text written inside the referral tab of Gameball customer widget.
You can control the script written in the referral tab of the Gameball customer widget. This text will show to everyone who receives the referral message from your customers.
You can access the referral content configurations in **Gameball Admin Dashboard** through **Widget > Content: Referral**.
***
## Referral Tab Fields
On the **Gameball Admin Dashboard**, go to **Widget > Content: Referral**.
The following fields are available for customization:
| Tab | Description |
| ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **Referral Title** | The main heading displayed at the top of the referral section. |
| **Referral Subtitle** | A short description that supports the referral title. |
| **You have Referred x Friends** | Shows how many friends the customer has successfully referred. |
| **Hello! You Were Referred By** | Displays the name or email of the customer who referred the user. |
| **Referral Extra Reward** | Informs the customer about any extra reward earned for additional referrals. |
| **They Get** | Highlights what the referred friend will receive. |
| **You Get** | Highlights what the referring customer will receive. |
| **You Got** | Shows the reward the customer has received from past referrals. |
| **Invalid Email Validation** | Error message shown when an invalid email is entered. |
| **Referrer Same Email Validation** | Message shown when the referrer uses the same email as the referred friend. |
| **Used Email Validation** | Message shown when the email entered has already been used for referral. |
| **Congratulations** | A celebratory message shown when a referral is successful and a reward is granted. |
| **Your Friend Places an Order** | Indicates that the referral is only successful when the friend places an order. |
| **Share Your Link** | Step 1: Instructs the customer to share their unique referral link. |
| **Your Friend Signs Up Using Your Link** | Step 2: Indicates that the friend must sign up using the shared link. |
| **Your Friend Completes the Steps** | Step 3: Confirms that the friend must complete required actions to finalize the referral. |
| **How It Works** | Button label that navigates to an explanation of how the referral program works. |
| **Referral Invites Empty State** | Message shown when the customer has not sent any invites yet. |
| **Referral Invites Title** | Title displayed on the invite history section. |
| **Completed Invites** | Shows the number of friends who completed the referral process. |
| **Pending Invites** | Shows the number of referrals that haven't been completed yet. |
| **See Referral Invites** | Button that opens the list of pending and completed referral invites. |
| **Copy Confirmation on Checkout** | Message shown when the customer copies their referral coupon at checkout. |
| **Get** | Label showing what the customer (referrer) will receive. |
| **Give** | Label showing what the referred friend will receive. |
| **Your Coupons** | Title of the section displaying all earned referral coupons. |
| **Rewards** | Title of the reward redemption section on the referral page. |
| **See All** | Button that leads to a full list of available rewards. |
| **Guest – Use Referral Link and Get Rewards** | Message encouraging guest users to use a referral link and earn a reward. |
| **Get It Now** | Call-to-action for guests to claim their gift or offer. |
| **Enter Your Email** | Prompt for guests to enter their email to proceed. |
| **Enter Email and Get Gift** | Encourages guests to submit their email in exchange for a reward. |
| **As a Guest, Join Now and Complete an Action to Get Your Gift** | Encourages guest users to sign up and complete an action to receive a gift. |
| **Join Now** | Call-to-action inviting the user to register. |
| **Friend – Join Now** | Message directed at the referred friend to join the platform. |
| **Join Now to Get Your Gift** | Invitation to register and receive a reward. |
| **Join Now and Complete Action to Get Your Gift** | Instructions to join and complete a task to earn a reward. |
| **Join Now and Complete Action to Get Your Points Gift** | Join and complete a required step to earn a gift in the form of points. |
| **Join Now and Complete Action to Get Your Coupon Gift** | Join and complete an action to receive a coupon-based gift. |
| **Join Now and Complete Action to Get Your Points Gift (Popup)** | A pop-up version of the message for getting a points-based gift. |
After filling in all relevant fields, click **Save** to apply your updates.
***
## What's Next?
Set up and launch your referral program to start rewarding customers who bring in new users.
Explore the full overview of the Gameball customer widget and all its sections.
Control which tabs appear in your widget and in what order they are displayed.
# How Do I Enable Opening Gameball Widget Through Inline links Using Deep-links?
Source: https://docs.gameball.co/product-documentation/customer-widget/player-profile-tabs/widget-deep-links
Allow your guests and customers to access any section of your widget through any interactive element on your website, or email.
If Gameball's traditional widget button does not match your theme, or you don't have a space for it, you no longer have to depend on Gameball's button to let your customers and guests access the Gameball loyalty widget. You can [hide and replace the button](/product-documentation/customer-widget/start-configuring-profile/hide-widget-button), or add new elements that allow your customers to quickly access any section of the widget from any part of your platform.
***
## Understanding Deep Links
Deep links are URLs or hyperlinks that take users directly to a specific section of the Gameball widget. This allows for a more seamless user experience by providing quick access to the desired content without navigating through the entire widget.
You can use deep links with any element that can hold a hyperlink, such as text, images, menu items, or buttons. You can also include these hyperlinks in automated emails or SMS campaigns. For example, if a customer clicks a button labeled "Check your earned points now!" in an email, they will be redirected to your website and see the widget section displaying their points.
***
## Available Gameball Deep Links
Takes customers to the home section and guests to the sign-up section.
Directs customers to the referral tab and guests to the home section.
Opens the "FAQ" section for both customers and guests.
Shows customers the levels progress tab and guests the levels program section.
Leads customers to the redemption tab and guests to the "How to Redeem" section.
Opens the "Spin the Wheel" page for customers.
Opens the "Slot Machine" page for customers.
Opens the widget directly in the Customer History section.
When embedding any widget page to a button on the menu bar, use the deep link in this format: `#gameball-home`. Do not use the full URL format like `https://(home page)/#gameball-home`.
***
## Using Deep Links in Emails and SMS Campaigns
To redirect users from an email or SMS to your website and open the Gameball widget to a specific section, you need to use a query string. Combine your website link with the Gameball widget deep link.
| Destination | Link Format |
| ------------------------- | ----------------------- |
| Website URL | `www.shop-name.com` |
| Widget Home Section | `/#gameball-home` |
| Widget Referral Section | `/#gameball-referral` |
| Widget FAQ Section | `/#gameball-faq` |
| Widget Levels Section | `/#gameball-levels` |
| Widget Redemption Section | `/#gameball-redemption` |
For example, if you want your customer to press a button on the link that takes them to the homepage of your website and opens up Gameball's referral section, the link would be as follows: `www.example.com/#gameball-referral`
***
## Triggering the Gameball Widget Using JavaScript
You can also open or toggle the Gameball widget programmatically using the JavaScript function:
```javascript theme={null}
GbSdk.toggle();
```
This function can be attached to a button's `onclick` event, like in the example below:
```html theme={null}
```
***
## Related Articles
Learn how to hide the default launcher button and rely on deep links instead.
Control the shape, position, icon, and visibility of your loyalty launcher button.
# How Do I Configure Customer Widget Language on My Platform?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/configure-customer-widget-language-on-your-platform
Learn about languages supported by Gameball customer widget and how to enable them.
Gameball allows you to display the customer widget in different languages based on the active language of your platform.
Currently, Gameball supports the following languages:
ar
da-DK
nl
en
fr
de
hu
it
pl
pt
es
sv
zh-TW
***
## What If Your Language Is Not Listed?
Only the languages above are officially supported. If your preferred language is not available, you can repurpose an existing language slot as a workaround: select any language from the supported list, then manually replace every text field throughout the system with translations in your desired language.
This workaround requires you to update every translatable text field individually. See [What Fields Will Be Affected](#what-fields-will-be-affected-once-you-add-a-new-language) for the full list.
***
## How to Choose the Default Language
Log in to the **Gameball dashboard**.
From the side menu, go to **Widget**, then select the **General** tab.
Navigate to the **Languages** section and choose your **Default Language** from the available options.
Your account must have a default language. The data under this default language will be displayed to your **customers** whenever any additional active language has missing data.
However, you can still add and activate **more than one language** on your account.
***
## How to Add an Extra Language
Click on **Add Language** next to "Additional Languages."
Choose the second language and click **Add**.
Make sure to click **Save** to apply your changes.
***
## What Happens After Adding an Additional Language?
Once you add a new supported language to your Gameball account in addition to the default one, all fields across the system that are shown to your customers through the widget will display an additional input field for the newly added language.
See the example below for how the level name field appears when two languages are active (left) versus when only one language is active (right):
***
## What Fields Will Be Affected Once You Add a New Language?
Once you add a new supported language to your Gameball account in addition to the default one, the following fields will require corresponding data in the newly added language:
* **Score name**, if you are using Score as the leveling-up method
* **Points name**
* **Level name**
* **Challenge name and description**
* **Guest view intro and button text**
* **Referral tab title and description**
* **Message title, body, and button text**
* **All system notifications**
In case you are adding a new language after finishing the experience design and configurations, you will need to update all the above fields one by one to add the corresponding data for every field.
***
## What's Next?
Adjust colors, fonts, icons, and identity to align the widget with your platform's look and feel.
Control which tabs appear in your widget and in what order they are displayed.
Configure the guest experience, including images, sign-up URLs, and login redirects.
Control the shape, position, icon, and visibility of your loyalty launcher button.
# How Do I Control Gameball Leaderboard on Widget?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/control-gameball-leaderboard-on-widget
Learn about how Gameball's leaderboard work, and how you can hide it.
## Plan Availability
| **Platform** | **Plan** |
| ------------ | ---------------------------------- |
| Shopify | Add-on for Pro / Available on Guru |
| Non-Platform | Add-on (Contact Support) |
| Salla | Add-on for Pro / Available on Guru |
Leaderboards can be a great tool to create a competitive environment and encourage your customers to be more active. However, leaderboards could also be demotivating if deployed within the wrong crowd. Gameball gives you the option to use it or to completely remove it when it is not convenient.
***
## How Does Gameball Leaderboard Work?
The leaderboard lets the customer track their progress and compare it to all your other customers.
The customer will be ranked based on their progress according to the [method of Tiering up](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods) that you have configured in the Tier program. For example, if you chose "Amount Spent" to be the tiering up method, the customer will be ranked based on the amount they spent in comparison to other customers' spending.
To view the leaderboard, the customer needs to click on the **Progress bar** or the **Tier** found on the home section of the widget, then switch to the **Leaderboard tab**. The customer will then see their rank amongst other customers.
***
## How Can a Customer Know Their Exact Rank?
Customers can see their rank in comparison to the rest of the customers in the text above the customer list.
They can also filter the rank list according to:
* Today
* Yesterday
* This week
* Last week
* This month
* Last month
* This year
* All-time
***
## How to Show or Hide the Gameball Leaderboard from the Widget
On the **Gameball Admin Dashboard**, go to **Widget > General: Visibility**.
Under the **Leaderboard Tab**, check **Show** or **Hide** based on your objective.
Click **Save**, then refresh your website. You will find that the leaderboard tab has been completely removed (or restored).
***
## Related Articles
Control the shape, position, icon, and visibility of your loyalty launcher button.
Control which tabs appear in your widget and in what order they are displayed.
# How Do I Control Gameball Widget Visibility on My Platform?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/control-gameball-widget-visibility-on-your-platform
Learn about the three different stages that help you control the presence of Gameball widget on your platform.
There are different ways to control your customer's interaction with the widget, starting from entirely eliminating the widget to only hiding the button.
Here are the three different stages through which you can control the Gameball widget:
***
## Stage 1: Publish and Unpublish Gameball Loyalty Experience
By toggling the switch at the top right of any page on the **Gameball Admin Dashboard**, you will be able to activate or deactivate the Gameball loyalty experience.
Once toggling to unpublish, your customers will no longer find the Gameball widget on your platform. Any actions like purchases done by your customers during the time Gameball is inactive will still reflect on Gameball; however, your customers will not be rewarded for their activity.
When the Gameball program is switched to unpublished, any customer event will still reflect on their profile on the dashboard; however, they will appear dimmed as these actions will have no consequence.
Once you switch it back on, the widget will appear again on your platform, and your customers will start getting rewarded again.
### What happens when you deactivate the program by switching off the toggle?
When you disable Gameball:
* Your loyalty program will **not** be visible to your customers.
* Your customers will **not** earn rewards.
* Your customers will **not** receive any messages, notifications, or emails.
* Your customers' actions will be added to Gameball.
* Your customers will be able to use coupons they had already claimed before disabling the program.
- Gameball will still be receiving any actions when the toggle is deactivated. **However**, no changes will take place as a result of these player actions.
- Publishing Gameball means that your customers will be able to see the Gameball widget (if the widget is not hidden), and they will start getting rewards based on the designed loyalty experience.
***
## Stage 2: Hiding and Unhiding Gameball Widget
You can completely hide Gameball's widget without deactivating the loyalty program, which means your customers will still be rewarded for their interaction; however, they will not be able to track their progress or find anything related to the configured loyalty program.
In the **Gameball Admin Dashboard**, click **Widget > General: Visibility**.
Choose whether to display or hide the Gameball widget by checking **Show** or **Hide** under **Customer** and **Guests**.
Click **Save** to apply your changes.
***
## Stage 3: Hiding and Unhiding Gameball Widget Button
Lastly, you can choose between hiding or displaying the Gameball launch button on your platform. If there is no space for the Gameball launch button on your platform, or none of Gameball's available buttons match your brand theme, you can simply hide it and let other inline buttons or any other interactive elements open the Gameball widget. Read more on [Enabling Opening Gameball Widget by Using Deeplinks](/product-documentation/customer-widget/player-profile-tabs/enable-opening-gameball-widget-through-inline-links-using-deeplinks).
In the **Gameball Admin Dashboard**, click **Widget > Launcher: Shape**.
Under **Launcher**, choose the **Hide** option to hide the Gameball launch button.
Click **Save** to apply your changes.
Now, the Gameball button will no longer appear on your platform, so make sure to use our [Deep Links](/product-documentation/customer-widget/player-profile-tabs/enable-opening-gameball-widget-through-inline-links-using-deeplinks) if you still want your customers to access the widget from a different place on your platform.
***
## Related Articles
Adjust colors, fonts, and identity to align the widget with your platform's look and feel.
Control the shape, position, icon, and visibility of your loyalty launcher button.
# How Do I Customize My Gameball Customer Widget to Match My Brand?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/customize-your-gameball-customer-widget-to-match-your-brand
Learn how to customize Gameball customer profile widget style and colors to match your website/app branding.
## Plan Availability
| Feature | Plan |
| --------------------------------------- | --------- |
| Basic customization | All plans |
| Theme, Font, Points/Score names & icons | Pro, Guru |
| Guest widget image | Pro, Guru |
| Feature | Plan |
| --------------------------------------- | ------------------ |
| Basic customization | Growth, Enterprise |
| Theme, Font, Points/Score names & icons | Growth, Enterprise |
| Guest widget image | Growth, Enterprise |
When your loyalty widget feels out of place on your platform, customers may perceive it as intrusive or untrustworthy. That's why customizing the widget to align with your brand's identity is essential for increasing engagement and trust. Here are detailed steps for how to customize your entire widget to match your brand's theme.
***
## Colors
To brand your Gameball customer widget to match your website or app, go to the **Gameball Admin Dashboard** and navigate to **Widget > Branding: Colors**.
**Available on:** Shopify & Salla Pro/Guru | Non-platform Growth/Enterprise
Choose between two modes:
* **Light:** Light mode is the default mode unless set otherwise.
* **Dark:** The main layout color will change to black.
This is the main color that will be applied to all tabs of the profile. You can easily choose the brand colors you use on your platform.
Use the color palette to choose a color that matches your platform theme either by hovering over the palette with your cursor and then clicking on the closest color to your platform. Or for more accurate branding, type down your brand's color code, and click **Save**.
**Available on:** Shopify & Salla Pro/Guru | Non-platform Growth/Enterprise
You can choose one of the following 7 fonts:
* Montserrat
* EB Garamont
* Roboto Slab
* Sansita Swashed
* Mali
* Work Sans
* Rubik
Available for **web only**.
For web applications, you will have a launcher button that will be placed on your website to load/open the Gameball customer widget. You can control the colors of the button:
* **Launcher Main Color**
* **Icon Color**
* **Text Color**
***
## Identity
To give your loyalty assets unique names and icons, switch to the **Identity Tab**.
Give your loyalty program a name that goes well with your platform's identity. For example, if your platform sells flowers, then a good name for your rewards program could be "Lily Rewards."
* **Program Name Examples:** Plus Rewards, Adventure Rewards, Fun Portal, etc.
**Available on:** Shopify & Salla Pro/Guru | Non-platform Growth/Enterprise
In case you are using score as the [Tiering-up method](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods), you can also give the score a different name, just as you can do that to the points.
* **Points Name Examples:** Coins, Tokens, Credit, etc.
* **Score Name Examples:** Freebies, Rank, Gems, etc.
* **Earn Name Examples:** Win, Acquire, Save, etc.
* **Redeem Name Examples:** Spend, Exchange, etc.
**Available on:** Shopify & Salla Pro/Guru | Non-platform Growth/Enterprise
Choose icons from Gameball's icon library for:
* **Points Icon**
* **Score Icon**
Choose icons from Gameball's icon library or **upload your own icons** for:
* **Earn Icon**
* **Redeem Icon**
***
## Guest Widget
**Available on:** Shopify & Salla Pro/Guru | Non-platform Growth/Enterprise
### Uploading an Image as a Widget Icon for Guests
One of the things that directly affect the branding is the main widget icon that shows on the guest landing page of the widget. You can choose an icon that represents your idea of loyalty without drifting from the platform's main theme.
To change the main guest widget icon, go to **Widget > Branding: Guests** in the **Gameball Admin Dashboard**.
Under **Image**, choose between the following:
* **Default Image:** Leave Gameball's default icon as it is.
* **Upload Image:** Upload your own image from your own library to match your theme.
* **None:** Leave the guest widget without an icon.
When choosing **"Upload Image,"** the image size and type must be: 280px x 280px. JPEG or PNG.
### Create Account URL
Paste the website link where customers can create a new account.
### Login URL
Paste the website link where customers can log in.
Lastly, click **Save**.
***
## What's Next?
Control the shape, position, icon, and visibility of your loyalty launcher button.
Control which tabs appear in your widget and in what order they are displayed.
Configure the guest experience, including images, sign-up URLs, and login redirects.
Set a default language and add additional languages to serve a multilingual audience.
# How Do I Customize My Loyalty Launcher to Fit My Platform's Interface?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/customize-your-loyalty-launcher-to-fit-your-platforms-interface
Learn how to control and change your widget button so that it matches your brands's theme and feel.
To customize your widget launcher/button, go to **Widget > Launcher: Customize** in the **Gameball Admin Dashboard**.
***
## Direction
Start by controlling which area of the page the widget launcher button should be displayed on:
* **Left**
* **Right**
***
## Launcher Customization Options
**Uploading an Image to Edit the Launcher Icon is available on:**
| Platform | Plan |
| -------------------- | ------------------ |
| Shopify | Pro, Guru |
| Salla | Pro, Guru |
| Non-platform clients | Growth, Enterprise |
Choose between the following:
* **From Library:** Choose from Gameball's icons library.
* **Upload Image:** Upload your own image from your own library to match your theme.
When choosing **"Upload Image,"** the image size and type must be: 60px x 60px. JPEG or PNG.
Type down a small text that would appear on the widget button. It could be something simple such as: "Rewards"
To customize launcher visibility and animation, go to **Widget > Launcher: Shape** in the **Gameball Admin Dashboard**.
Under **Launcher**, choose between:
* **Show:** Ensures the button will be visible to all your players and visitors.
* **Hide:** Button will not be visible.
Under **Launcher Effect**, choose between:
* **Enabled:** Enables a wiggly-like effect to the widget to help customers notice it.
* **Disabled:** Disregards the animation.
Hiding the launcher does not deactivate the loyalty program.
You can control the shape of the profile launcher button. Gameball offers multiple shapes to let you choose from based on your preference or what will be a better match with your website design:
* **Corner Curve**
* **Circle**
* **Center Tab**
* **Oval With Text:** In this case, you will need to add the text and its color.
* **Center Tab With Text:** In this case, you will need to add the text and its color.
This will let your customers launch the Gameball customer widget through any button on your website. Learn more about this in [Enable Opening Gameball Widget Through Inline Links Using Deep-links](/product-documentation/customer-widget/player-profile-tabs/enable-opening-gameball-widget-through-inline-links-using-deeplinks).
***
## What's Next?
Control which tabs appear in your widget and in what order they are displayed.
Configure the guest experience, including images, sign-up URLs, and login redirects.
Set a default language and add additional languages to serve a multilingual audience.
# How Do I Customize Tabs' Visibility and Order in Gameball Widget Settings?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/customizing-tabs-visibility-and-order-in-gameball-widget-settings
Configure the General Settings of the Gameball Widget: Control Tab Visibility and Reorder Reward Campaigns Badges
## Plan Availability
| **Platform** | **Plan** |
| ------------ | -------- |
| Shopify | All |
| Salla | All |
| Non-Platform | All |
You can customize the features displayed to your customers on the Gameball widget with ease. Follow these simple steps to access the General Settings of the Gameball Widget:
Log in to the **Gameball Admin Dashboard**.
From the side menu, navigate to **Widget**, then click on **General**.
***
## Widget Language
You can display your widget in multiple languages to match your customers' preferences. Check [the list of languages you can set](/product-documentation/customer-widget/start-configuring-profile/configure-customer-widget-language-on-your-platform).
***
## Visibility
Manage the overall visibility of the widget, including specific tabs and sections. Access these settings under the **Visibility** tab in the **General** section.
Determine who can see the Gameball customer widget, differentiating between Customers and Guests:
* **Guests**: A visitor to your website who does not have an account or has not logged in.
* **Customers (User)**: A visitor who has created an account and is logged in.
These settings are only applicable in the web version of the Gameball customer profile.
| **Platform** | **Plan** |
| ------------ | ---------------------- |
| Shopify | Pro & Guru |
| Salla | Guru |
| Non-Platform | Add-on (Contact Sales) |
Choose to show or hide specific tabs:
* **Tiers Card**: Displays the configured tiers and benefits.
* **Leaderboard Tab**: Shows the leaderboard.
* **Recent Tiers Benefits**: Displays the benefits of the previous tiers.
Control the visibility of the Play & Win section of the widget by deciding to show or hide it. This section includes all the active game campaigns you had set. Note that by hiding this section, game campaigns will act as if they do not exist for your customer, as they will not be able to access them.
The Play & Win section is also automatically hidden when there are no active game campaigns configured for the customer's current platform — web or mobile app. This means customers will never see an empty Play & Win section due to campaigns being set up for a different platform.
**Hiding individual game campaigns:** Go to **Widget > General > Games** to see all your active game campaigns, each with a **Show in widget** toggle. Turn the toggle off for any game you want to hide from the default widget — it stays fully active and launchable via the SDK or a deep link, so you can surface it in your own UI without it appearing in the widget. The Play & Win tab auto-hides when all games are turned off.
Choose to show or hide specific sections on **Referrals**:
* **Rewards Section**: Choose to show or hide the rewards section on Referrals.
* **Points in Referrals Page**: Show or hide the points balance inside the referral page.
* **Referral Image:** Choose to go with the default referral image, upload your own image to match your brand theme, or to leave the referral section on the widget with no image.
* **Sharing Option**: Choose to display customers' unique link as a full link or rather just a code.
Example:
Link: [https://xxx.com/account/register?ReferralCode=Vg6945F76CkP1B](https://xxx.com/account/register?ReferralCode=Vg6945F76CkP1B)
Code: Vg6945F76CkP1B
* **Notifications Icon**: Optional. Enable or disable the notifications tab as needed.
* **Gameball Footer**: Choose whether to display the Gameball logo at the bottom of the customer/guest widget.
The remove footer feature is only available on:
**Shopify:** **Starter, Pro,** and **Guru** plans.
**Salla: Pro** and **Guru** plans.
**Non-Platform:** All.
* **Gameball FAQ**: Show or hide the FAQ tab, which briefly explains your loyalty program to guests and customers.
* **Coupons Tab**: Show or hide the Coupons tab, which has the list of all the redeemed coupons from both the Redeem and the Referrals modules on the widget.
* **Points Card:** Show or hide the current customer's points balance.
* **Trophy Image:** Show or hide the big trophy image in the widget's home page.
Hiding of the trophy option will be shown only in case the Tier and Referral cards are set to hidden.
***
## Sort Reward Campaigns Badges on Widget
Organize the icons in the **Reward Campaigns** section of the widget by going to the **Reward Campaigns** tab.
Select your preferred method for ordering reward campaigns:
* **Creation date**: Display reward campaigns based on the order of their creation.
* **Name**: Alphabetically from A to Z.
* **Manual**: Drag and drop reward campaigns to arrange them as you prefer.
***
## Redemption Options
Go to **Widget > General > Redemption Options** to control which redemption options appear in the widget and in what order.
Each option has a **Show in widget** toggle. It's on by default — turn it off to hide that option from the widget without disabling it. Hidden options remain fully callable via the API, so you can build a custom redemption flow in your own UI while keeping the default widget clean.
**Ordering:** Choose how redemption options are sorted in the widget:
* **Creation Date**: Displayed chronologically by setup date.
* **Points Amount**: Sorted from lowest to highest cost.
* **Manual**: Drag and drop to arrange them exactly as you like.
***
## Calendar Banner
Personalize the banner that appears in the widget for calendar campaigns. Navigate to **Widget > Content > Games** to configure the following:
| Field | Description |
| -------------------------- | --------------------------------------------------- |
| **Calendar Banner Title** | The headline displayed on the banner |
| **Calendar Banner Button** | The CTA text customers click to enter the campaign |
| **Background** | Choose an image from the library or upload your own |
| **Icon** | Use the default icon or upload a custom image |
When multiple calendar campaigns run simultaneously, a selector appears so you can configure the banner for each campaign independently.
***
## Sort Play & Win Options on Widget
When you have multiple game campaigns customized, you will be able to control how they appear in the section as well as their order from the **Play & Win Options** tab under the General widget section in the dashboard.
* Drag and drop each game campaign card.
* Choose the style of each game campaign card. Choose between a square-shaped card or a rectangular-shaped card.
The **"New" badge** that appears on recently added game cards uses the game's configured **button color** — it is not independently customizable.
Remember to click **Save** when you are done with ordering.
***
## What's Next?
Configure the guest experience, including images, sign-up URLs, and login redirects.
Set a default language and add additional languages to serve a multilingual audience.
Adjust colors, fonts, icons, and identity to align the widget with your platform's look and feel.
# How Do I Edit Guest View Content and FAQ Section of the Widget?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/edit-guest-view-content-and-faq-section-of-the-widget
Learn how to edit the text in both the FAQ section and the guest view content of the widget.
You can edit these parts of the widget:
* The **guest view content** shown to visitors who have not yet signed in.
* The **FAQ section** found at the top of the widget.
***
## Editing the Guest View Content
On the **Gameball Admin Dashboard**, go to **Widget > Content: Guests**.
The following fields are available to customize:
| **Tab** | **Description** |
| ------------------------------------------------------- | -------------------------------------------------------------------------------- |
| **Signup Description** | Displays the main description message shown to guest users on the signup screen. |
| **Already have an account?** | Text prompting users who already have an account. |
| **Sign In** | Call-to-action for existing users to log in. |
| **Signup Description (Default Redemption Rule Hidden)** | Alternate signup message shown when the default redemption rule is hidden. |
| **Join Now** | Call-to-action inviting the user to register. |
| **Guest Card Title** | The title displayed at the top of the guest card. |
| **No Rolls Left Description** | Message shown when the guest has no more chances (rolls) left. |
Fill in the needed information and click **Save**.
***
## Editing the FAQ Section
On the **Gameball Admin Dashboard**, go to **Widget > Content: FAQ**.
The following fields are available to customize:
| **Tab** | **Description** |
| ----------------------------------- | ------------------------------------------------------------------- |
| **What is this? Title** | The heading for the FAQ section introducing the widget or program. |
| **What is this?** | Content explaining the purpose of the widget or loyalty program. |
| **What is Score? Title** | The heading introducing the Score concept. |
| **What is Score?** | Description of what a Score is and how it is used. |
| **What is Points? Title** | The heading introducing the Points concept. |
| **What is Points?** | Description of what Points are and how they are earned or redeemed. |
| **Ways to Earn Title** | Heading for the list or section showing earning methods. |
| **Reward Campaigns Description** | Explanation of how customers can earn through campaigns. |
| **Reward Campaigns Title** | Heading for the reward campaigns section. |
| **Tiers Description** | Information about the tiered loyalty levels and their benefits. |
| **Tiers Title** | Heading for the tiers section. |
| **Referral Description** | Explanation of the referral program and its benefits. |
| **Referral Title** | Heading for the referral program section. |
| **Cashback Description with Score** | Description of how cashback works when tied to score-based systems. |
| **Cashback** | General term used for cashback rewards. |
| **Ways to Redeem Title** | Heading for the list or section showing how to redeem rewards. |
| **Flat Rate** | A redemption method where a fixed point cost applies. |
| **Free Shipping** | A reward option offering free shipping for redemptions. |
| **Percentage Base** | A reward where the discount is calculated as a percentage. |
| **Free Product** | A reward where customers receive a free item upon redemption. |
| **Merchant Description** | General description of merchant-defined rewards. |
| **Fixed Amount-based Discount** | A reward offering a fixed monetary discount on a purchase. |
Fill in the needed information and click **Save**.
***
## Related Articles
Configure the guest experience, including images, sign-up URLs, and login redirects.
Control which tabs appear in your widget and in what order they are displayed.
# What Is Guest Widget Configuration for Web?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/guest-widget-configuration-for-web
Encourage your guests to create an account on your website or login using their current account.
For **Web only**, when you have a guest visitor, Gameball does not create a profile for the customer until guests signup on your platform. Once your guest logs in or creates an account, Gameball creates a profile for them and they start getting enrolled in the Gameball rewards experience through the widget.
Below is an example of how the guest view widget looks for your guest visitors:
You can access the guest view configurations in **Gameball Admin Dashboard** through **Widget > Branding: Guest**.
***
## Configuring the Guest Widget
By default, Gameball has an image of a trophy set right above the sign-up button. Choose one of the following options:
* **Default Image:** Leave the trophy image as-is.
* **Upload Image:** Choose an image that goes with your brand.
* **None:** Remove the image entirely.
Uploading a custom guest image is available on:
| Platform | Plan |
| -------------------- | ------------------ |
| Shopify | Pro, Guru |
| Salla | Pro, Guru |
| Non-platform clients | Growth, Enterprise |
Insert the URL of the registration/signup page on your platform. Guests will be directed here when they click the sign-up call-to-action.
For guests who have previously signed up but only need to log in, insert the URL of the page you want your player to get redirected to in order to sign back in.
Click **Save** to apply all your guest widget configurations.
***
## What's Next?
Customize the text displayed to guests in the widget, including sign-up prompts and FAQ content.
Control which tabs appear in your widget and in what order they are displayed.
Adjust colors, fonts, icons, and identity to align the widget with your platform's look and feel.
Set a default language and add additional languages to serve a multilingual audience.
# How Do I Hide Gameball's Widget Button?
Source: https://docs.gameball.co/product-documentation/customer-widget/start-configuring-profile/hiding-gameballs-widget-button
Learn how to hide Gameball widget launcher button from your platform by following some easy steps.
If you do not want to choose any of the available Gameball launcher shapes because they do not match your brand theme, or you simply do not have a space for them, you can hide the widget launcher button and use Gameball deep links on your platform to open the Gameball widget. Read more about [how to use deep links to open Gameball widget](/product-documentation/customer-widget/player-profile-tabs/enable-opening-gameball-widget-through-inline-links-using-deeplinks).
***
## How to Hide Gameball's Traditional Launcher Button
On the **Gameball Admin Dashboard**, go to **Widget > Launcher: Shape**.
Under **Launcher**, choose the **Hide** option.
Click **Save** to apply your changes.
Now, Gameball's launcher button will no longer appear on your platform. Make sure to use our [Deep Links](/product-documentation/customer-widget/player-profile-tabs/enable-opening-gameball-widget-through-inline-links-using-deeplinks) if you still want your customers to access the widget from a different place on your platform.
***
## Related Articles
Control the shape, position, icon, and visibility of your loyalty launcher button.
Adjust colors, fonts, icons, and identity to align the widget with your platform's look and feel.
Let customers open any section of the widget through custom links and inline elements on your site.
# What Is Ways to Encourage Customers to Enroll in Your Loyalty Program?
Source: https://docs.gameball.co/product-documentation/enhancing-loyalty-program/encourage-customer-enrollment
The different approaches you can take to push your current customers to join the loyalty experience and become more active.
There are plenty of tools Gameball offers to attract visitors to enroll and become more engaged. Here are some ideas you can implement for a guaranteed increase in acquisition.
***
## Tools to Drive Enrollment
Reach unregistered visitors with targeted messages that sell the loyalty experience and encourage them not to miss out on great rewards.
Draw in visitors and motivate them to register for your loyalty program with an attractive reward and exciting challenges.
Let your loyal customers encourage guests to sign up with an appealing referral program where both parties get solid rewards.
Encourage customers to register before completing any purchase so they can earn part of their spending back as points and redeem them on new purchases.
***
## Guest Messages
With the correct articulation, timing, and placement, you can sell your visitors the loyalty experience created to reward them just for being active. Gameball Messages not only targets registered customers — you can also reach out to unregistered customers (guests) and encourage them not to miss out on the great rewards. [Learn how to configure a guest message](/product-documentation/communication-campaigns/create-and-configure-email-campaigns).
***
## Signup Reward Campaign
The SignUp campaign is a powerful tool to draw in visitors and motivate them to register for your loyalty programs. With an attractive reward and other great challenges, they can explore and benefit from just signing up. [Learn how to create a sign up reward campaign](/product-documentation/rewards-campaigns/acquire-reward-campaign-templates).
***
## Referral Program
Let your loyal customers encourage guests to sign up! By creating an appealing referral program where both your customers and their friends get solid rewards, you will see a noticeable number of registrations within a short period of time. [Learn how to configure a referral program](/product-documentation/programs/referrals/launching-referral-program).
***
## Cashback
Cashback is a well-known method that has various benefits. Not only will it increase your sales, but it will also encourage your customers to register for your loyalty experience before they complete any purchase. This way, they will get part of their spending back in the form of points, which they can redeem as coupons and use on new purchases. [Learn how to configure a cashback program](/product-documentation/programs/redemption/launch-configure-redeem-pointing-system).
Make sure to inform your customers of the signup campaign and the cashback program through the widget or a guest message.
# What Are Placeholder Variables in Email Notifications?
Source: https://docs.gameball.co/product-documentation/instant-notifications/email-notifications/placeholder-variables
Add placeholder variables in email notifications and send customers personalized data.
Available for all Gameball customers except for free packages
Placeholder variable text is used to add personalized data on each customer to your email notifications. Variables appearing in the email notifications preview are automatically replaced with actual data. So when the actual email notification is sent to your customers, the actual data appears instead of the variable placed.
Starting with a quick overview of variables. A variable is a value that can change depending on conditions or on information passed to the program. It is simply a name that can be replaced with a real value from computer memory.
***
## Using Merge Tags
To use a variable in an email, click **Merge Tags** and select your variable.
***
## Available Variables
At Gameball, we use the following variables in email notifications:
| Variable | Definition |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Customer's first name | The customer's first name, if available. |
| Display Name | Display name |
| Customer's email | The customer's email, if available. |
| Score earned | The score earned with the customer's latest achievement. [Learn more](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods) |
| Equivalent value of earned points | Points earned with the customer's latest achievement. |
| Equivalent value of total points | The equivalent monetary value of points. |
| Currency | Currency is set through the **Admin Settings**. |
| Points name | A customized name for points in the default language, based on your settings. |
| Score name | A customized name for the score in the default language, based on your settings. [Learn more](/product-documentation/programs/vip-tiers/tier-settings/tiering-up-methods) |
| Equivalent value of total points | Customer's total points after completing their latest achievement. |
| Equivalent value of new points | The equivalent monetary value of new points. |
| New Tier | The new tier was reached by the customer. |
| Previous Tier | Customer's tier before their latest achievement. |
| Referral Link | Customer's link they use in the referral process |
| Mobile Referral Link | Customer's link they use in the referral process via mobile |
| Paid Amount | The amount a customer paid in a given order |
| Merchant Name | Merchant Name |
| Branch Name | Branch Name |
| Return Days | Number of days for the return window |
| Available Points | Available points |
| Pending Points | Pending Points |
| Birthday | Customer's birthday, if available |
| Remaining to Next Tier | The number of points, orders, or referrals the customer needs to reach their next VIP tier. |
***
## What's Next?
Gameball sends notifications any time a customer completes an achievement like signing up, completing a purchase, or earning points depending on your configurations. Include the adequate variable to offer your customers personalized messages through emails. Check this [blog](https://blog.gameball.co/how-to-use-customized-messages-for-better-customer-experience/) to learn more about personalized messages.
You are now all set to [activate](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails) your email notification and start notifying your customers of their achievements through emails!
***
## Related Articles
Overview of all real-time notification types available across Gameball programs.
# How Do I Send Customers Emails Celebrating Achievements?
Source: https://docs.gameball.co/product-documentation/instant-notifications/email-notifications/sending-achievement-emails
Send your customers email notifications with their latest achievements and drive them back to your platform.
Available for all Gameball customers except for free packages
Enable the email notifications feature to send your customers emails every time they earn cashback, points, or complete reward campaigns on your platform.
Sometimes, customers earn points or win reward campaigns while they are not on your platform — for example, if their sign-up anniversary or birthday triggers a reward on a specified day without any recent interaction from their side. This is where email notifications can be very useful. Enabling email notifications can help you drive back your customers to visit your platform.
Customers who do not want to keep receiving your emails can easily unsubscribe through a small hyperlink at the bottom of every Gameball email.
***
## Where to Find the Email Notification Section
On the **Gameball Dashboard**, from the left bar, click **Notifications**, then select **Emails**.
***
## Types of Email Notifications
You can enable email notifications for the following types of achievements:
Welcome new customers who have just signed up to your loyalty program.
Inform your customers when they receive a cashback reward.
Inform your customer when a previous referral attempt becomes successful, or when they receive a reward for that referral.
Congratulate your customers upon achieving all the reward campaign requirements and winning it.
Congratulate and inform your customers when they reach a new tier or level.
Inform your customers upon the following transactional rewards events:
* **Coupon Earned:** Sending customers an email every time they successfully receive a coupon as a reward.
* **Points Expiry Reminder:** Reminding customers with the points about to expire 15 days before the expiry date.
* **Coupon Expiry Reminder:** Reminding customers with the coupons about to expire 15 days before the expiry date.
***
## Email Notifications Settings
The email settings section is where you configure general settings for all your emails:
| Setting | Description |
| ---------- | --------------------------------------- |
| From Name | Your brand or business name. |
| From Email | Your customer-facing official email. |
| Domain | Available on Enterprise and Guru plans. |
***
## Email Notifications Components
For each email type, there is a default template that you can use, or you can customize your own email template. There are some components you need to be aware of before customizing your own emails:
* Subject
* Logo
* Banner / Image
* Title / Heading
* Body
* Variables
* Button
Use the **email composer toolkit** on the right to construct your email.
***
## Setting Up and Activating Email Notifications
Before activating your customer email notifications, you can send a test email to yourself (the logged-in user) to preview what will be sent to your customers. Click **Send Test Email**.
You have a limit of only 50 test emails per day.
To activate any of your customer email notifications, all mandatory fields must be filled first. For templates you have configured, tested, and are ready to activate, go to the tab of the same email type and switch the toggle to **Active**.
You can enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
You must activate each and every email type through their designated tab; the toggle on each tab only activates the email type you are viewing.
**Communication Campaign Emails (Outbounds)** is a separate feature that allows you to send customized emails. Email campaigns have a [limit](/product-documentation/guides-strategies-faqs/shopify-guides/track-email-consumption) of 10,000 emails per billing cycle for PRO and Guru plans. [Learn more about Email Campaigns](/product-documentation/communication-campaigns/create-and-configure-email-campaigns).
***
## Common Questions
No. At Gameball, we follow international email regulations like the U.S. CAN-SPAM Act and Canada's CASL. These laws require that all promotional or automated emails include clear sender information and an unsubscribe option. This is why that section of the email footer is fixed — it is there to protect both you and your customers and to ensure that all emails sent through Gameball remain compliant.
***
## Related Articles
Use merge tags and variables to personalize every email sent to your customers.
# How Do I Send Real-Time Notifications for Cashback?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/cashback-notifications
Notify your customers upon a cashback transaction using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
When a customer earns points for completing a purchase, they might earn some points back as cashback. It is important to notify your customers instantaneously with a message that informs them of the amount of points they have received for that transaction.
The same applies in case points were revoked for a cancellation or a refund. Inform the customer of the canceled cashback points and let them know their current points balance.
***
## How to Create Real-Time Notifications for Cashback
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Cashback** and select between **Cashback Rewards** or **Cashback Cancelled**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Add your message script for each cashback notification type:
Send real-time transaction notifications for every cashback transaction. Inform your customer how many points they have earned just after they have completed a purchase, along with their current points balance.
Send a real-time notification to your customers upon canceling a purchase. If the points earned for a specific purchase have been revoked for any reason, inform them of how many points have been taken back and what their current points balance is.
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Points Earned, Tier-up Progress, Points, Points Before, Level Up total progress.
* **Transaction Variables:** Equivalent value of total points, Equivalent value of earned points, Currency, Points Name, Referral Link, Mobile Referral Link, Paid Amount, Merchant Name, Branch Name, Return Days, Available Points, Pending Points.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Notify customers when they level up to a new tier in your loyalty program.
Keep customers informed of reward campaign unlocks, progress, and achievements.
Alert customers when a referral is successful or when a referral reward is earned.
Notify customers about points redemption, refunds, and expiry events.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications for Manually Adding & Deducting Points?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/manual-points-notifications
Notify your customers upon adding or deducting using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
When you add or deduct points from a customer, you will need to instantaneously inform your customer how many points were added or removed and what their current points balance is.
***
## How to Create Real-Time Notifications for When Points are Added or Deducted
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Add/Deduct Points** and select between **Add Points** and **Deduct Points**.
Construct a heading and a body for the notification.
Add your message script for each notification type:
Send real-time transaction notifications for any points manually added. Inform your customer how many points they have received, why they have received these points, and their current points balance.
Send a real-time notification to your customers upon manually deducting points from their account. If the points are deducted for a specific reason, inform them of how many points have been taken back and what their current points balance is.
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Points Earned, Tier-up Progress, Points, Points Before, Tier Up total progress.
* **Transaction Variables:** Equivalent value of total points, Equivalent value of earned points, Currency, Points Name, Referral Link, Mobile Referral Link, Paid Amount, Merchant Name, Branch Name, Return Days, Available Points, Pending Points.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Notify customers when they level up to a new tier in your loyalty program.
Keep customers informed of reward campaign unlocks, progress, and achievements.
Notify customers of cashback rewards earned or canceled for their transactions.
Notify customers about points redemption, refunds, and expiry events.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications for Referrals?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/referral-notifications
Notify your customers upon a successful referral using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
When a customer refers a friend they will want to know if their referral was completed. It is important to notify your customer instantaneously with a message that tells them their referral was successful. You might also want to send a notification when they receive a reward for that successful referral.
***
## How to Create Real-Time Notifications for Referrals
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Referrals** and select between **Successful Referral** and **Referred Friend Achievement**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Add your message script for each referral notification type:
Send real-time transaction notifications for every successful referral. Inform your customer when the friend they referred has completed the required action.
If you reward your customers when their referral attempt becomes successful, ensure that your customer receives a real-time notification informing them that they have received an award due to their successful referral attempt.
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Points Earned, Tier-up Progress, Points, Points Before, Tier Up total progress, Total Friends Referred.
* **Referral Variables:** Equivalent value of total points, Equivalent value of earned points, Currency, Points Name, Referral Link, Mobile Referral Link.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Notify customers when they level up to a new tier in your loyalty program.
Keep customers informed of reward campaign unlocks, progress, and achievements.
Notify customers of cashback rewards earned or canceled for their transactions.
Notify customers about points redemption, refunds, and expiry events.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications for Completing a Reward Campaign?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/reward-campaign-notifications
Notify your customers upon achieving a reward campaign using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
If you want your customers to engage with your [preset reward campaigns](/product-documentation/rewards-campaigns/introduction-rewards-campaigns), make sure to create automated real-time notifications to inform them when the campaign is unlocked, or achieved, or when you want to motivate them to keep going mid-way.
There are two portals to create a real-time notification for when a reward campaign is achieved:
Create a notification through the Global Real-time Notification section on the dashboard, applying to all reward campaigns.
Create a different notification for each [reward campaign](/product-documentation/rewards-campaigns/introduction-rewards-campaigns) via the internal reward campaign settings.
***
## Method 1: Global Notification Settings
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Reward Campaigns** and select between **Unlocked**, **Motivate Customers**, and **Achieved**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Add your message script for each reward campaign notification type:
Send real-time notifications when a customer has a new reward unlocked. This way they notice that there is a possibility to enroll in a new campaign and win a reward when completed.
Make sure your customers keep going and are proceeding with the required steps to complete the reward requirements and achieve their final goal by sending them a motivational message informing them that they are steps closer to winning.
Send a real-time notification when your customer completes all the requirements of the reward campaign. Inform them of their achievement, and the reward they have earned as a result.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Method 2: Creating a Notification Only for a Specific Reward Campaign
In the [reward campaign](/product-documentation/rewards-campaigns/introduction-rewards-campaigns) creation process in the **Gameball Admin Dashboard**, you can add a custom script to be sent for that specific reward campaign only, bypassing the global settings.
To create a reward campaign from scratch, follow the steps in this [article](/product-documentation/rewards-campaigns/start-from-scratch/create-action-based-reward-campaign).
While creating a new reward campaign, you will come across the **Notifications** section. Choose if you want to edit an **In-app Notification**, an **Email Notification**, or both by clicking on **Edit**.
Select between the following options:
| Option | Behavior |
| ------------------- | -------------------------------------------------------------------------------------------------------- |
| **Global Settings** | Follows the reward campaign notification created and activated through the main notification section. |
| **On** | Allows you to create your own message by writing a different **Head** and **Body** for the notification. |
| **Off** | Your customer will not receive a notification upon achieving this reward campaign. |
***
## Script Variables for Reward Campaigns Notifications
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Points Earned, Tier-up Progress, Points, Points Before, Level Up total progress.
* **Reward Campaign Variables:** Equivalent value of total points, Equivalent value of earned points, Currency, Points Name, Reward Campaign Name, Referral Link, Mobile Referral Link, Coupon Code, Coupon Value, Reward Campaign Reward.
***
## Related Articles
Alert customers when a referral is successful or when a referral reward is earned.
Notify customers of cashback rewards earned or canceled for their transactions.
Notify customers about points redemption, refunds, and expiry events.
Notify customers when they level up to a new tier in your loyalty program.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications on Tiers?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/tier-notifications
Notify your customers upon tiering up using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
When a customer meets the requirements needed to join a higher tier, it is important to inform them that they are now on that new level so they can check the benefits they can now enjoy and engage more.
***
## How to Create Real-Time Notifications for When a New Tier is Reached
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Tiers** and select **Tier Achieved**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Send a real-time notification to your customers upon leveling up to a higher tier. Let them know the name of the new tier they are on, the tier entry reward if there is any, and ask them to check the new tier's benefits.
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Tier-up Progress, Points, Points Before, Tier Up total progress, Total Friends Referred.
* **Tier Variables:** Equivalent value of total points, Equivalent value of earned points, Currency, Points Name, Achieved tier, Previous Tier, Next Tier, Tier rewarded points, Referral Link, Mobile Referral Link, Tier Entry Reward, Tier Lifetime Reward.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Keep customers informed of reward campaign unlocks, progress, and achievements.
Alert customers when a referral is successful or when a referral reward is earned.
Notify customers of cashback rewards earned or canceled for their transactions.
Notify customers about points redemption, refunds, and expiry events.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications for Transactional Rewards?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/transactional-rewards-notifications
Notify your customers upon Points redemption, refund, expiry, or coupon expiry using Gameball's real-time notifications.
Available for all Gameball customers except for free packages
When a customer redeems points or has some points refunded, or when points or coupons are soon to expire, you will need to inform your customer how many points were redeemed, refunded, or about to expire, and what their current points balance is.
***
## How to Create Real-Time Notifications for Transactional Rewards
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Rewards** and select between **Points Redemption**, **Points Refund**, **Points Expiry Reminder**, and **Coupon Expiry Reminder**. In case it is an email notification, you can also choose to create a notification for **Coupon Earned**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Add your message script for each transactional rewards notification type:
Send real-time transaction notifications for any points redeemed by a customer. Inform your customer how many points they have redeemed, and their current points balance.
Send a real-time notification to your customers upon a points refund. If the points are deducted for a specific reason, make sure to inform them of how many points have been taken back and what their current points balance is.
Send a real-time notification to your customers if a group of points is soon to expire. Inform them of the number of points that might expire as well as the date they will no longer be available.
Available only under **email notifications**. Send a real-time notification to your customers if a coupon is soon to expire. Inform them of the exact available coupon that might expire as well as the date it will no longer be available.
To send more personalized, relevant, and clear notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link, Points Earned, Tier-up Progress, Points, Points Before, Tier Up total progress.
* **Transaction Variables:** Equivalent value of total points, Equivalent value of earned points, Redeemed Points, Expiry Date, Currency, Points Name, Referral Link, Mobile Referral Link.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Notify customers when they level up to a new tier in your loyalty program.
Keep customers informed of reward campaign unlocks, progress, and achievements.
Alert customers when a referral is successful or when a referral reward is earned.
Notify customers of cashback rewards earned or canceled for their transactions.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Welcome Notifications for New Signups?
Source: https://docs.gameball.co/product-documentation/instant-notifications/real-time-notifications-per-program/welcome-notifications
Send your new customers a welcoming message using Gameball's real-time notifications.
When a new customer signs up for your loyalty program, ensure that they receive a warm welcome to get them started on the journey you have set for them.
***
## How to Create Real-Time Notifications for New Signups
In the **Gameball Admin Dashboard**, from the left bar, click **Notifications**. Choose between **In-App, Emails, & SMS**. Scroll to **Welcome** and select **New Signup**.
Construct a heading and a body for the notification. In case you are creating an email notification, write a clear subject line and body. [Learn how to write an email notification](/product-documentation/instant-notifications/email-notifications/sending-achievement-emails).
Send real-time notifications for every new signup that takes place. Welcome your new customers and inform them of any details they should know at this stage.
To send more personalized, relevant, and clearer notifications, add variables in between your messages by clicking the **+ icon**.
You can use variables in the scripts like the ones below:
* **Customer Variables:** First Name, Last Name, Display Name, Customer's Email, Referral Link, Mobile Referral Link.
* **Variables:** Currency, Points Name.
Before activating the notification, click **Preview** on the top right of the edit page to see what the notification will look like for customers.
You can edit the notification icon by choosing **Upload Icon**, then click **Upload Icon**.
Click **Update** from the bottom right.
Enable or disable the notification through the **Active Toggle**.
Do not forget to click on "**Save**" before you exit.
***
## Related Articles
Notify customers when they level up to a new tier in your loyalty program.
Keep customers informed of reward campaign unlocks, progress, and achievements.
Alert customers when a referral is successful or when a referral reward is earned.
Notify customers about points redemption, refunds, and expiry events.
Send achievement emails to drive customers back to your platform.
# How Do I Send Real-Time Notifications on Both Web and Mobile?
Source: https://docs.gameball.co/product-documentation/instant-notifications/send-real-time-notifications
Learn about all the different Real-time notifications you can send your customers for engaging with All Gameball programs.
Available for all Gameball customers
***
Through Gameball, you can control sending real-time transaction notifications to your customers for all programs. You can notify your customers of different events such as new sign-ups, cashback rewards, successful referrals, reaching a new tier, etc.
There are three forms of notifications you can set up:
Deliver instant pop-up notifications inside your app or website when customers earn or interact with rewards.
Send personalized emails to customers celebrating their achievements and driving them back to your platform.
Send text message alerts directly to customers' phones. Contact Sales for activation.
***
## How Notifications Appear to Customers
***
## What Events Can You Send Real-Time Notifications For?
Send a welcome notification when a new customer signs up for your loyalty program.
Notify customers when cashback rewards are granted or when a cashback transaction is canceled.
Inform customers when a referral is completed successfully or when they receive a reward for referring a friend.
Alert customers after you have manually added or deducted points from their account.
Notify customers when they unlock or complete a requirement for a badge or reward, or motivate them to finish mid-way through a campaign.
Congratulate customers when they move up from one tier to another.
Inform customers about transactional events such as redeeming points, points refund, points expiry, or coupon expiry.
***
## Related Articles
Notify customers when they reach a new tier in your loyalty program.
Keep customers engaged by notifying them of reward campaign progress and achievements.
Inform customers when their referral is successful and when they earn a referral reward.
Notify customers of cashback rewards earned or canceled for their transactions.
Alert customers when they redeem, refund, or have expiring points or coupons.
Send customers emails celebrating their achievements and driving them back to your platform.
# What Is Automatically Add Lifetime Tier Rewards at Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/checkout-components/automatically-add-tier-rewards-at-checkout
Automatically apply your customers' tier benefits at checkout for a seamless and enhanced shopping experience.
| **Platform** | **Plan** |
| ------------ | ---------- |
| Shopify | Pro & Guru |
Checkout app blocks are available for **Shopify Plus** customers only.
Make your VIP customers feel special by automating their loyalty benefits. With Gameball's **Auto-Apply Tiered Lifetime Rewards** feature, eligible rewards for specific tiers are seamlessly applied at checkout, enhancing the shopping experience and increasing redemption rates.
**Benefits:**
VIP customers don't need to manually apply their discount, streamlining the checkout process and adding convenience.
Automatically applying rewards reinforces the value of being a VIP, fostering loyalty and encouraging repeat purchases.
***
## Prerequisites
This feature is exclusively available to merchants on the **Shopify Plus** plan.
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's Theme Editor.
In the left sidebar, under the "Order Summary," click **Add App Block > Apps**, and search for the **"Checkout tier lifetime reward"**.
Select the **"Checkout tier lifetime reward"** app block and click **Save**.
***
## How It Works
When a logged-in customer reaches the checkout page, the extension will automatically apply a discount if the customer is part of a tier that qualifies for a lifetime reward.
If the discount cannot be applied due to conditions such as meeting a minimum order value, restrictions on combining discounts, or other advanced rules, an error message will appear explaining why the coupon cannot be used for the current cart.
Non-logged-in customers will not be able to receive a discount until they log in and become eligible for a tier with a lifetime reward. Once logged in, the same rules for applicable discounts will apply, including any restrictions that may prevent the coupon from being used.
***
## Important Notes
This extension will automatically not work if:
* The Gameball program is deactivated.
* The customer is excluded from the loyalty program.
* Your account is on a plan that doesn't support this feature.
***
## Frequently Asked Questions
This feature is exclusive to Shopify stores on Shopify Plus and select new Gameball plans.
The block will appear blurred in your store, and the Customize button in the dashboard will be disabled.
***
## Related Articles
Display customers' points balances in their profiles.
Let customers redeem points directly at checkout.
# How Do I Display Available Coupons at Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/checkout-components/display-available-coupons-at-checkout
Displays all the eligible rewards for the customers to automatically apply them to their order with just a few clicks.
| **Platform** | **Plan** |
| ------------ | ---------- |
| Shopify | Pro & Guru |
Checkout app blocks are available for **Shopify Plus** customers only.
At checkout, customers can now easily apply their available rewards or discounts through a convenient dropdown menu. This streamlined process enhances the checkout experience, making it quick and simple for customers to redeem their loyalty rewards.
**Benefits:**
The dropdown menu makes it easy for customers to view and apply their available rewards, reducing friction and speeding up the checkout.
By presenting all available rewards upfront, customers are more likely to redeem their points, boosting loyalty program engagement.
***
## Prerequisites
This feature is exclusively available to merchants on the **Shopify Plus** plan.
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's Theme Editor.
In the left sidebar, under the "Order Summary," click **Add App Block > Apps**, and search for the **"Checkout available rewards"** block.
Select the **"Checkout available rewards"** app block and click **Save**.
***
## How It Works
If you are not logged in, the extension will prompt you to log in to view your available rewards.
When the logged-in customer reaches the checkout page, the extension will be displayed, allowing them to select from their available rewards.
Once the customer clicks **'Apply'**, Gameball will automatically apply the discount to their order.
If the coupon is not applicable due to conditions like minimum order value, restrictions on combining with other discounts, or other advanced conditions, an error message will appear explaining why the coupon cannot be applied to the cart.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball Dashboard, go to **Widget > Content**. Under the **Onsite** tab, edit the text and customize it for supported languages.
***
## Important Notes
This extension will automatically hide from your store if:
* The Gameball program is deactivated.
* There are no coupons available.
* The customer is excluded from the loyalty program.
* Your account is on a plan that doesn't support this feature.
***
## Frequently Asked Questions
The dropdown will automatically hide if your plan no longer supports the feature.
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Display customers' points balances in their profiles.
Show potential points directly on product pages.
# How Do I Display Earned Points at Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/checkout-components/display-earned-points-at-checkout
Encourage your customers to complete their orders by showing the points they'll earn with each purchase—directly at checkout.
| **Platform** | **Plan** |
| ------------ | ---------- |
| Shopify | Pro & Guru |
Checkout app blocks are available for **Shopify Plus** customers only.
Displaying the potential points customers can earn from their order on the checkout page helps them understand the immediate rewards they'll receive. By showing how many points they will earn with their purchase, this feature encourages customers to make the most of their loyalty program benefits right at the point of transaction.
**Benefits:**
Showing potential points encourages customers to add more items to their cart to maximize their rewards, leading to higher average order value.
By highlighting the rewards they'll earn, customers are more likely to engage with the loyalty program and make repeat purchases to accumulate more points.
***
## Prerequisites
This feature is exclusively available to merchants on the **Shopify Plus** plan.
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, navigate to **Programs > Earn Points**, then activate the module.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's Theme Editor.
Under **Order Summary** in the left sidebar, select **Add App Block > Apps**, and search for the **"Checkout potential points"** block.
Select the **"Checkout potential points"** app block and click **Save**.
***
## How It Works
If not logged in, the extension will show the earned points in addition to asking you to log in to collect the points.
When the logged-in customer reaches the checkout page after placing an order, the extension will be displayed, showing the number of points earned from the last order, in addition to a call-to-action that opens the widget on the redemption option to let the user redeem their points.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball Dashboard, go to **Widget > Content**. Under the **Onsite** tab, edit the text and customize it for supported languages.
***
## Important Notes
The block will automatically hide if:
* The Gameball program is deactivated.
* The "Earn Points" program is deactivated.
* The earned points are 0.
* The customer is excluded from the loyalty program.
* Your account is on a plan that doesn't support this feature.
***
## Frequently Asked Questions
The block will automatically hide if your plan no longer supports the feature.
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Show potential points earned on current products in the cart.
Show potential points directly on product pages.
# How Do I Display Points Redemption Input Field at Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/checkout-components/display-points-redemption-at-checkout
Empower your customers to redeem points directly at checkout, offering them control over how they apply their rewards.
| **Platform** | **Plan** |
| ------------ | ---------- |
| Shopify | Pro & Guru |
Checkout app blocks are available for **Shopify Plus** customers only.
Offering customers the ability to redeem loyalty points at checkout is a powerful way to enhance their shopping experience and strengthen their connection with your brand. With Gameball's new feature, users can now view their points balance directly during checkout and easily redeem them for discounts by entering the number of points they want to use.
**Benefits:**
Providing a direct input field for point redemption at checkout makes it easier for users to apply their rewards, reducing friction.
Displaying the redeem option at checkout encourages customers to use their points, leading to higher reward usage and satisfaction.
***
## Prerequisites
This feature is exclusively available to merchants on the **Shopify Plus** plan.
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
Ensure that the "Flexible Redemption Option" is activated and configured with the right values.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's Theme Editor.
Under **Order Summary** in the left sidebar, select **Add section > Apps**, and search for **"Checkout redeem input field"**.
Select the app block and click **Save**.
***
## How It Works
If not logged in, customers will see a login prompt to access their balance. Once identified (email entered), the block updates to the logged-in version.
The block displays the total available points as a default in the input field. Customers can enter the desired amount to redeem.
After adding the points, the customer clicks on **"Redeem"**, and Gameball will deduct points from the customer's balance and automatically generate a discount code, which is then applied to the order.
If the coupon is not applicable due to conditions like minimum order value, restrictions on combining with other discounts, or other advanced conditions, an error message will appear explaining why the coupon cannot be applied to the cart.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball Dashboard, go to **Widget > Content**. Under the **Onsite** tab, edit the text and customize it for supported languages.
***
## Important Notes
The block will automatically hide if:
* The program is deactivated.
* The "flexible redemption option" is deactivated.
* The customer is excluded from the rewards program.
* Your account is on an unsupported plan.
***
## Frequently Asked Questions
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
The block will automatically hide once you're on a plan that doesn't support it.
If the customer redeems points but does not use the generated coupon immediately, they can access the coupon later through the widget. The coupon will remain available for future use, but it cannot be reverted to points.
***
## Related Articles
Show potential points earned on current products in the cart.
Show potential points directly on product pages.
# How Do I Display Redemption Options at Checkout (Drop-menu)?
Source: https://docs.gameball.co/product-documentation/onsite-components/checkout-components/display-redemption-options-at-checkout
Enhance your customers' checkout experience by offering a way to redeem loyalty rewards with Gameball's Redemption Options Dropdown.
| **Platform** | **Plan** |
| ------------ | ---------- |
| Shopify | Pro & Guru |
Checkout app blocks are available for **Shopify Plus** customers only.
Elevate your customers' checkout experience with Gameball's Redemption Options Dropdown. This feature simplifies the process of redeeming loyalty rewards, enabling customers to explore available options, choose their preferred reward, and apply it seamlessly to their purchase.
**Benefits:**
Offering multiple redemption options at checkout motivates customers to redeem their points, increasing overall utilization.
Giving customers the flexibility to choose rewards that fit their preferences enhances their satisfaction and loyalty.
***
## Prerequisites
This feature is exclusively available to merchants on the **Shopify Plus** plan.
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
Ensure that at least one redemption option is available, including flat rate rewards if required.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's Theme Editor.
In the editor, navigate to **Add App Block > Apps** and search for **"Checkout redeem dropdown menu"**.
Add the **Checkout redeem dropdown menu** app block to the checkout page and click **Save**.
***
## How It Works
For customers who are not logged in, the extension will prompt them to sign in to access their points balance and redeem rewards. Without logging in, you won't be able to view or use your points at checkout.
When a logged-in customer reaches the checkout page, the extension will automatically display, allowing them to view their points balance and choose a reward in exchange for points.
After selecting a reward and entering the desired number of points, the customer clicks **'Redeem'**. Gameball will then deduct the points from the customer's balance and automatically generate a discount code, which will be applied to the order.
If the discount code cannot be applied due to specific conditions (e.g., minimum order value not met, restrictions on combining discounts, or other advanced rules), an error message will appear, explaining why the coupon cannot be used with the current cart.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball Dashboard, go to **Widget > Content**. Under the **Onsite** tab, edit the text and customize it for supported languages.
***
## Important Notes
The Redemption Options Dropdown will automatically hide if:
* The rewards program is deactivated.
* The customer is excluded from the program.
* The account is not on a supported plan.
* No redemption rules are configured.
***
## Frequently Asked Questions
If the customer redeems points but does not use the generated coupon immediately, they can access the coupon later through the widget. The coupon will remain available for future use, but it cannot be reverted to points.
The dropdown will automatically hide if your plan no longer supports the feature.
***
## Related Articles
Display customers' points balances in their profiles.
Show potential points directly on product pages.
# How Do I Display Customer's Earn Points After Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/general-components/display-earn-points-after-checkout
Displaying the number of earned points on the Thank You page to keep customers engaged and informed about their loyalty rewards.
| **Platform** | **Plan** |
| ------------ | ------------------- |
| Shopify | Starter, Pro & Guru |
Displaying the number of earned points on the Thank You page is an important way to keep customers engaged and informed about their loyalty rewards. In addition to showing the points, this block includes a call-to-action (CTA) labeled **"Check Ways to Redeem."** This CTA opens up all available redemption options, making it easy for customers to explore how they can use their points and encouraging them to return for future purchases.
**Benefits:**
By showcasing earned points and offering clear redemption options, customers are reminded of the value of the loyalty program, strengthening their connection with the brand.
Seeing how many points they've earned motivates customers to come back and redeem their rewards, which drives repeat purchases and enhances customer retention.
***
## Prerequisites
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, navigate to **Programs > Earn Points**, then activate the module.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to the Shopify theme editor on the thank you page. If this doesn't happen, please review the prerequisites.
In the left sidebar, under the "Order Summary," click **Add App Block > Apps**, and search for the **"Checkout earned points"** block.
Select the **"Checkout earned points"** app block and click **Save**.
***
## Logged-In vs. Guest (Not-Logged-In) Customers
If you are not logged in, the extension will show the earned points in addition to asking you to log in or register to be able to use your points.
When the logged-in customer reaches the thank you page after placing an order, the extension will be displayed, showing the number of points earned from the last order, in addition to a call-to-action that opens the widget on the redemption option to let the user redeem their points.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball Dashboard, go to **Widget > Content**. Under the **Onsite** tab, edit the text and customize it for supported languages.
***
## Important Notes
This extension will automatically hide from your store if:
* The Gameball program is deactivated.
* The loyalty points earning module is deactivated.
* The earned points are 0 points.
* The customer is excluded from the loyalty program.
* Your account is on a plan that doesn't support this feature.
***
## Frequently Asked Questions
The block will automatically hide once you're on a plan that doesn't support it.
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Display customers' points balances in their profiles.
Show potential points directly on product pages.
# How Do I Display Potential Points Earned in the Cart?
Source: https://docs.gameball.co/product-documentation/onsite-components/general-components/display-potential-points-in-cart
Encourage your customers to complete their orders by showing the points they'll earn with each purchase—directly in their cart.
| **Platform** | **Plan** |
| ------------ | -------------------- |
| Shopify | Starter, Pro, & Guru |
With Gameball's potential points display, customers can instantly see the rewards they'll earn for their cart items before completing their purchase. This engaging feature highlights the value of each purchase, motivating customers to check out and start earning points.
**Benefits:**
Customers are more likely to add additional items to their cart when they see the direct rewards tied to each product, leading to increased spending.
Motivate customers to complete the purchase by showing the reward they will get by completing their purchase.
***
## Prerequisites
Your theme must support app blocks. Without this, the Gameball block will not be visible in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, navigate to **Programs > Earn Points**, then activate the module.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's theme editor. If not, double-check the prerequisites.
Sign in to your store through the theme editor to access the customer account template.
In the left sidebar under **Template**, select **Add section > Apps**, and search for **"Cart Points"**.
Select the **"Cart Points"** app block and click **Save**.
***
## Customization
1. In the Shopify theme editor, click on the **"Cart Points"** app block.
2. On the right sidebar, adjust the icon, text, colors, and styles as needed.
3. On the left sidebar, you can also change the block's position within the template section.
4. Click **Save**.
1. In the Gameball dashboard, go to **Widget > Content**.
2. In the **Onsite** tab, edit the displayed text as needed and click **Save**.
***
## Logged-In vs. Guest (Not-Logged-In) Customers
If the customer isn't logged in, the block will show the potential points they can earn based on default "earn points" rules, ignoring any custom order reward per tier.
For logged-in customers, the block displays points based on any customized reward rules per collection, merchant, or level, giving a tailored view of rewards.
***
## Important Notes
The potential points block will automatically hide if:
* The "Earn Points" module is deactivated.
* The customer is excluded from the rewards program.
* The Gameball program is deactivated.
* The product offers 0 points.
* The product is excluded from the "Earn Points" rules.
* Your account is on a plan that doesn't support this feature.
***
## Frequently Asked Questions
Currently, this block can only be embedded on the cart page.
The points-in-cart block will automatically hide if your plan no longer supports this feature.
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
***
## Related Articles
Display customers' points balances in their profiles.
Show potential points directly on product pages.
# How Do I Display Potential Points on Product Pages?
Source: https://docs.gameball.co/product-documentation/onsite-components/general-components/display-potential-points-on-product-pages
Show potential loyalty points customers can earn directly on your product pages to drive engagement and higher conversion rates.
| **Platform** | **Plan** |
| ------------ | -------------------- |
| Shopify | Starter, Pro, & Guru |
The product page plays a crucial role in the customer journey. By integrating loyalty features directly into your product pages, you increase touchpoints for engagement, which can lead to higher sales.
Gameball allows users to display potential points that can be earned directly on the product page. This feature gives customers clear visibility into the rewards they'll earn for each purchase, encouraging engagement and driving higher conversion rates by showcasing the benefits of their loyalty program upfront.
**Benefits:**
Highlighting potential points motivates customers to add items to their cart, increasing purchase likelihood.
Customers are more likely to add additional items to their cart when they see the direct rewards tied to each product, leading to increased spending.
***
## Prerequisites
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, navigate to **Programs > Earn Points**, then activate the module.
In the Gameball dashboard, ensure the top-right toggle is active. Once enabled, you will be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to the Shopify theme editor on the product page. If this doesn't happen, please review the prerequisites.
In the left sidebar, under the "Template" section, find **Product Information**. Click **Add Block > Apps**, and search for **"Product Points"**.
Select the **"Product Points"** app block and click **Save**.
***
## Customization
1. In the Shopify theme editor, click on the **"Product Points"** app block.
2. On the right sidebar, adjust the icon, text, colors, and styles as needed.
3. On the left sidebar, you can also change the block's position within the template section.
4. Click **Save**.
1. To customize the content and translation, go to the Gameball Dashboard.
2. Navigate to **Widget > Content**.
3. In the **Onsite** tab, edit the text as needed.
4. Click **Save**.
***
## Important Notes
This extension will automatically hide from your store if:
* The Gameball program is deactivated.
* The "Earn Points" module is deactivated.
* The customer is excluded from the loyalty program.
* The product offers 0 loyalty points.
* The product is excluded from the "Earn Points" rules.
* Your account is on a plan that doesn't support this feature.
***
## Common Questions
Please review the prerequisites and ensure all conditions are met. If you still encounter an issue, contact us at [support@gameball.co](mailto:support@gameball.co).
The block will automatically hide once you're on a plan that doesn't support it.
# How Do I Display Customer Referral Link After Checkout?
Source: https://docs.gameball.co/product-documentation/onsite-components/general-components/display-referral-link-after-checkout
Enable your customers to easily share their referral link directly after placing an order on your store.
| **Platform** | **Plan** |
| ------------ | ------------------- |
| Shopify | Starter, Pro & Guru |
After a customer places an order, it's the perfect time to engage with them while their excitement is at its peak. By introducing your referral program at this moment, you can turn a positive purchase experience into an opportunity for organic growth.
Gameball now offers a referral block that appears once an order is completed, highlighting the reward customers can earn by referring friends and providing their unique referral link.
**Benefits:**
Displaying the referral prompt right after an order is completed taps into the customer's post-purchase enthusiasm, increasing the likelihood of referrals.
Leveraging recent buyers' excitement can lead to more personal recommendations, attracting high-quality new customers through word-of-mouth.
***
## Prerequisites
Your Shopify theme must support app blocks. Without this, the option to add the Gameball block won't appear in the editor. [Learn more](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, navigate to **Referrals**, then activate the module.
In the Gameball dashboard, ensure the top-right toggle is active. Once enabled, you will be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's theme editor. If not, double-check the prerequisites.
In the left sidebar under **Apps**, select **"Checkout refer a friend"** and click **Save**.
***
## Customization
The checkout extensions have no style customization options. However, you can customize its position by simply dragging and dropping it to your desired location on the checkout page.
In the Gameball dashboard, go to **Widget > Content**. In the **Onsite** tab, edit the displayed text as needed and click **Save**.
***
## Logged-In vs. Guest (Not-Logged-In) Customers
If you are not logged in, the extension will prompt you to log in or register to be able to refer your friends and earn the referral reward.
When the logged-in customer reaches the thank you page after placing an order, the extension will be displayed, allowing the customer to copy their referral link and share it with their friends.
***
## Important Notes
The referral link block will automatically hide if:
* The referral program is deactivated.
* The customer is excluded from the program.
* The Gameball program is deactivated.
* Your account plan doesn't support this feature.
***
## Frequently Asked Questions
Currently, the referral link block can only be embedded on the checkout confirmation page.
The referral link block will automatically hide if your plan no longer supports this feature.
***
## Related Articles
Display customers' points balances in their profiles.
Show potential points directly on product pages.
# How Do I Embed Customers' Points in their Profile?
Source: https://docs.gameball.co/product-documentation/onsite-components/general-components/embed-points-in-customer-profile
Display your customers' points balances in their profiles using our no-code embed feature, enhancing engagement and reward redemptions.
| **Platform** | **Plan** |
| ------------ | -------------------- |
| Shopify | Starter, Pro, & Guru |
Boost your customer loyalty program and increase reward redemptions by seamlessly displaying points balances within your customers' accounts. With Gameball, you can integrate point balances directly into your store's theme without writing a single line of code, keeping your customers informed and motivated to redeem their rewards.
***
## Prerequisites
Ensure you're using Shopify's Classic customer accounts. The new customer accounts don't support third-party apps yet. However, when you are adding the "Account Balance" embedded block, it is only supported by the old account creation method (classic account). This is due to a limitation from Shopify, as they don't allow third-party apps like Gameball to edit the page with the new method.
Your theme must support app blocks. Without this, the Gameball block will not be visible in the editor. [Learn More](https://help.shopify.com/en/manual/online-store/themes/theme-structure/extend/apps).
Go to the **Theme Editor** in your Shopify admin. Select **App Embeds** from the left menu, search for "Gameball," and toggle it on.
In the Gameball dashboard, make sure the toggle at the top-right is activated. Once this is enabled, you'll be able to add the Gameball block.
***
## How to Install the Block
In Gameball, navigate to **Onsite**, click **Customize**.
You'll be redirected to Shopify's theme editor. If not, double-check the prerequisites.
Sign in to your store through the theme editor to access the customer account template.
In the left sidebar under **Template**, select **Add section > Apps**, and search for **"Points Balance"**.
Select the **Points Balance** app block and click **Save**.
***
## Customization
1. In the Shopify theme editor, click on the **Points Balance app block**.
2. Customize the icon, text, colors, buttons, and overall style using the right-hand sidebar.
3. Adjust the block's position in the template from the left sidebar.
4. Click **Save**.
1. In the Gameball dashboard, go to **Widget > Content**.
2. In the **Onsite** tab, edit the displayed text as needed and click **Save**.
***
## Important Notes
The block will automatically hide from your store if:
* The Gameball program is deactivated.
* The customer is excluded from the program.
* Your account is on a plan that doesn't support this feature.
***
## Common Questions
Currently, the block can only be embedded on the customer account page.
Gameball supports the "New customer account creation" in the following way: When a user logs in using Email/OTP and Gameball identifies their Shopify account, they are created as a member in Gameball (instead of a guest). This change resolves issues such as users not receiving rewards from birthdays, social campaigns, streaks, and similar benefits.
However, if you are adding the "Account Balance" embedded block, it is only supported by the old account creation method. This is due to a limitation from Shopify, as they don't allow third-party apps like Gameball to edit the page with the new method.
If you encounter a "There is a problem loading the page" message, review the prerequisites to ensure all conditions are met. If the issue persists, contact us at [support@gameball.co](mailto:support@gameball.co).
The Points Balance block will automatically hide if your plan doesn't support this feature.
# How Do I Get Started with the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/getting-started
Install Gameball Android SDK v3.2.1 and set up your project
# Installation & Setup
This guide helps you set up your project and install the **Gameball Android SDK v3.2.1**.\
After completing these steps, proceed to **Initialize the SDK** to start using Gameball in your app.
***
## Requirements
Your project must meet the following minimum requirements:
* **Minimum SDK Version:** 21 (Android 5.0)
* **Target SDK Version:** 34
* **Kotlin:** 2.0.0+
* **AndroidX:** Required
* **Internet permission** in your `AndroidManifest.xml`:
```xml theme={null}
```
***
## Install the SDK
### 1. Add Repositories
Add the required repositories to your **project-level** `settings.gradle` (or `build.gradle` for older projects):
```groovy theme={null}
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven { url "https://jitpack.io" }
maven { url 'https://developer.huawei.com/repo/' }
}
}
```
If your project uses an older Gradle configuration, add these repositories under: `allprojects { repositories { ... } }`.
***
### 2. Add the Gameball Dependency
In your **app-level** `build.gradle`:
```groovy theme={null}
dependencies {
implementation 'com.github.gameballers:gb-mobile-android:3.2.1'
}
```
***
### 3. (Optional) Maven Installation
If you are using Maven:
```xml theme={null}
com.github.gameballersgb-mobile-android3.2.1
```
***
## ProGuard / R8 Configuration
If you are using ProGuard or R8, add the following rules to your [proguard-rules.pro](http://proguard-rules.pro):
```proguard theme={null}
# Gameball SDK
-keep class com.gameball.gameball.** { *; }
-keep class com.gameball.gameball.model.** { *; }
# Gson
-keepattributes Signature
-keepattributes *Annotation*
-keep class com.google.gson.** { *; }
```
The SDK automatically enables debug logging in debug builds. Network requests and responses are logged when `BuildConfig.DEBUG` is `true`.
***
## Troubleshooting Setup
**Symptoms:** Gradle cannot resolve `com.github.gameballers:gb-mobile-android:3.2.1`. **Solutions:**
* Ensure `jitpack.io` and Huawei repos are added under `repositories`.
* Sync Gradle again from Android Studio.
* Check for typos in the dependency coordinates.
**Symptoms:** Calls fail or time out after integrating the SDK. **Solutions:**
* Verify `INTERNET` permission is present in `AndroidManifest.xml`.
* Check network connectivity on the test device/emulator.
* Confirm your API key is correct in the Gameball dashboard (once you initialize the SDK).
***
## Debug Logging
The SDK logs useful information when BuildConfig.DEBUG is true.
### Logcat Tags
| **Tag** | **Description** |
| :------------------- | :----------------------------------- |
| `GameballApp` | General SDK operations and lifecycle |
| `LoggingInterceptor` | Network requests and responses |
| `HeaderInterceptor` | Request headers and authentication |
#### Example:
```bash theme={null}
adb logcat -s GameballApp LoggingInterceptor HeaderInterceptor
```
No extra configuration is required, debug logs are automatically enabled in debug builds.
## Next Steps
* [Initialize SDK](/installation-guides/v3/android/initialize-sdk)
* [Initialize Customer Profile](/installation-guides/v3/android/initialize-profile)
# How Do I Complete the Go-Live Checklist for the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/go-live-checklist
Verify your integration before going live
Use this checklist to ensure your Gameball Android SDK v3.2.1 integration is complete and ready for production.
During development, use your account **Test Key** to authenticate requests. Once integration is completed and validated, swap to your **Production API Key**.
## Step 1: Install SDK and Verify Dependencies
* [ ] Gameball SDK v3.2.1 is installed via Gradle/Maven
* [ ] All dependencies are resolved without conflicts
* [ ] SDK imports correctly in your activities
* [ ] No compilation errors or warnings
* [ ] `GameballApp.getInstance(...).init(...)` succeeds
For information, please read more at [Getting Started](/installation-guides/v3/android/getting-started)
## Step 2: Initialize and Register Customers
* [ ] SDK initializes successfully with your API key in Application class
* [ ] Test customer registration with `initializeCustomer` returns success
* [ ] Customer data appears correctly in Gameball dashboard
* [ ] Error handling works for invalid registrations
For information, please read more at [Initialize Customer Profile](/installation-guides/v3/android/initialize-profile)
## Step 3: Track Events
* [ ] Test events are sent successfully using `sendEvent`
* [ ] Events appear in Gameball dashboard with correct metadata
* [ ] Event-based rewards trigger properly
* [ ] Error handling works for failed API calls
For information, please read more at [Track Customer Events](/installation-guides/v3/android/track-events)
## Step 4: Push Notifications
* [ ] Firebase or Huawei SDK is integrated
* [ ] Device tokens are generated and registered successfully
* [ ] Push notifications credentials configured in Gameball dashboard
* [ ] Test notifications are received on devices
* [ ] Notification content displays correctly
* [ ] Token refresh handling works properly
For more information, please read more at [Push Notifications](/installation-guides/v3/android/push-notifications)
## Step 5: Production Readiness
* [ ] Swap Test API Key to Production API Key
* [ ] ProGuard/R8 rules added to `proguard-rules.pro`:
```proguard theme={null}
-keep class com.gameball.gameball.** { *; }
-keep class com.gameball.gameball.model.** { *; }
-keepattributes Signature
-keepattributes *Annotation*
-keep class com.google.gson.** { *; }
```
* [ ] App works correctly with code obfuscation enabled
* [ ] Test on multiple Android devices and versions (API 21+)
* [ ] Memory usage is within acceptable limits
* [ ] No memory leaks in long-running sessions
* [ ] Crash reporting is configured and working
## Step 9: Monitoring and Support
* [ ] Monitor API response times after launch
* [ ] Check crash reports for any SDK-related issues
* [ ] Verify customer transactions in Gameball dashboard
* [ ] Support team is ready to handle inquiries
* [ ] Documentation is accessible to team
Once you've completed all items in this checklist, your Android Gameball SDK v3.2.1 integration is ready for production!
## Troubleshooting Resources
* [API Reference](/api-reference/introduction)
* [Status and Error Codes](/api-reference/overview/status-error-codes)
* [Migration Notes](/installation-guides/v3/android/migration-notes)
* [GitHub Repository](https://github.com/gameballers/gb-mobile-android)
# Android SDK Integration (v3)
Source: https://docs.gameball.co/installation-guides/v3/android/index
Install Gameball Android SDK v3.2.1 and set up your project
This guide helps you set up your project and install the **Gameball Android SDK v3.2.1**.\
After completing these steps, proceed to **Initialize the SDK** to start using Gameball in your app.
***
## Requirements
Your project must meet the following minimum requirements:
* **Minimum SDK Version:** 21 (Android 5.0)
* **Target SDK Version:** 34
* **Kotlin:** 2.0.0+
* **AndroidX:** Required
* **Internet permission** in your `AndroidManifest.xml`:
```xml theme={null}
```
***
## Install the SDK
### 1. Add Repositories
Add the required repositories to your **project-level** settings.gradle (or build.gradle for older projects):
# How Do I Initialize the Customer Profile in the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/initialize-profile
Register and identify customers in your Android app
Use `initializeCustomer` whenever a user **logs in**, **registers**, or you need to **refresh their profile**. This lets Gameball attach events, rewards, and notifications to the correct customer.
Before calling `initializeCustomer,` make sure you have already initialized the SDK using [Initialize SDK](/installation-guides/v3/android/initialize-sdk).
***
## Basic Customer Initialization
🔒
Secure API Access: To benefit from v4.1 secure API endpoints, pass the sessionToken parameter when calling methods (required in upcoming SDK v4). This enables automatic routing to v4.1 secure endpoints. Learn more about v4.1 →
```kotlin Kotlin theme={null}
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.email("customer@example.com")
.mobileNumber("+1234567890")
.deviceToken("fcm-device-token")
.pushProvider(PushProvider.Firebase)
.build()
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
object : Callback {
override fun onSuccess(response: InitializeCustomerResponse) {
// Customer initialized successfully
}
override fun onError(error: Throwable) {
// Handle error
}
}
)
// With session token override
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
callback,
sessionToken = "customer-token"
)
```
```java Java theme={null}
InitializeCustomerRequest customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.email("customer@example.com")
.mobile("+1234567890")
.deviceToken("fcm-device-token")
.pushProvider(PushProvider.Firebase)
.build();
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
new Callback() {
@Override
public void onSuccess(InitializeCustomerResponse response) {
// Customer initialized successfully
}
@Override
public void onError(Throwable error) {
// Handle error
}
}
);
```
Call `initializeCustomer` immediately after a successful login or registration flow so the customer profile stays up to date.
***
## Request Parameters
Unique identifier for the customer. This must not change for a given customer.
Customer's email address.
Customer's mobile number with country code.
Push notification token (for example, FCM/Huawei token). Required if `pushProvider` is set.
Push notification provider: `PushProvider.Firebase` or `PushProvider.Huawei`. Required if `deviceToken` is set.
Additional customer attributes such as name, date of birth, custom fields, etc.
Referral code if the customer was referred by another customer.
Guest user flag (defaults to `false`).
Operating system type. Automatically set to `"Android"`.
Optional session token to override the global token for this specific request. Required in upcoming SDK v4.
### Validation Rules
**InitializeCustomerRequest requires:**
* customerId cannot be empty
* If pushProvider is set, deviceToken is required
* If deviceToken is set, pushProvider is required
**Choose an Unchangeable Customer ID:** `customerId` should be a permanent identifier that never changes.
***
## Enriching Profiles with Customer Attributes
Use the CustomerAttributes builder to send richer profile data to Gameball.
```kotlin Kotlin theme={null}
val attributes = CustomerAttributes.builder()
.displayName("John Doe")
.firstName("John")
.lastName("Doe")
.email("john@example.com")
.mobileNumber("+1234567890")
.gender("male")
.dateOfBirth("1990-01-15")
.joinDate("2024-01-01")
.preferredLanguage("en")
.channel("mobile")
.addCustomAttribute("favoriteCategory", "electronics")
.addAdditionalAttribute("segment", "premium")
.addAdditionalAttribute("city", "New York")
.addAdditionalAttribute("country", "USA")
.build()
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.email("john@example.com")
.mobile("+1234567890")
.customerAttributes(attributes)
.referralCode("REF123")
.isGuest(false)
.build()
```
```java Java theme={null}
CustomerAttributes attributes = CustomerAttributes.builder()
.displayName("John Doe")
.firstName("John")
.lastName("Doe")
.email("john@example.com")
.mobileNumber("+1234567890")
.gender("male")
.dateOfBirth("1990-01-15")
.joinDate("2024-01-01")
.preferredLanguage("en")
.channel("mobile")
.addCustomAttribute("favoriteCategory", "electronics")
.addAdditionalAttribute("segment", "premium")
.addAdditionalAttribute("city", "New York")
.addAdditionalAttribute("country", "USA")
.build();
InitializeCustomerRequest customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.email("john@example.com")
.mobile("+1234567890")
.customerAttributes(attributes)
.referralCode("REF123")
.isGuest(false)
.build();
```
***
## CustomerAttributes Builder
Sets the customer's display name.
Sets the customer's first name.
Sets the customer's last name.
Sets the customer's email address.
Sets the customer's mobile number.
Sets the customer's gender.
Sets the date of birth in
YYYY-MM-DD
format.
Sets the join date in
YYYY-MM-DD
format.
Sets the preferred language code.
Sets the channel identifier (defaults to
"mobile"
).
Adds a single custom attribute key-value pair.
Sets all custom attributes at once.
Adds a single additional attribute key-value pair.
Sets all additional attributes at once.
***
## Recommended Usage Flow
Wait until the user has successfully logged in or registered in your app.
Build `CustomerAttributes` with all available information (name, contact, custom attributes).
Call `initializeCustomer` with a stable `customerId` and attributes.
After initialization succeeds, start tracking events, showing the profile widget, and enabling rewards.
# How Do I Initialize the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/initialize-sdk
Configure and initialize Gameball Android SDK v3.2.1
Before you can register customers, track events, or show the profile widget, you must initialize the **Gameball Android SDK** with your configuration.
Initialization is typically done once in your `Application` class.
***
## Application-Level Initialization
Create (or update) your `Application` class and initialize Gameball in `onCreate`.
🔒
Secure API Access: To benefit from v4.1 secure API endpoints, pass the sessionToken parameter during SDK initialization (required in upcoming SDK v4). This enables automatic routing to v4.1 secure endpoints. Learn more about v4.1 →
```kotlin Kotlin theme={null}
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
val config = GameballConfig.builder()
.apiKey("your-api-key") // Required
.lang("en") // Required
.platform("android") // Optional
.shop("your-shop-id") // Optional
.sessionToken("your-session-token")// Optional - enables v4.1 endpoints
.build()
GameballApp.getInstance(this).init(config)
}
}
```
```java Java theme={null}
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
GameballConfig config = GameballConfig.builder()
.apiKey("your-api-key") // Required
.lang("en") // Required
.platform("android") // Optional
.shop("your-shop-id") // Optional
.sessionToken("your-session-token") // Optional - enables v4.1 endpoints
.build();
GameballApp.getInstance(this).init(config);
}
}
```
Make sure your `Application` class is registered in your `AndroidManifest.xml`:
\
***
## Configuration Parameters
Your Gameball API key from the dashboard. Required.
Language code for SDK localization (for example, "en", "ar", "fr"). Required.
Platform identifier. Defaults to `"android"`.
Your Gameball shop identifier for multi-shop setups.
Optional Session Token used for secure authentication and automatic v4.1 endpoint routing. Required in upcoming SDK v4.
### Validation Rules
**GameballConfig requires:**
* apiKey cannot be null
* lang cannot be null
If either is missing, initialization will fail and API calls will not succeed.
***
## Environment Configuration (Test vs Production)
You can switch between Test and Production keys based on your build type:
```kotlin theme={null}
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
val apiKey = if (BuildConfig.DEBUG) {
"gb_test_your-key" // Test key
} else {
"gb_live_your-key" // Production key
}
val config = GameballConfig.builder()
.apiKey(apiKey)
.lang("en")
.build()
GameballApp.getInstance(this).init(config)
}
}
```
Always use your **Test Key** in development and staging builds, and your **Production Key** only in live builds.
***
## Common Initialization Issues
**Error:** `API key is required for customer initialization` **Cause:** `GameballApp.getInstance(context).init(config)` was not called before other SDK methods.
**Solution:** Ensure initialization happens in your `Application.onCreate()` and that the Application class is correctly registered in `AndroidManifest.xml`.
**Symptoms:** Requests failing with authentication or 4xx errors. **Solution:** Verify the API key used in `GameballConfig` matches the key shown in your Gameball dashboard (and that you are using the correct environment key: Test vs Production).
***
## Next Steps
Once the SDK is initialized, you can proceed with:
* [Initialize Customer Profile](/installation-guides/v3/android/initialize-profile)
# How Do I Migrate to the Android SDK v3?
Source: https://docs.gameball.co/installation-guides/v3/android/migration-notes
Migrate from v2 to v3.2.1
This guide helps you migrate from Gameball Android SDK v2 to v3.2.1.
## What's New in v3.2.1
**Widget Events, Dismissal & External Links** — v3.2.x keeps all v3.x code compatible. Every new capability is opt-in, so an existing integration keeps working after a version bump.
### New in v3.2.1
* **Widget Header No Longer Under the Status Bar**: widget content is padded by the status-bar and display-cutout height, so the header and close buttons stay tappable (previously seen on Pixel and Android 15)
* **Status-Bar Icon Contrast**: the widget uses a dedicated theme with dark status-bar icons, keeping them visible over the widget's white top band
### New in v3.2.0
* **Widget Event Channel**: `widgetEventCallback` on `ShowProfileRequest` receives events posted from the widget, such as `gameCompleted`
* **Host-Initiated Dismiss**: `GameballApp.hideProfile()` dismisses the widget programmatically
* **Web-Initiated Close**: the widget can dismiss itself via `window.GameballWidget.closeWidget()`
* **External-Link Handling**: links tagged `gbExternalBrowser=true` open in the system browser, or in your own handler via `externalLinkCallback`
* **Channel Merging**: `ShowProfileRequest.builder()` accepts optional `mobile` and `email`
* **Diagnostic Logging**: the SDK records internal diagnostic logs to aid troubleshooting. No integration changes required
**Breaking change in v3.2.0:** `ShowProfileRequest.capturedLinkCallback` was renamed to `externalLinkCallback`, and it now fires only for links the widget tags with `gbExternalBrowser=true`. If you used `capturedLinkCallback`, rename it:
```kotlin theme={null}
// Before (v3.1.x)
.capturedLinkCallback(object : Callback { /* … */ })
// After (v3.2.0+)
.externalLinkCallback(object : Callback { /* … */ })
```
### New in v3.1.x
* **Widget URL Fix (3.1.2)**: eliminated a null `customerId` value from the widget URL
* **Guest Mode Support**: Show profile widget without customer authentication
* **Non-Throwing ShowProfileRequest**: Customer ID optional for guest mode
* **Session Token Support**: Optional token-based authentication (from 3.1.0)
* **Automatic Endpoint Versioning**: Routes to v4.1 API when token is present
* **Per-Request Token Override**: Override global token on individual API calls
* **Backward Compatible**: All v3.0.0 code works unchanged
Streamlined API with better Kotlin support and cleaner method names
Optimized SDK initialization and reduced memory footprint
Stronger typing and better compile-time checks
Easier configuration with builder pattern throughout
## Breaking Changes
### 1. SDK Initialization
**v2:**
```kotlin theme={null}
GameballApp.getInstance(context).init(
"api-key",
"en",
"android",
"shop-id"
)
```
**v3.2.1:**
```kotlin theme={null}
val config = GameballConfig.builder()
.apiKey("api-key")
.lang("en")
.platform("android")
.shop("shop-id")
.sessionToken("session-token") // Optional
.build()
GameballApp.getInstance(context).init(config)
```
### 2. Customer Registration
**v2:**
```kotlin theme={null}
gameballApp.registerCustomer(
customerId,
customerAttributes,
referralCode,
isGuest,
callback
)
```
**v3.2.1:**
```kotlin theme={null}
val customerRequest = InitializeCustomerRequest.builder()
.customerId(customerId)
.customerAttributes(customerAttributes)
.referralCode(referralCode)
.build()
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
callback
)
// Optional: Override session token for this request
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
callback,
sessionToken = "customer-token"
)
```
### 3. Event Tracking
**v2:**
```kotlin theme={null}
val event = Event.Builder()
.withCustomerId("customer-123")
.withEventName("purchase")
.withEventMetaData("total", 120)
.build()
```
**v3.2.1:**
```kotlin theme={null}
val event = Event.builder()
.customerId("customer-123")
.eventName("purchase")
.build()
GameballApp.getInstance(context).sendEvent(event, callback)
// Optional: Override session token for this request
GameballApp.getInstance(context).sendEvent(
event,
callback,
sessionToken = "customer-token"
)
```
### 4. Method Name Changes
| v2 | v3.2.1 |
| -------------------------- | ---------------------------- |
| `registerCustomer()` | `initializeCustomer()` |
| `Event.Builder()` | `Event.builder()` |
| `withCustomerId()` | `customerId()` |
| `withEventName()` | `eventName()` |
| `withEventMetaData()` | `eventMetaData()` |
| `CustomerRegisterResponse` | `InitializeCustomerResponse` |
| `capturedLinkCallback` | `externalLinkCallback` |
`CustomerAttributes` is unchanged from v2 — no rename needed.
`capturedLinkCallback` survived v2 and v3.0–v3.1 unchanged and was renamed only in v3.2.0. If you are coming from v3.1.x rather than v2, this is the single rename you need — see the warning at the top of this page.
### 5. Push Notifications
**v2:**
```kotlin theme={null}
gameballApp.initializeFirebase()
```
**v3.2.1:**
```kotlin theme={null}
// Token is provided during customer initialization
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.deviceToken(fcmToken)
.pushProvider(PushProvider.Firebase)
.build()
```
## Migration Steps
### From v3.1.x to v3.2.1
v3.2.x is backward compatible with v3.1.x, with one exception: if you used `capturedLinkCallback`, rename it to `externalLinkCallback` (see the warning above). Every other v3.2.x capability is opt-in, so an existing integration keeps working after a version bump.
Update your `build.gradle` to use SDK v3.2.1:
```groovy theme={null}
dependencies {
implementation 'com.github.gameballers:gb-mobile-android:3.2.1'
}
```
If you passed `capturedLinkCallback` to `ShowProfileRequest`, rename it to `externalLinkCallback`. This is the only required code change.
Handle widget events, dismiss the widget from your app, or intercept external links:
```kotlin theme={null}
val request = ShowProfileRequest.builder()
.customerId("customer-123")
.widgetEventCallback(widgetEventCallback) // React to gameCompleted, etc.
.externalLinkCallback(externalLinkCallback) // Handle gbExternalBrowser links yourself
.mobile("+201234567890") // Channel merging
.email("customer@example.com")
.build()
GameballApp.getInstance(this).hideProfile() // Dismiss the widget programmatically
```
See [Show Profile Widget](/installation-guides/v3/android/show-profile) for the full reference.
If enhanced security is needed, add session token to your configuration:
```kotlin theme={null}
val config = GameballConfig.builder()
.apiKey("api-key")
.lang("en")
.sessionToken("your-session-token")
.build()
```
Test your integration. Aside from the `capturedLinkCallback` rename, existing code works unchanged.
### From v2.x to v3.2.1
Update your `build.gradle` to use SDK v3.2.1:
```groovy theme={null}
dependencies {
implementation 'com.github.gameballers:gb-mobile-android:3.2.1'
}
```
Replace your SDK initialization code with the new `GameballConfig` builder pattern.
Replace `registerCustomer()` with `initializeCustomer()` using the new request builder.
Update event creation to drop the `with` prefix on builder methods (e.g., `.customerId()` instead of `.withCustomerId()`).
Move device token registration to customer initialization instead of separate `initializeFirebase()` call.
Test all Gameball functionality to ensure the migration is successful.
## Compatibility
* **Minimum SDK**: Android API 21 (Android 5.0)
* **Target SDK**: Android API 34
* **Kotlin**: 2.0.0+
* **AndroidX**: Required
* **Gradle**: 7.0+
## Additional Resources
* SDK Repository: [https://github.com/gameballers/gb-mobile-android](https://github.com/gameballers/gb-mobile-android)
* Release history: see the [gb-mobile-android releases page](https://github.com/gameballers/gb-mobile-android/releases)
* Developer Docs: [/](/)
If you encounter any issues during migration, check the GitHub repository for known issues and solutions, or contact Gameball support.
## Next Steps
* [Getting Started](/installation-guides/v3/android/getting-started)
* [Go-Live Checklist](/installation-guides/v3/android/go-live-checklist)
# How Do I Set Up Push Notifications in the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/push-notifications
Set up Firebase or Huawei push notifications
Gameball supports Firebase Cloud Messaging (FCM) and Huawei Push Kit, enabling you to deliver timely updates about rewards, achievements, and promotional messages to customers.
Push notifications help drive engagement by notifying users when they earn points, complete challenges, or receive new rewards.
***
## Firebase Cloud Messaging (FCM)
### 1. Setup
Follow these steps to enable FCM:
1. Add Firebase to your project following the official guide: [https://firebase.google.com/docs/android/setup](https://firebase.google.com/docs/android/setup)
2. Add FCM dependencies to your app:
```groovy theme={null}
dependencies {
implementation platform('com.google.firebase:firebase-bom:32.0.0')
implementation 'com.google.firebase:firebase-messaging'
}
```
3. Add your Firebase credentials in the Gameball Dashboard → Admin Settings → Push Notifications.
***
### 2. Retrieve Device Token
Use the Firebase Messaging API to obtain the device token and pass it to Gameball during customer initialization.
```kotlin theme={null}
FirebaseMessaging.getInstance().token.addOnCompleteListener { task ->
if (task.isSuccessful) {
val token = task.result
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.deviceToken(token)
.pushProvider(PushProvider.Firebase)
.build()
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
callback
)
// With session token override
GameballApp.getInstance(context).initializeCustomer(
customerRequest,
callback,
sessionToken = "customer-token"
)
}
}
```
A push provider (**Firebase**) must always be set if you pass a `deviceToken`.
***
### 3. Handle Incoming Notifications
Implement a custom FirebaseMessagingService to handle notifications sent from Gameball.
```kotlin theme={null}
class MyFirebaseMessagingService : FirebaseMessagingService() {
override fun onMessageReceived(remoteMessage: RemoteMessage) {
super.onMessageReceived(remoteMessage)
if (remoteMessage.data["source"] == "gameball") {
val title = remoteMessage.notification?.title
val body = remoteMessage.notification?.body
showNotification(title, body)
}
}
override fun onNewToken(token: String) {
super.onNewToken(token)
// Re-register the token with Gameball
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.deviceToken(token)
.pushProvider(PushProvider.Firebase)
.build()
GameballApp.getInstance(applicationContext).initializeCustomer(
customerRequest,
object : Callback {
override fun onSuccess(response: InitializeCustomerResponse) {}
override fun onError(error: Throwable) {}
}
)
}
}
```
#### Register the service
```xml theme={null}
```
***
## Huawei Push Kit (HMS)
For Huawei devices **without Google Play Services**, use Huawei Push Kit.
### 1. Setup
1. Configure Huawei Push Kit in **AppGallery Connect**
2. Add Push Kit dependency:
```groovy theme={null}
dependencies {
implementation 'com.huawei.hms:push:6.7.0.300'
}
```
3. Add Huawei repository:
```groovy theme={null}
repositories {
maven { url 'https://developer.huawei.com/repo/' }
}
```
***
### 2. Retrieve Device Token
```kotlin theme={null}
object : HmsMessageService() {
override fun onNewToken(token: String) {
val customerRequest = InitializeCustomerRequest.builder()
.customerId("customer-123")
.deviceToken(token)
.pushProvider(PushProvider.Huawei)
.build()
GameballApp.getInstance(applicationContext).initializeCustomer(
customerRequest,
object : Callback {
override fun onSuccess(response: InitializeCustomerResponse) {}
override fun onError(error: Throwable) {}
}
)
}
}
```
For full Huawei setup instructions, refer to:
• AppGallery Connect Configuration: \
[https://developer.huawei.com/consumer/en/doc/hmscore-guides/android-config-agc-0000001050170137](https://developer.huawei.com/consumer/en/doc/hmscore-guides/android-config-agc-0000001050170137)
• Push Kit Codelab: [https://developer.huawei.com/consumer/en/codelab/HMSPushKit/index.html#0](https://developer.huawei.com/consumer/en/codelab/HMSPushKit/index.html#0)
***
## In-App Messaging
Gameball supports several types of in-app engagement:
* **Profile widget pop-ups**
* **Native in-app notifications**
* **Custom in-app messaging templates**
All configurations, message templates, rules, and segmentation are controlled directly from the **Gameball Dashboard**.
***
## Best Practices
Request notification permission at a meaningful point in the user's journey, rather than immediately upon app launch.
Always update the device token when it changes (`onNewToken`) by calling `initializeCustomer` with the new token and matching `pushProvider`.
Verify push delivery on different Android versions and manufacturers.
Keep notifications relevant and valuable to avoid opt-outs.
***
# How Do I Show the Profile Widget in the Android SDK (v3)?
Source: https://docs.gameball.co/installation-guides/v3/android/show-profile
Display the Gameball customer profile widget in your Android app
# Open the Gameball Profile Widget
Use the Gameball profile widget to show customers their **points, rewards, tiers, leaderboards, and history** inside your Android app.
Before showing the profile widget, make sure the SDK is initialized and the customer has been registered using [Initialize SDK](/installation-guides/v3/android/initialize-sdk) and [Initialize Customer Profile](/installation-guides/v3/android/initialize-profile).
***
## Basic Usage
Create a `ShowProfileRequest` and call `showProfile` from `GameballApp`.
🔒
Secure API Access: To benefit from v4.1 secure API endpoints, pass the sessionToken parameter when showing the profile widget (required in upcoming SDK v4). This enables automatic routing to v4.1 secure endpoints. Learn more about v4.1 →
```kotlin Kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.build()
GameballApp.getInstance(this).showProfile(
this,
profileRequest
)
// With session token override
GameballApp.getInstance(this).showProfile(
this,
profileRequest,
sessionToken = "customer-token"
)
```
```java Java theme={null}
ShowProfileRequest profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.build();
GameballApp.getInstance(this).showProfile(
this,
profileRequest
);
```
***
## Request Parameters
Unique identifier for the customer whose profile will be displayed. Optional (omit for guest mode).
Specific section to open inside the widget (for example, `"details_earn"`, `"details_redeem"`). If not set, the main profile view opens by default.
Hides the widget navigation bar when set to `true`. Defaults to `false`.
Shows a close button within the widget when set to `true`. Defaults to `false`.
Hex color string for the close button (for example, `"#FF5733"`).\
Only applies when `showCloseButton` is `true`.
Optional session token to override the global token for this specific request. Required in upcoming SDK v4.
Customer mobile number, used for channel merging. Available from v3.2.0.
Customer email address, used for channel merging. Available from v3.2.0.
Handler for links the widget tags with `gbExternalBrowser=true`. When provided, the link is delegated to your app; otherwise the SDK opens it in the system browser. Available from v3.2.0.
Receives events the widget posts, such as game completion. Available from v3.2.0.
### Validation Rules
No required fields (guest mode supported). Provide `customerId` for authenticated profiles.
***
## Advanced Configuration
### Open a Specific Section
Use openDetail to deep link into a specific section (for example, “earn” details):
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.openDetail("details_earn") // Open the earn points section
.build()
```
### Guest Mode (v3.1.1+)
```kotlin theme={null}
// No customerId required
val guestRequest = ShowProfileRequest.builder()
.showCloseButton(true)
.build()
GameballApp.getInstance(this).showProfile(
this,
guestRequest
)
```
### Custom Close Button
Show a custom-colored close button on the widget:
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.showCloseButton(true)
.closeButtonColor("#FF5733")
.build()
```
### Hide Navigation
Often paired with `openDetail` to guide users to a specific section when navigation is hidden.
Hide the widget’s internal navigation controls:
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.openDetail("details_earn")
.hideNavigation(true)
.build()
```
### Handle External Links (v3.2.0+)
Links the widget tags with `gbExternalBrowser=true` open in the system browser by default. Provide an `externalLinkCallback` to handle them yourself instead (for example, to open an in-app browser or route to a custom screen):
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.externalLinkCallback(object : Callback {
override fun onSuccess(url: String) {
// Open the link your own way, e.g. an in-app browser or a custom screen
Log.d("GameballWidget", "External link: $url")
}
override fun onError(error: Throwable) {
// Handle error
}
})
.build()
```
When `externalLinkCallback` is set, the SDK delegates the link to your app and does not open the system browser.
### Channel Merging (v3.2.0+)
Pass the customer's `mobile` and `email` so Gameball can merge the customer's channels:
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.mobile("+201234567890")
.email("customer@example.com")
.build()
GameballApp.getInstance(this).showProfile(this, profileRequest)
```
***
## Widget Events (v3.2.0+)
Pass a `widgetEventCallback` to react to events the widget posts, such as a customer finishing a game. Each event arrives as a `Map` with a top-level `type` and a nested `metadata` map:
```kotlin theme={null}
val profileRequest = ShowProfileRequest.builder()
.customerId("customer-123")
.widgetEventCallback(object : Callback