Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gameball.co/llms.txt

Use this file to discover all available pages before exploring further.

Common Use Cases:
  • Sync Customer Points and VIP Tier: Keep your CRM system up-to-date with the latest customer points and VIP tier information.
  • Track Profile Changes: Automatically update other systems or services when customer profile details change.
This webhook ensures that your systems reflect the most accurate and up-to-date customer information.

​
Customer Profile Webhook POST Data

{
  "event": "customer.profile.updated",
  "client_id": "2155",
  "customer_id": "webhook-test",
  "gb_customer_id": 1234,
  "created_at": "2024-11-19T17:34:42.297Z",
  "data": {
    "email": "customer@example.com",
    "mobile_number": "+XX-XXXX-XXXX",
    "tier_name": "basic",
    "tier_order": 1,
    "referral_code": "referral_123",
    "referral_link": "www.example.com",
    "activated_points": 90,
    "pending_points": 10,
    "total_points": 100
  }
}

​
Webhook Fields

​
event
string
required
This indicates that the event triggering the webhook is related to a customer profile update
​
client_id
string
required
The unique identifier for the client (your app) that’s receiving the webhook.
​
customer_id
string
required
Unique identifier for the customer that you can reference across the customer’s whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.
​
gb_customer_id
number
required
The Gameball internal identifier for the customer.
​
created_at
string
required
The timestamp when the webhook event was created, formatted in ISO 8601.
​
data
object
required
This contains the updated customer profile data.