Skip to main content

Verifying game events statuses for your app

It's important to properly communicate issues with your app to users using simple and accurate messaging to describe the state of the app. This makes for better user experience and can prevent bad user reviews.

Event Health Levels​

App health and status is measured using four levels:

Status codeDescription
0unsupported
1green (Good to go)
2yellow (Partial functionality, some game events may be unavailable)
3red (Game events are unavailable)
info

App States are updated automatically so there might be a small delay (10~ min) between server state and the actual real-time status.

Review event statuses for all games​

It's important to check the general status of game events used in your app. If the game event status returns a Yellow or Red state, query the specific game and event that's reporting issues. Communicate to the app users ass soon as possible if your app isn't functioning correctly.

See health status for ALL games to view the health status for all supported games. You can use the endpoint below to retrieve a JSON object with a list of all supported games and their health status.

Example:

https://game-events-status.overwolf.com/gamestatus_prod.json

Data Example: Success​

[
    {"game_id":10878,"state":0},
    {"game_id":7764,"state":1},
    {"game_id":7314,"state":1},
    {"game_id":21216,"state":1},
    {"game_id":10844,"state":3,"maintenance_msg":"Events are disabled","disabled":true},
    {"game_id":10906,"state":1},
    {"game_id":10798,"state":1},
    {"game_id":6365,"state":1}
]

Review event status for a specific game​

If you suspect an issue or regularly use Overwolf events in your app, you should regularly verify each event's health and communicate any issues to your users.

To get an event’s health status for a specific game, query the endpoint below. It returns a JSON object with specific event states for the specified game. Replace {gameId} with the ID of the game.

Example:

https://game-events-status.overwolf.com/{gameId}_prod.json

LoL (gameId=5426) is used in the example below.

Data Example: Success​

{
    "game_id": 5426,
    "state": 1,
    "features": [{
            "name": "abilities",
            "state": 1,
            "keys": [{
                "name": "ability",
                "type": 0,
                "state": 1
            }, {
                "name": "usedAbility",
                "type": 0,
                "state": 1
            }]
        }
    },
    {
        "name": "assist",
        "state": 1,
        "keys": [{
            "name": "assist",
            "type": 0,
            "state": 1
        }]
    }
    "name": "teams",
    "state": 1,
    "keys": [{
        "name": "teams",
        "type": 1,
        "state": 1,
        "category": "game_info"
    }]
}