Loading...
- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
Game event status
It is highly recommended to communicate errors and warnings to app users.
Check the current game event status here. Alternatively, you can easily check that status from your app itself, using our API.
gep_internal
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| gep_internal | gep_internal | Local + Public version number | See notes | 259.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"258.0.0","is_updated":true}"}},"feature":"gep_internal"}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| scene | game_info | The current scene state | See notes | 261.0 |
scene note
Possible Scene values:
- lobby
- ingame
- death
Data Example:
{"feature": "game_info", "category": "game_info", "key": "scene", "data": "lobby"}
match_info
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | nulll | In the beginning of each match | See notes | 261.0 |
| match_end | nulll | At the end of each match | See notes | 261.0 |
| knockout | nulll | When the local player is doing a knockout | See notes | 261.0 |
| death | nulll | When the local player dies | See notes | 261.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
knockout note
Data Example:
{"events":[{"name":"knockout","data":null}]}
death note
Data Example:
{"events":[{"name":"death","data":null}]}
Loading...