Loading...

Game events API

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

Sample Apps

• Arknights Endfield game events sample app

Available Features

• gep_internal
• match_info
• location

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	137.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.
character_name	character_info	Local player's current character name	See notes	301.0

character_name note

Data Example:

{"info":{"character_info":{"character_name":"endminf"}},"feature":"game_info"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start		In the beginning of each match	See notes	301.0
match_end		At the end of each match	See notes	301.0
character_switch		When the player switch the character	See notes	301.0

match_start note

Data Example:

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

match_end note

Data Example:

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

character_switch note

Data Example:

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

location

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
location	Current player location on the map	When the player moves	See notes	301.0

location note

Data Example:

{"gameId":27724,"feature":"location","key":"location","value":"{\"x\":-141.363617,\"y\":-345.465027,\"z\":98.102760}"}

Events status

Loading...