Loading...

Game events API

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

Sample Apps

• Spectre Divide 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	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.
scene	game_info	The name of the current scene.	See notes	260.0

scene note

Data Example:

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

List of possible values:

• MainMenu
• SponsorSelect
• the current map name - for example Metro_P

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
map	match_info	The current map played	See notes	210.0
kills	match_info	Total number of kills during the match	See notes	260.0
deaths	match_info	Total number of deaths during the match	See notes	260.0
assists	match_info	Total number of assists during the match	See notes	260.0

map note

Data Example:

{"feature":"match_info","category":"match_info","key":"map","value":"Metro"}

kills note

Data Example:

{"info":{"match_info":{"kills":"1"}},"feature":"match_info"}

deaths note

Data Example:

{"info":{"match_info":{"deaths":"2"}},"feature":"match_info"}

assists note

Data Example:

{"info":{"match_info":{"assists":"5"}},"feature":"match_info"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	When loading into a map.	See notes	260.0
match_end	null	When disconnecting from map.	See notes	260.0
kill	null	The local player killed another player	See notes	260.0
death	null	The local player is dead.	See notes	260.0
assist	null	The local player assist another player.	See notes	260.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"}]}

Events status

Loading...