Loading...

Game events API

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.

Sample Apps

• OVERWATCH 2 game events sample app

Available Features

• gep_internal
• game_info
• match_info
• kill
• assist
• death
• roster

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	229.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	The current state of the game.	See notes	229.0
game_mode	game_info	Currently played game-mode.	See notes	229.0
battle_tag	game_info	Player's battelnet tag	See notes	229.2
game_type	match_info	The type of the current played game	See notes	252.0
game_queue_type	match_info	The type of the current queue	See notes	256.1
party_player_count	game_info	Count how many players are in the party	See notes	261.0

game_state note:

List of possible values:

• loading_screen_start
• game_loaded
• match_in_progress
• match_ended
• role_select_screen_start
• role_select_screen_end

Data Example:

{"info":{"game_info":{"game_state":"loading_screen_start"}},"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"
• 224 = "Clash"
• 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"
• 0066 = "Story Missions"
• 0067 = "Storm Rising"
• 0074 = "Survivor"
• 0089 = "Snowball Deathmatch"
• 0109 = "Flashpoint"
• 0090 = "Practice Range"
• 0112 = "Bounty Hunter"
• 0165 = "Hero Mastery - Solo"
• 0186 = "Hero Mastery CO-OP"

Data Example:

{"info":{"game_info":{"game_mode":"16"}},"feature":"game_info"}

Note that on the response the leading zeros are removed ("0030" => "30")

battle_tag note

Data Example:

{"feature":"game_info","category":"game_info","key":"battle_tag","value":"OverTheTop#2100"}

game_type note:

List of possible values:

• UNKNOWN
• UNRANKED
• CUSTOM_GAME
• PRACTICE
• ARCADE
• TUTORIAL
• SKIRMISH
• VS_AI
• DEATHMATCH
• RANKED
• HERO_MASTERY
• HERO_MASTERY_SOLO

Data Example:

{"feature":"game_info","category":"match_info","key":"game_type","value":"SKIRMISH"}

game_queue_type note:

possible game_queue_type values:

• OPEN_QUEUE
• ROLE_QUEUE

Data Example:

{"feature":"game_info","category":"match_info","key":"game_queue_type","value":"OPEN_QUEUE"}

party_player_count note:

Data Example:

{"feature": "game_info", "category": "game_info", "key": "party_player_count", "data": "2"}

match_info

Info Updates

key	Category	Values	Notes	Since Version
map	match_info	Name of currently played map.	See notes	229.0
pseudo_match_id	match_info	Unique mtch_id	See notes	237.0
match_outcome	match_info	Outcome of the current match	See notes	250.1

map note

Important to note some values that are still unknown. Most of them are listed down here.

Possible map values:

• 3314 = "Antarc Pebibsula"
• 2018 = "Busan"
• 1645 = "Ilios"
• 1634 = "Lijiang Tower"
• 1719 = "Lijiang Tower Lunar New Year"
• 1207 = "Nepal"
• 1694 = "Oasis"
• 2087 = "Circuit Royal"
• 707 = "Dorado"
• 2628 = "Havana"
• 1878 = "Junkertown"
• 2161 = "Rialto"
• 1467 = "Route 66"
• 3205 = "Shambali Monastery"
• 388 = "Watchpoint Gibraltar"
• 1886 = "Blizzard World"
• 2651 = "Blizzard World Winter"
• 1677 = "Eichenwalde"
• 2036 = "Eichenwalde Halloween"
• 687 = "Hollywood"
• 1707 = "Hollywood Halloween"
• 212 = "Kings Row"
• 1713 = "Kings Row Winter"
• 2892 = "Midtown"
• 468 = "Numbani"
• 2360 = "Paraiso"
• 2868 = "Coloesseo"
• 3411 = "Esperanca"
• 2795 = "New Queen Street"
• 3603 = "New Junk City"
• 3390 = "Suravasa"
• 3762 = "Runasapi"
• 4439 = "Hanaoka"
• 4448 = "Throne of Anubis"
• 3776 = "Samoa"

Data Example:

{"info":{"match_info":{"map":"3603"}},"feature":"match_info"}

Note that in the response the leading zeros are removed ("0030" => "30")

pseudo_match_id note

This is an Overwolf-generated code, unrelated to the game.

Data Example:

{"info":{"match_info":{"pseudo_match_id":"5a7e3729-993c-414d-8e3f-592faeef81e7"}},"feature":"match_info"}

match_outcome note

Possible values:

• victory
• defeat

Data Example:

{"info":{"match_info":{"match_outcome":"victory"}},"feature":"match_info"}

Events

Event	Event Data	Fired When (announcement)	Notes	Since GEP Ver.
match_start	null	Match started.	See notes	229.0
match_end	null	Match ended.	See notes	229.0
round_start	null	Round started.	See notes	252.0
round_end	null	Round ended.	See notes	252.0
respawn	null	The local player respawn.	See notes	258.0
revive	null	The local player revive.	See notes	258.0

match_start note

Data Example:

{"name":"match_start","data":""}

match_end note

Data Example:

{"name":"match_end","data":""}

round_start note

Data Example:

{"name":"round_start","data":""}

round_end note

Data Example:

{"name":"round_end","data":""}

respawn note

Data Example:

{"name":"respawn","data":null}

revive note

Data Example:

{"name":"revive","data":null}

kill

Info Updates

key	Category	Values	Notes	Since GEP Ver.
eliminations	kill	Total amount of eliminations.	See notes	229.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	229.0

elimination note

The event includes the total amount of eliminations performed in the match.

Data Example:

{"name":"elimination","data":"8"}

death

Info Updates

key	Category	Values	Notes	Since GEP Ver.
deaths	death	Total amount of deaths.	See notes	229.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	229.0

death note

The event includes the total amount of deaths performed in the match.

Data Example:

{"name":"death","data":"2"}

assist

Info Updates

key	Category	Values	Notes	Since GEP Ver.
assists	death	Total amount of assists.	See notes	229.0

assist note

Data Example:

{"info":{"assist":{"assist":"5"}},"feature":"assist"}

Events

Event	Event Data	Fired When (announcement)	Notes	Since GEP Ver.
assist	Integer	Assist has occurred.	See notes	229.0

assist note

The event includes the total amount of assists performed in the match.

Data Example:

{"name":"assist","data":"2"}

roster

Info Updates

key	Category	Values	Notes	Since GEP Ver.
roster_XX	roster	Data about the roter	See [notes](#roster_XX -note)	249.0

*roster_XX * note

List of values:

• player_name - the player's full name
• battlenet_tag - the battle net tag
• is_local - is the player the local player true/false
• is_teammate - is the player one of your teammates true/false
• hero_name - the name of the selected hero
• hero_role - the role of the selected hero
• team - the player's team 0/1
• kills / deaths / assists - the total number of kills/deaths/assists
• damage - the total damage
• healed - the total healed
• mitigated - the total mitigated

caution

As for version 249.1.0 hero_name and hero_role will be available for the local player team only We will add them to the other team in the next GEP release

Data Example:

{"feature":"roster","category":"roster","key":"roster_0","value":"{\"player_name\":\"EDGED217\",\"battlenet_tag\":\"EDGED217#2842\",\"is_local\":false,\"is_teammate\":true,\"hero_name\":\"MOIRA\",\"hero_role\":\"SUPPORT\",\"team\":0,\"kills\":4,\"deaths\":0,\"damage\":462.16,\"assists\":0,\"healed\":274.866,\"mitigated\":0}"}

Events status

Loading...