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:
  • Push Notifications: Deliver updates or messages directly to your customers’ devices.
  • SMS Notifications: Send important notifications to customers via SMS.
This webhook ensures your app can instantly act on notifications, keeping your customers informed and engaged.
Get to know how to enable or disable Real-Time Notifications for Referrals and other events here.

​
Notifications Webhook POST Data

{
  "event": "customer.notification.push",
  "client_id": "2155",
  "customer_id": "webhook-test",
  "gb_customer_id": 1234,
  "created_at": "2024-11-12T19:02:24.631Z",
  "data": [
    {
      "local": "en",
      "icon": "https://example.com/image.webp",
      "body": "Your recent activities have been amazing! Keep up the great work and enjoy your rewards!",
      "title": "Well Done!"
    },
    {
      "local": "fr",
      "icon": "https://example.com/image.webp",
      "body": "Félicitations pour vos réalisations récentes! Continuez comme ça et profitez de vos récompenses!",
      "title": "Bravo!"
    }
  ]
}

​
Webhook Fields

​
event
string
required
This indicates that the event triggering the webhook is related to sending a push notification for a customer
​
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
array
required
This contains an array of notification data in multiple languages.
You can now enjoy notifications on selected events that you have subscribed to.