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

Notifications Webhook POST Data

{
   "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"
      }
   ]
}

Parameter

Description

Type

playerUniqueId

PlayerUniqueId is a unique ID for you user, for example UUID or username. The PlayerUniqueId is to be provided by the client and must be unique for each user.

String

notifications

Array of notifications generated for player

Array

notifications.icon

Image URL of notification item

String

notifications.type

Apperance type of notification item

Integer

notifications.local

Local code

Array

notifications.body

Notification item body text

String

notifications.title

Notification item title text

String

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

Last updated