v4.0 (Beta)

Customer's Profile Updates

This webhook is triggered every time there’s an update to a customer’s profile, ensuring your app stays in sync with the latest changes.

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
  }
}

event string

This indicates that the event triggering the webhook is related to sending a push notification for a customer


client_id string

The unique identifier for the client (your app) that’s receiving the webhook.


customer_id string

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 string

The Gameball internal identifier for the customer.


created_at DateTime

The timestamp when the webhook event was created, formatted in ISO 8601.


data Array

This contains an array of notification data in multiple languages.

Customer Profile Object

email string

The customer’s email address.


mobile_number string

The customer’s mobile number.


tier_name string

The customer's current loyalty tier.


tier_order number

The customer's current loyalty tier.


referral_code string

A referral code associated with the customer.


A referral link for the customer.


activated_points number

The points the customer has currently activated and can use.


pending_points number

Points that are pending and will be activated later.


total_points number

The customer’s total accumulated points, including both activated and pending points.

Last updated