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. Alternately, 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 | 143.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}
game_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
game_state | game_info | Current state of the game. | See notes | 151.0 |
game_mode | game_info | Currently played game-mode. | See notes | 151.0 |
game_state note:
Data Example:
{"info":{"game_info":{"game_state":"loading_screen_start"}},"feature":"game_info"}
{"info":{"game_info":{"game_state":"game_loaded"}},"feature":"game_info"}
{"info":{"game_info":{"game_state":"match_in_progress"}},"feature":"game_info"}
{"info":{"game_info":{"game_state":"match_ended"}},"feature":"game_info"}
game_mode note
Be wary that this is not supported in game-browser.
Full list of game-modes:
- 0003 = "Junkensteins Revenge"
- 0007 = "Ctf"
- 0008 = "Meis Snowball Offensive"
- 0009 = "Elimination"
- 0015 = "Uprising"
- 0016 = "Skirmish"
- 0020 = "Assault"
- 0021 = "Escort"
- 0022 = "Hybrid"
- 0023 = "Control"
- 0025 = "Tutorial"
- 0026 = "Uprising All Heroes"
- 0029 = "Team Deathmatch"
- 0030 = "Deathmatch"
- 0032 = "Lucioball"
- 0037 = "Retribution"
- 0041 = "Yeti Hunter"
- 0042 = "Halloween Holdout Endless"
- 0061 = "Calypso Heromode"
- 0067 = "Storm Rising"
- 0074 = "Survivor"
- 0089 = "Snowball Deathmatch"
- 0090 = "Practice Range"
Data Example:
{"info":{"game_info":{"game_mode":"16"}},"feature":"game_info"}
Note that on the response the leading zeros are removed ("0030" => "30")
match_info
Info Updates
key | Category | Values | Notes | Since Version |
---|---|---|---|---|
pseudo_match_id | match_info | The current match’s ID code. Example: 0c0ea3df-97ea-4d3a-b1f6-f8e34042251f | This is an Overwolf-generated code, unrelated to Blizzard. | 159.0 |
map | match_info | Name of currently played map. | See notes | 151.0 |
map note
Important to note there are some values that are still unknown. Most of them are listed down here.
Possible map values:
- 0091 = "Temple Of Anubis"
- 0212 = "Kingdom Kings Row"
- 0357 = "Hanamura"
- 0388 = "Watchpoint Gibraltar"
- 0468 = "Numbani"
- 0475 = "Volskaya Industries"
- 0687 = "Hollywood"
- 0707 = "Dorado"
- 1207 = "Nepal"
- 1467 = "Route 66"
- 1633 = "Tutorial"
- 1634 = "Lijiang Tower"
- 1645 = "Ilios"
- 1672 = "Practice Range"
- 1677 = "Eichenwalde"
- 1694 = "Oasis"
- 1707 = "Hollywood Halloween"
- 1713 = "Kingdom Kings Row Winter"
- 1715 = "Estadio Das Ras"
- 1717 = "Hanamura Winter"
- 1719 = "Lijiang Tower Lunar New Year"
- 1735 = "Vpp Green Room"
- 1737 = "Junkensteins Revenge Halloween"
- 1745 = "Ecopoint Antarctica"
- 1747 = "Horizon Lunar Colony"
- 1797 = "Necropolis"
- 1804 = "Black Forest"
- 1805 = "Ecopoint Antarctica Winter"
- 1809 = "Lijiang Garden Lunar New Year"
- 1810 = "Lijiang Night Market Lunar New Year"
- 1815 = "Nepal Sanctum"
- 1818 = "Lijiang Control Center Lunar New Year"
- 1820 = "Castillo"
- 1846 = "Nepal Village"
- 1848 = "Nepal Shrine"
- 1850 = "Ilios Well"
- 1853 = "Ilios Lighthouse"
- 1854 = "Ilios Ruins"
- 1860 = "Lijiang Control Center"
- 1861 = "Lijiang Garden"
- 1862 = "Lijiang Night Market"
- 1866 = "Oasis City Center"
- 1868 = "Oasis Gardens"
- 1869 = "Oasis University"
- 1878 = "Junkertown"
- 1886 = "Blizzard World"
- 1939 = "Sydney Harbour Arena"
- 1953 = "Ayutthaya"
- 1956 = "Chateau Guillard"
- 2018 = "Busan"
- 2036 = "Eichenwalde Halloween"
- 2039 = "Black Forest Winter"
- 2045 = "Nepal Village Winter"
- 2102 = "Chateau Guillard Halloween"
- 2161 = "Rialto"
- 2192 = "Petra"
- 2193 = "Paris"
- 2346 = "Busan Stadium"
- 2628 = "Havana"
- 2651 = "Blizzard World Winter"
- 2682 = "Busan Sanctuary Lunar New Year"
- 2694 = "Busan Downtown Lunar New Year"
- 3136 = "Workshop Island"
- 3140 = "Workshop Expanse"
- 3144 = "Workshop Chamber"
- 3280 = "Workshop Expanse Night"
- 3281 = "Workshop Island Night"
Data Example:
{"info":{"match_info":{"map":"357"}},"feature":"match_info"}
Note that on the response the leading zeros are removed ("0030" => "30")
Events
Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
---|---|---|---|---|
match_start | null | Match started. | See notes | 150.0 |
match_end | null | Match ended. | See notes | 150.0 |
match_start note
Data Example:
{"name":"match_start","data":""}
match_end note
Data Example:
{"name":"match_end","data":""}
kill
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
eliminations | kill | Total amount of eliminations. | See notes | 151.0 |
objective_kills | kill | Total amount of objective kills. | See notes | 151.0 |
eliminations note
Data Example:
{"info":{"kill":{"eliminations":"6"}},"feature":"kill"}
objective_kills note
Data Example:
{"info":{"kill":{"objective_kills":"2"}},"feature":"kill"}
Events
Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
---|---|---|---|---|
elimination | Integer | Elimination is performed. | See notes | 150.0 |
objective_kill | Integer | Objective kill is performed.. | See notes | 150.0 |
elimination note
The event includes the total amount performed in the match.
Data Example:
{"name":"elimination","data":"8"}
objective_kill note
The event includes the total amount performed in the match.
Data Example:
{"name":"objective_kill","data":"3"}
death
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
deaths | death | Total amount of deaths. | See notes | 151.0 |
death note
Data Example:
{"info":{"death":{"deaths":"5"}},"feature":"death"}
Events
Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
---|---|---|---|---|
death | Integer | Death has occurred. | See notes | 150.0 |
death note
The event includes the total amount performed in the match.
Data Example:
{"name":"death","data":"2"}