Gameball Developers Guide
v4.0
v4.0
  • Introduction
  • Installing Gameball
    • Web
      • Initialize Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Push Notifications
      • Track Referrals
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Flutter
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
  • REST API
    • Overview
      • What's New in V4.0
      • Authentication
      • Rate Limiting
      • Status and Error Codes
    • Customers
      • Customer Management
      • Customer Progress
      • Customer Tags
      • Customer Notifications
    • Events
    • Order
      • Order Tracking
      • Order Rewards & History
    • Payment
      • Payment Tracking
    • Transactions
      • Cashback & Redemptions
      • Hold Management
      • Transaction Management
      • Transaction Validation
    • Coupons
    • Configurations
      • Reward Configurations
      • Program Configurations
      • Widget Configuration
    • Leaderboard
    • Batches
      • Batch Creation
      • Batch Management
  • Webhooks
    • Overview
    • Subscribing to Webhooks
    • Webhook Topics
      • Customer's Notifications
      • Customer's Profile Updates
  • Tutorials
    • Tracking Customer Events
    • Redemption Integration
      • Direct debit redemption
      • Coupons Redemption
        • Use Your Own Couponing Engine
        • Gameball Couponing Engine
    • Checkout Integration
    • Build Custom UI Elements
      • Reward Campaigns
      • VIP Tiers
      • Customer Balance
      • Widget Configurations
      • Coupons Customer Experience
      • Customer Notifications
      • Customer Leaderboard
    • Build your Own Notification System
    • Channel Merging Guide
    • Previewing Potential Points Before Purchase
    • Refund
    • Retail & POS Integration with Gameball Loyalty Program
    • Referrals
    • Widget Deep Links
    • Batch APIs usage example
  • Branch.io Integration
  • Adjust Integration
Powered by GitBook
On this page
  • Overview
  • Tracking Referral Signups
  • Tracking Referral Using Widget
  1. Installing Gameball
  2. Web

Track Referrals

Reward your customers for referrals and grow your business.

PreviousIntegrate RedemptionNextGo-Live Checklist

Last updated 6 months ago

Overview

Referrals is a marketing strategy that allows your business to grow by utilizing your customers' friends' recommendation through word of mouth. Gameball lets you to integrate a referral system that helps facilitates the referral process for your current customers and their friends.

The process takes place through generating a unique referral code (referral URL) by Gameball. Each customer can find their code in their widget to share it with friends.

From a technical point of view, first you need to show your customers their referral link; for that you use the Retrieve Customer endpoint to get the customer's link. Second once your customers share their referral link with any of their friends and they sign up to your platform; you have to link the referrer and the referree to each other. When the referree signs up, you will add the referrer code in the Create customer body request, and Gameball automatically links them.

The unique code is concatenated with your website URL configured on Gameball dashboard ( to learn more) to form the Customer Referral Link.

For example if you have configured your website URL to be http://www.myAwesomeWebsite.com the referral link for Customer "John Snow" with referral code code123 would be

http://www.myAwesomeWebsite.com?ReferralCode=code123

Your customers can then exchange their referral link with their referrals so that they can get rewarded for their referrals if they signed up and fulfill the requirement as configured on your referral program. Every customer will be able to find the unique referral link on the referral tab inside Gameball customer profile widget

Tracking Referral Signups

When a referral lands on your website with a referral link

http://www.myAwesomeWebsite.com?ReferralCode=code123

You can detect that by checking URL query strings for ReferralCode. If detected, you can then store the ReferralCode value on the user's session or leverage the browser local storage, session storage, or cookies.

Below is a sample API call to create a new customer "Aria Stark" that is being referred by Customer "John Snow" with referral code code123

curl -X POST -H 'apiKey: {{Your_API_Key}}' -d '{
  "customerId":"CUST_ID",
  "customerAttributes":{
      "displayName":"Arya Stark",
      "firstName": "Arya",
      "lastName": "Stark",
      "email":"arya.stark@example.com"
  },
  "referrerCode": "code123",
}' -v -i 'https://api.gameball.co/api/v4.0/integrations/customers'

Tracking Referral Using Widget

If you have embedded The Gameball Profile Widget into your web page, you can relay on it to handle referral for you. The widget will internally

  1. Check for ReferralCode query parameter in the URL

  2. Store it in session storage

  3. Send it along its parameters when a new profile is created.

Check this to learn how the referral module will appear in your customers' profile on Gameball widget.

Once the guest referral sign-ups, you can then send the ReferralCode along with the sign-up data of the new customer via the .

article
Learn more about the Gameball referral program.
Click here
Customer's referral link
Create Customer API