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
  • Authentication
  • API Reference
  • Webhooks
  • Errors
  1. REST API

Overview

PreviousPush NotificationsNextWhat's New in V4.0

Last updated 6 months ago

This section provides a detailed guide to all the Gameball APIs required for integrating our loyalty and engagement platform into your system. Whether you’re managing customer interactions, tracking transactions, or configuring rewards, the Gameball API empowers you to create a seamless and engaging experience for your users.

The Gameball API is designed around RESTful principles, offering intuitive, resource-oriented URLs, JSON-encoded responses, and standard HTTP methods for easy integration. We also use standard HTTP status codes and authentication methods, ensuring secure and reliable communication between your system and Gameball’s platform.

In this section, you will find the comprehensive API reference covering all the endpoints required to integrate with Gameball’s features. These APIs enable you to build tailored loyalty experiences, track user events, manage customer data, handle transactions, and much more. Whether you're running an e-commerce platform, a fintech service, or another customer-facing product, Gameball’s APIs provide the tools to enhance customer engagement and drive loyalty.

Authentication

Before making any requests, it’s important to understand how Gameball authenticates incoming API calls. Refer to the section for detailed instructions.

API Reference

Gameball offers a wide range of endpoints that enable you to interact with and leverage the full power of the Gameball engine. The supported endpoints include:

Base URL

The API base URL is the following, with v4.0 as our current version.

https://api.gameball.co/api/{version}

Webhooks

Errors

Use webhooks to automate your workflows and enhance productivity by triggering custom actions based on Gameball events. More details can be found in the section.

To help you troubleshoot any issues, refer to the section to learn about common error codes and their descriptions.

Authentication
Customer
Event
Order
Transactions
Coupons
Configurations
Leaderboard
Webhooks
Errors