Loading...

Game events API

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

Sample Apps

• Marvel Rivals game events sample app

Available Features

• gep_internal
• match_info
• game_info

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event status from your app using our API.

gep_internal

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
roster_xx	match_info	A full roster with data during the match.	See notes	269.0
match_id	match_info	The match ID of the current match.	See notes	269.0
game_type	match_info	The current game type.	See notes	269.0
game_mode	match_info	The current game mode.	See notes	269.0
map	match_info	The current played map.	See notes	269.0
player_stats	match_info	Local player's statistics during the match.	See notes	269.0
match_outcome	match_info	Outcome of the current match	See notes	272.0

roster_xx note

note

The roster index number will change dynamically between 0-11. To keep track of each player, use the UID number or name parameters.

List of parameters:

• name - player name
• uid - User ID
• character_name - character name
• character_id - character ID
• team - team number
• is_teammate - is the player one of your teammates true/false
• kills - number of kills
• deaths - number of deaths
• assists - number of assists
• ult_charge - the player's current ultimate ability charge percent (teammates only)
• is_local - if the player is the local player this paramaters is true

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_5","value":"{\"uid\":\"1380486120\",\"name\":\"OverWolf\",\"character_id\":\"1015\",\"team\":1,\"kills\":3,\"deaths\":0,\"assists\":5,\"ult_charge\":43,\"is_teammate\":true,\"is_local\":true,\"character_name\":\"STORM\"}"}

match_id note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "match_id", "data": "5664983_1735659917_267_11001_50"}

game_type note

Possible values:

• Practice
• Quick match
• Competitive
• Arcade

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"game_type","value":"Practice"}

game_mode note

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Practice range"}

map note

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"map","value":"Hall of djaalia"}

player_stats note

Data Example:

{"feature":"match_info","category":"match_info","key":"player_stats","value":"{\"damage_dealt\":80,\"damage_block\":84,\"total_heal\":0}"}

match_outcome note

Possible values:

• Victory
• Defeat
• Draw

Data Example:

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

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	The match started	See notes	269.0
match_end	null	The match ended	See notes	269.0
round_start	null	Round started.	See notes	271.0
round_end	null	Round ended.	See notes	271.0
death	The total number of deaths	The player is dead	See notes	269.0
kill	The total number of kills	The player killed another player	See notes	269.0
assist	The total number of assists	The player assisted another player	See notes	269.0
kill_feed	The name of the attacker and victim	Anytime a player dies in the match.	See notes	269.0

match_start note

Data Example:

{"events":[{"name":"match_start","data":""}]}

match_end note

Data Example:

{"events":[{"name":"match_end","data":""}]}

round_start note

Data Example:

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

round_end note

Data Example:

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

death note

Data Example:

{"events":[{"name":"death","data":3}]}

kill note

Data Example:

{"events":[{"name":"kill","data":4}]}

assist note

Data Example:

{"events":[{"name":"assist","data":1}]}

kill_feed note

Data Example:

["events": {"name": "kill_feed","data": "{\"attacker\":\"Overwolf\",\"victim\":\"Underwolf}"}]

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The name of the current scene.	See notes	269.0
player_name	game_info	The local player name	See notes	269.0
player_id	game_info	the local player's ID	See notes	270.0

scene note

List of possible values:

• Lobby
• Ingame

Data Example:

{"info":{"game_info":{"scene":"Lobby"}},"feature":"game_info"}

player_name note

Data Example:

{"info":{"game_info":{"player_name":"Overwolf"}},"feature":"game_info"}

player_id note

Data Example:

{"info":{"game_info":{"player_id":"1380486120"}},"feature":"game_info"}

Events status

Loading...