Loading...

Game events API

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

Sample Apps

• Supervive 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

Info Updates

key	Category	Values	Notes	Since GEP Ver.
gep_internal	gep_internal	Local + Public version number	See notes	268.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"}

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	268.0

*roster_xx * note

List of parameters:

• name - player name
• character - character name
• team - team number
• kills - number of kills
• deaths - number of deaths
• assists - number of assists
• knocks - number of knocks
• is_local - if the player is the local player this paramaters is true

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_0","value":"{\"name\":\"Nano#888\",\"character\":\"BacklineHealer\",\"team\":4,\"kills\":1,\"deaths\":4,\"assists\":3,\"knocks\":1,\"is_local\":true}"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	The match started	See notes	268.0
match_end	null	The match ended	See notes	268.0
death	The total number of deaths	The player is dead	See notes	268.0
kill	The total number of kills	The player killed another player	See notes	268.0
assist	The total number of assists	The player assisted another player	See notes	268.0

match_start note

Data Example:

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

match_end note

Data Example:

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

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}]}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The name of the current scene.	See notes	268.0
player_name	game_info	The local player name + tag.	See notes	268.0

scene note

List of possible values:

• Lobby
• Battle Royale

Data Example:

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

player_name note

Data Example:

{"info":{"game_info":{"player_name":"Nano#888"}},"feature":"game_info"}

Events status

Loading...