LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
Powered by GitBook
On this page
  • Using the Referrer Token in Open Loyalty
  • What is the Referrer Token?
  • Where Can the Referrer Token Be Used?
  • How to Pass the Referrer Token to Open Loyalty
  • Individual Referral URLs
  • Best Practices for Using Referrer Tokens
  • Troubleshooting

Was this helpful?

  1. FAQ

Referral Programs

This article explains how to provide users with the ability to invite friends to the loyalty program by sharing a unique referral link.

Last updated 4 months ago

Was this helpful?

Using the Referrer Token in Open Loyalty

Open Loyalty allows seamless member referrals through the use of a unique referrer token. Each member receives this token upon creation, enabling them to invite others through various channels such as mobile apps, URLs, or personalized links. In this article, we'll explore how to utilize the referrer token externally and the process for passing it to Open Loyalty upon member creation.

What is the Referrer Token?

The referrer token is a unique identifier created by Open Loyalty when a new member is added to the system. This token can be shared externally to track referrals.

It is essential to note that the token must be provided during the creation of a referred member—it cannot be added retroactively.

Where Can the Referrer Token Be Used?

The referrer token can be used in several external contexts, such as:

  1. Mobile Apps: Members can share their unique referral link with friends via mobile applications. The app can embed the referrer token in the shared link, which new users can click to sign up.

  2. URLs and Web Pages: The referrer token can be embedded in URLs, enabling users to share their link on social media, messaging apps, or websites. For example:

    • URL Format: https://examplelink.com/invite?referrerToken=XYZ123

    • When the new member clicks this link and completes the registration, Open Loyalty receives the referrer token and links it to the new member account.

  3. Email Invitations: Referrer tokens can also be included in email campaigns or personal invites. Members can send emails containing their unique referral link, allowing friends or colleagues to register through their link.

Here is an example of how it could visually appear in your app.


How to Pass the Referrer Token to Open Loyalty

When a referral token is used externally, it must be passed back to Open Loyalty during the referred member's creation. This is crucial to ensure that the connection between the referrer and referee is created when the invited friend registers.

The generation or service for referral links is not provided by Open Loyalty and must be managed through the integration layer.

Steps to Pass the Referrer Token During Member Creation

  1. Retrieve the Referrer Token: Get a member's unique referral token from Open Loyalty.

  2. Generate Referral Link: Use your service to generate a unique link that can be used in your app and email communications.

  3. Capture the Referrer Token: Ensure that the referrer token is captured from the external source (e.g., URL parameter, mobile app deep link, or email link).

  4. Include in the Registration Process: When the new member registers, the captured referrer token should be included in the registration API call sent to Open Loyalty. The token cannot be added later, so it's vital that this step is completed during the creation process.

  5. Confirmation: Once the new member is created, the referrer token is saved, and Open Loyalty automatically links the new member to the referring member, allowing the referrer to earn rewards based on the loyalty program’s rules.

Here’s a basic example of how the referrer token can be passed in the API call:

jsonCopy code{
   "member": {
      "email": "newmember@example.com",
      "name": "John Doe",
      "referrerToken": "XYZ123"
   }
}

Below you can find a diagram visualizing the sample flow of the integration for referrals:

Individual Referral URLs

Every member, including referred members, has their own referral URL once they are registered. They can share this link to invite others, using the same flow described above.

For example, once "John Doe" has registered via a referral, he will receive his own referral token and can invite others using his personalized link:

  • John Doe's Referral Link: https://examplelink.com/invite?referrerToken=ABC456


Best Practices for Using Referrer Tokens

  1. Seamless User Experience: Make sure to integrate the referral process smoothly in your mobile app or website. Prompt users to share their referral link easily once they join.

  2. Test the Token Flow: Before launching your referral program, ensure that the referrer token is correctly passed in all external channels (e.g., mobile, web) and that it is successfully linked during member creation.

  3. Promote Sharing: Encourage users to share their referral links through multiple platforms such as email, messaging, and social media to increase the visibility of your loyalty program.

Troubleshooting

  • Referrer Token Missing: If a referred member is created without a token, the referring member cannot be credited for the referral. Ensure the token is always included in the creation process.

  • Invalid Token: Ensure that the referrer token is correctly formatted and passed to the Open Loyalty system during the new member's registration.


By following these guidelines, you can effectively utilize referrer tokens to grow your loyalty program through external channels while ensuring that referrers are properly rewarded.