Receive user scores

This feature is only available with paid plans. Contact us to know more.

Our systems can send your users’ scores to you in real-time. Our partners use scores for innovative use cases:

Create leaderboards, and organise tournaments on your platform; explore our Tournaments offering if you want a turnkey tournaments solution from Gamezop.
Give score targets to your users and reward them if they achieve scores

We can send user scores to you in 2 ways:

Server-side webhooks
Client-side broadcasts

Server-side webhooks

You can get scores of your users in real-time providing us a POST API / webhook URL. Gamezop will push your users’ scores to this API. In order for this to work, you must also append a sub query parameter to the game url received in the All Games API. For example: https://3025.play.gamezop.com/g/NyM_JGWcx?sub=123-554-111 The value of this sub param must be a unique user identifier for the user playing the game. Max supported length of this value is 100 characters. Scores are always scoped to a game and user identifier.

Your webhook endpoint

POST https://api.publisher-xyz.com/games/score Gamezop posts user scores in real-time to your webhook

Headers

Name	Type	Description
Authorization: Bearer	String	We can add in a bearer token in the authorization headers if you require us to.

Upon receiving scores from us, you must respond with an HTTP 200 Status Code In the body of the webhook, Gamezop will send a JSON object when your users’ scores update. The data body will contain the following fields:

Key	Description
`gameCode`	Unique code assigned to each game — this is the `code` value received in the All Games API.
`sessionId`	Unique session identifier generated by Gamezop — remains same throughout a session. A session ends when the game page is refreshed or reloaded.
`gamePlayId`	Unique game play identifier generated by Gamezop — remains same throughout a game play. There can be multiple game plays per session — each time the user loses the game, a new game play starts.
`timestamp`	Unix timestamp — denotes the exact time at which this score was made by the user.
`score`	Score made by the user.
`leaderboardId`
`subId`	User identifier passed by you as `sub` parameter in the game URL.
`country`	The ISO 3166-2 country code for the country from which the user is playing the game.
`duration`	Total time spent in the game play up until the point of the webhook call (captured in milliseconds). When a new game play starts, this is reset to 0.
`state`	Denotes the state of game at the time the `score` was made. It can be one of the following values: 1. loaded: `score` is always 0 with this state — it just means that the game finished loading. 2. start: This is fired at the start of every new game play. `score` and `duration` are 0 in this state update. 3. playing: This state means that the game is being played by the user — as the user’s score keeps changing, we keep sending them to your API 4. over: The `score` received with this state value denotes the user’s score when the game got over. Within the same session, a user can retry a game several times. This means that there may be several `over` states within the same session. 5. levelup: In case of level-based games, this state denotes the completion of a level.

Client-side broadcasts

Client-side callbacks can also be made for these score updates. This is usually needed if you wish to use them to trigger custom UI elements. We could add your JS tags to games, or make broadcasts over a WebView bridge. The typical payload for client-side broadcasts look like:

{
  "duration": 67100,
  "gameCode": "B1fSpMkP51m",
  "gamePlayId": "951ce204-7029-4608-aa25-147ccaa36ff1",
  "leaderboard": {
    "id": "B1fSpMkP51m_default",
    "description": "Rankings of best scores made in Bottle Shoot",
    "name": "Score leaderboard"
  },
  "score": 100,
  "state": "playing"
}

Please contact your Gamezop Account Manager to enable client-side broadcasts.

Do more with scores

If you want to run time-bound competitions on top of user scores — with live rankings and final results managed by Gamezop — check out our Tournaments APIs:

Run tournaments on Gamezop games

Create and manage tournaments on our games, pull live leaderboard data, and fetch final results.

GET STARTED

INTEGRATE GAMEZOP

INTEGRATE QUIZZOP

INTEGRATE FEEDZOP

INTEGRATE ASTROZOP

INTEGRATE CRICZOP

INTEGRATE PERFORMANCE AD CAMPAIGNS

PLATFORM GUIDES & APIs

Server-side webhooks

Your webhook endpoint

Headers

Client-side broadcasts

Do more with scores

Run tournaments on Gamezop games

​Server-side webhooks

​Your webhook endpoint

​Headers

​Client-side broadcasts

​Do more with scores

Run tournaments on Gamezop games

Server-side webhooks

Your webhook endpoint

Headers

Client-side broadcasts

Do more with scores