Notifications Webhook

Use our webhooks to receive notifications from Gameball application.

Notifications webhook is triggered with every notification generated at Gameball for a player. 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 here.

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

Notifications Webhook POST Data

Parameter

Type

Description

playerUniqueId

string

Unique identifier for the player in your database.

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

notifications

array

Array of notification objects generated for player

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.

Last updated