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 | 263.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"260.0.0","is_updated":true}"}},"feature":"gep_internal"}
game_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
phase | game_info | The current phase during the game | See notes | 263.0 |
game_mode | game_info | The current played game mode | See notes | 263.0 |
match_history | game_info | List of ID's of all the local player previous matches | See notes | 263.0 |
steam_id | game_info | The local player's Steam ID | See notes | 263.0 |
phase note
Possible phase values:
- Init
- WaitingForPlayersToJoin
- PreGameWait
- GameInProgress
- PostGame
Data Example:
{"feature":"game_info","category":"game_info","key":"phase","value":"Init"}
game_mode note
Data Example:
{"feature":"game_info","category":"game_info","key":"game_mode","value":"{\"match_mode\":\"Unranked\",\"game_mode\":\"Normal\"}"}
match_history note
List of parameters:
- match_id
- hero_id
- hero_name
- kills
- deaths
- assists
Data Example:
{"feature":"game_info","category":"game_info","key":"match_history","value":"[{\"match_id\":\"19172158\",\"hero_id\":\"1\",\"kills\":2,\"deaths\":11,\"assists\":2,\"hero_name\":\"INFERNUS\"},{\"match_id\":\"19175987\",\"hero_id\":\"4\",\"kills\":0,\"deaths\":10,\"assists\":1,\"hero_name\":\"LADY GEIST\"},{\"match_id\":\"24145672\",\"hero_id\":\"31\",\"kills\":0,\"deaths\":1,\"assists\":4,\"hero_name\":\"LASH\"},{\"match_id\":\"24146361\",\"hero_id\":\"8\",\"kills\":0,\"deaths\":2,\"assists\":0,\"hero_name\":\"MCGINNIS\"}]"}
steam_id note
Data Example:
{"feature":"game_info","category":"game_info","key":"steam_id","value":"765611912345582960"}
match_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
team_score | match_info | Updated team score of the current match for each team | See notes | 263.0 |
match_id | match_info | ID of the current match | See notes | 263.0 |
roster | match_info | Full roster deails during the match | See notes | 263.0 |
team_score note
Data Example:
{"feature":"match_info","category":"match_info","key":"team_score","value":"{\"amber\": \"6\" , \"sapphire\" : \"0\"}"}
match_id note
Data Example:
{"feature":"match_info","category":"match_info","key":"match_id","value":"25735575"}
roster note
Data Example:
{"feature":"match_info","category":"match_info","key":"roster_0","value":"{\"player_name\":\"MrTesting\",\"steam_id\":76561151141339179,\"team_name\":\"Amber\",\"is_local\":true,\"team_id\":2,\"hero_id\":10,\"level\":1,\"kills\":0,\"deaths\":0,\"assist\":0,\"hero_damage\":0,\"object_damage\":0,\"hero_healing\":0,\"health\":550,\"souls\":124,\"hero_name\":\"PARADOX\"}"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | nulll | In the beginning of each match | See notes | 263.0 |
match_end | nulll | At the end of each match | See notes | 263.0 |
kill | nulll | When the local player kill an enemy | See notes | 266.0 |
death | nulll | When the local plyer died | See notes | 266.0 |
assist | nulll | When the local player assist another player | See notes | 266.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Data Example:
{"events":[{"name":"match_end","data":null}]}
kill note
Data Example:
{"events":[{"name":"kill","data":null}]}
death note
Data Example:
{"events":[{"name":"death","data":null}]}
assist note
Data Example:
{"events":[{"name":"assist","data":null}]}
Loading...