Gameball Developers Guide
v3.0
v3.0
  • Introduction
  • What's New in V3.0
  • Installing Gameball
    • Web
      • Show 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
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • 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
      • Migration from v1 to v2
    • Flutter
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • 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
    • Retail & Modern POS
      • Initialize Gameball Customer Profile
      • Track Orders & Cashback Reward
      • Track Refunds
      • Enable Redemption
        • Prepare POS for Redemption
        • Using Virtual ID
          • Using Virtual Card
  • REST API
    • Overview
      • Server-Side SDKs
    • Authentication
    • API Reference
      • Customer
      • Event
      • Transactions
      • Order
      • Coupons
      • Leaderboard 👑
      • Notifications 👑
      • Configurations 👑
      • Batches 👑
        • Batch Operations Data
      • OTP
      • Partner 🤝
        • Client 🤝
        • Redemption Rule 🤝
        • Cashback Rule 🤝
    • Webhooks
      • Notifications Webhook
      • Customer Profile Webhook
    • Errors
    • Object Reference
  • Tutorials
    • Build Custom UI Elements 👑
      • Display Reward Campaign Progress
      • Show VIP Tiers
      • Show Customer Points Balance
      • Build Leaderboards
      • Show Notifications Inbox
      • Adapt UI to Configurations
      • Advanced UI Techniques
        • Increase Sales with Cashback UI Elements
        • Derive Engagement with Rewards Campaigns UI Elements
    • Tracking Customer Events
    • Build your Own Notification System
    • Checkout Integration Example
    • Redemption Integration Options
      • Redeem with coupon system
        • Integrate your coupon system
          • Example using e-commerce platform(WooCommerce)
          • Example using a custom coupon system
        • Build couponing experience
          • Using Gameball widget
          • Build custom experience
            • Showing customers available points
            • Allowing customers to create coupons
            • Apply the discount code to your cart
        • Coupon integration reference
      • Redeem with direct debt
        • Get customers points balance
        • Redeem customer points
  • Third Party Integrations
    • Segment Integration
Powered by GitBook
On this page
  1. REST API
  2. Webhooks

Notifications Webhook

Use our webhooks to receive notifications from Gameball application.

PreviousWebhooksNextCustomer Profile Webhook

Last updated 1 year ago

Notifications webhook is triggered with every notification generated at Gameball for a customer. Once a notification is generated, its details and text are sent through the webhook.

Common webhook use cases include, but not limited to, the following:

  • Sending notifications to IM clients and pagers

  • Sending notifications via SMS to mobile

Get to know how to enable or disable Real-Time Notifications for Referrals and other events .

To get a better idea of how to build your own notification system using this webhook, you may find it useful to follow this .

Notifications Webhook POST Data

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the customer in your database.

Could be database ID, random string, email or anything that uniquely identifies the customer.

notifications

array

Array of notification objects generated for customer

The notification object is described as follows:

{ "icon":"https://.../image.png",

"type":1,

"body":"Congratulations",

"title":"Congratulations",

"local":"en"

}

  • icon: Image URL of notification

  • type: Appearance type of notification

  • body: Notification body text

  • title : Notification title text

  • local: Local code. Example: "en"

{
   "playerUniqueId":"testwebhook@gameball.co",
   "notifications":[
      {
         "icon":"https://cdn.gameball.co/uploads/c/image.png",
         "type":1,
         "body":"Congratulations",
         "title":"Congratulations",
         "local":"en"
      },
      {
         "icon":"https://cdn.gameball.co/uploads/c/image.png",
         "type":1,
         "body":"Félicitations",
         "title":"Félicitations",
         "local":"fr"
      }
   ]
}

You can now enjoy notifications on selected events that you have subscribed to.

here
tutorial