Loading...

Game events API

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

Sample Apps

• Deadlock game events sample app

Available Features

• gep_internal
• game_info
• match_info

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
items	match_info	list of every item purchased by the players in the match	See notes	267.0
incoming_damage	match_info	Damage recieve by the local player	See notes	305.0
match_outcome	match_info	The winning team of the match	See notes	310.2.8

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

List of parameters:

• player_name
• steam_id
• team_name
• is_local - true/false
• team_id
• hero_id
• level
• kills
• deaths
• assist
• hero_damage
• object_damage
• hero_healing
• assigned_lane
  • 1 - Left
  • 4 - middle
  • 6 - right
• ultimate_trained - true/false
• ultimate_ready - true/false
• health
• souls
• hero_name

Data Example:

{"feature": "match_info", "category": "match_info", "key": "roster_11", "data": "{\"player_name\":\"CaptainKerrero\\\"\\\"\",\"steam_id\":\"\",\"team_name\":\"Sapphire\",\"is_local\":true,\"team_id\":3,\"hero_id\":25,\"level\":1,\"kills\":0,\"deaths\":0,\"assist\":0,\"hero_damage\":194,\"object_damage\":0,\"hero_healing\":0,\"assigned_lane\":6,\"ultimate_trained\":false,\"ultimate_ready\":false,\"health\":336,\"souls\":741,\"hero_name\":\"WARDEN\"}"}

items note

List of parameters:

• player_name
• steam_id
• items
• id
• class_name
• name
• enhanced - true/false

Data Example:

{"feature": "match_info", "category": "match_info", "key": "items_3", "data": "{\"player_name\":\"Bot3\",\"steam_id\":\"0\",\"items\":[{\"id\":2010028405,\"class_name\":\"upgrade_headshot_booster\",\"name\":\"Headshot Booster\",\"enhanced\":false},{\"id\":7409189,\"class_name\":\"upgrade_soaring_spirit\",\"name\":\"Improved Spirit\",\"upgrade_info\":196609,\"enhanced\":true}]}"}

incoming_damage note

Only works when panel damage is open.

List of parameters:

• time_filter - the current filtered time on damage panel:
  • -1 - current life
  • 30 - 30 seconds
  • 60 - 60 seconds
  • 180 - 3 minutes
  • 300 - 5 minutes
  • 600 - 10 minutes
• total_damage - total damage received by the local player in the time filter:
• damages - a list of individual damage by enemies
  • damageby_neutrals - Damage by enemies minions and towers
  • damageby_hero_ - Damage by each enemy hero

Data Example:

{"feature":"match_info","category":"match_info","key":"incoming_damage","value":"{\"time_filter\": 30, \"total_damage\": 832, \"damages\": [{\"name\": \"damageby_neutrals\", \"int\": 42}, {\"name\": \"damageby_hero_punkgoat\", \"int\": 790}]}"}

match_outcome note

List of possible values:

• AMBER
• SAPPHIRE

Data Example:

{"feature":"match_info","category":"match_info","key":"match_outcome","data":"{\"winning_team\":\"SAPPHIRE\"}"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	In the beginning of each match	See notes	263.0
match_end	null	At the end of each match	See notes	263.0
kill	null	When the local player kill an enemy	See notes	266.0
death	null	When the local plyer died	See notes	266.0
assist	null	When the local player assist another player	See notes	266.0
match_clock	The exact time in local match	Every second ingame	See notes	305.0
game_paused	true/false	When the game is paused or unpaused	See notes	305.0
tower_destroyed	Amber/Sapphire	When a tower is destroyed	See notes	305.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}]}

match_clock note

Only works in deadlock mode

Data Example:

{"events":[{"name":"match_clock","data":"01:00"}]}

game_paused note

Only works in deadlock mode

Data Example:

{"events":[{"name":"game_paused","data":true}]}

tower_destroyed note

List of possible values:

• Amber
• Sapphire

Data Example:

{"events":[{"name":"tower_destroyed","data":"Amber"}]}

Events status

Loading...