Skip to main content

Verifying events for your app

As we discussed in the Error Handling page, it's important to properly communicate issues with your app to users in the right way. A simple and accurate message describing the state of the app will make for a better user experience and prevents bad user reviews.

Event Health Levels​

We measure app health and status using four levels of health:

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

Specific event health states are respectively green, yellow or red following the same scheme.

info

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

Review event status for all games​

It's important to check the general status of events with all apps that use them. If it returns Yellow or Red state, you should research the issue and query the specific event and game that's showing issues. If your app does not function correctly you should communicate it to your users as soon as possible.

To get an events health status for ALL games you can query this endpoint, which will return a JSON with the supported games and each of their event health states:

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, we highly recommend you verify each event's health and communicate any issues to your users.

To get an event’s health status for a specific game, you can query this endpoint, which will return a JSON with event states for a particular game:

https://game-events-status.overwolf.com/[your Game ID]_prod.json

Note that you should add your Game ID to this endpoint. For example, to check event health in LOL (Game ID 5426) you should call:

https://game-events-status.overwolf.com/5426_prod.json

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