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
• game_info
• 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"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The current game scene	See notes	312.0
server_info	game_info	The server the local player is connected to	See notes	312.0
player_name	game_info	Local player's name	See notes	312.0

scene note

Data Example:

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

server_info note

Data Example:

{"info":{"game_info":{"server_info":"Americas / Europe"}},"feature":"game_info"}

player_name note

Data Example:

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

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
squad	character_info	The player's active squad, and the index of the currently controlled character	See notes	312.0
roster	character_info	Full details of every character owned by the player	See notes	312.0
area	location_info	The player's current area, region and sub-region	See notes	312.0
game_mode	match_info	The current game mode	See notes	312.0
player_level	match_info	Local player's level	See notes	312.0
world_level	match_info	The current world level	See notes	312.0

character_name note

Data Example:

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

squad note

Data Example:

{"info":{"character_info":{"squad":"{\"leaderIndex\":3,\"characters\":[{\"id\":\"chr_0003_endminf\",\"name\":\"Endministrator\"},{\"id\":\"chr_0004_pelica\",\"name\":\"Perlica\"},{\"id\":\"chr_0025_ardelia\",\"name\":\"Ardelia\"},{\"id\":\"chr_0005_chen\",\"name\":\"Chen Qianyu\"}]}"}},"feature":"match_info"}

roster note

Data Example:

{"info":{"character_info":{"roster":"{\"characters\":[{\"id\":\"chr_0025_ardelia\",\"name\":\"Ardelia\",\"charType\":\"Default\",\"tier\":6,\"level\":5,\"maxLevel\":20,\"eliteTier\":0,\"potential\":0,\"attributes\":{\"strength\":14,\"agility\":13,\"intellect\":35,\"will\":20,\"maxHp\":794,\"attack\":102},\"gear\":{\"weapon\":null,\"body\":null,\"hand\":null,\"kit1\":null,\"kit2\":null,\"tactical\":null},\"abilities\":{\"combat\":[{\"id\":\"chr_0025_ardelia_NormalAttack\",\"name\":\"Rocky Whispers\",\"level\":1,\"maxLevel\":1},{\"id\":\"chr_0025_ardelia_NormalSkill\",\"name\":\"Dolly Rush\",\"level\":1,\"maxLevel\":1},{\"id\":\"chr_0025_ardelia_UltimateSkill\",\"name\":\"Wooly Party\",\"level\":1,\"maxLevel\":1},{\"id\":\"chr_0025_ardelia_ComboSkill\",\"name\":\"Eruption Column\",\"level\":1,\"maxLevel\":1}],\"talents\":[{\"id\":\"passiveSkill0\",\"name\":\"Friendly Presence\",\"level\":1,\"maxLevel\":3}]}}]}"}},"feature":"match_info"}

area note

Data Example:

{"info":{"location_info":{"area":"{\"area\":\"The Hub\",\"region\":\"Valley IV\",\"sub_region\":\"Hub Base Power Plant\"}"}},"feature":"match_info"}

game_mode note

Data Example:

{"info":{"match_info":{"game_mode":"Default"}},"feature":"match_info"}

player_level note

Data Example:

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

world_level note

Data Example:

{"info":{"match_info":{"world_level":"1"}},"feature":"match_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
battle_start		When a battle starts	See notes	312.0
battle_end		When a battle ends	See notes	312.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}]}

battle_start note

Data Example:

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

battle_end note

Data Example:

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

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...