Loading...

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

Sample Apps

• WOWS game events sample app

Available Features

• gep_internal
• game_info
• account_info
• match
• match_info
• kill
• death

Game events status

It's highly recommended to communicate errors to your users. Check game event status here or easily verify event status straight 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	143.0

gep_internal note

Data Example:

{"feature":"gep_internal","category":"gep_internal","key":"version_info","value":"{"local_version":"143.0.10","public_version":"143.0.10","is_updated":true}"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
game_start_timestamp	match_info	Time when the game process started running	See notes	119.1
scene	match_info	See notes		119.1

game_start_timestamp note

Data Example:

"value":"2018-10-25T06:02:03.555Z"

scene note

Possible Values:

• Initializing
• Dock
• Battle
• Loading_screen
• Post_battle
• Result_screen

Data Example:

{"info":{"game_info":{"scene":"dock"}},"feature":"game_info"}
{"info":{"game_info":{"scene":"random_battle_queue"}},"feature":"game_info"}
{"info":{"game_info":{"scene":"loading_screen"}},"feature":"game_info"}

account_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
realm	account_info		See notes	119.1
id	account_info	Local player’s Wargaming account ID	See notes	119.1
playerName	account_info	Local player’s Wargaming name		119.1

realm note

Possible Values:

• RU
• EU
• NA
• Asia

Data Example:

{"info":{"account_info":{"realm":"eu"}},"feature":"account_info"}

id note

Data Example:

{"info":{"account_info":{"id":"536569483"}},"feature":"account_info"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
pseudo_match_id	match_info	Current match’s ID code	See notes	119.1

pseudo_match_id note

Data Example:

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f

match

Info Updates

key	Category	Values	Notes	Since GEP Ver.
mapName	match	Map name – string	See notes	119.1
players	roster	Array of “player” objects	See notes	119.1
health	ship	The current “health” of the user’s ship – int	See notes	119.1
name	ship	Ship’s name – string	See notes	119.1
level	ship	Level of the player’s ship	See notes	122.1
burning	ship	Whether the ship is burning or not (true/false)	See notes	122.1
flooding	ship	Whether the ship is flooding or not	See notes	122.1
nation	ship	Current ship's nation	See notes	122.1
state	match	Check notes	See notes	119.1

mapName note

Data Example:

{"feature":"match","category":"match","key":"mapName","value":"33_new_tierra"}

• An empty string will be set when there is no relevant map (e.g. while in the dock)
• On tutorial maps (e.g. “i01_tutorial”), some features might not work correctly (specifically death/kill)

players note

Each “player” contains the following data:

• shipId
• name – player name
• team – ally/enemy
• ship – ship name
• maxHealth – The ship’s max health

Data Example:

"[{"shipId":"1175724","name":":Wright:","team":"ally",
"ship":"PZSC101_Cheng_An","maxHealth":"4900"},
{"shipId":"1175726","name":":Buckmaster:","team":"ally",
"ship":"PJSC037_Hashidate_1940","maxHealth":"5150"},
...
{"shipId":"1175728","name":":Tovey:","team":"enemy",
"ship":"PASC001_Erie_1936","maxHealth":"4950"}]"

health note

Data Example:

{"feature":"match","category":"ship","key":"health","value":"4900"}

name note

Data Example:

{"feature":"match","category":"ship","key":"name","value":"PZSC101_Cheng_An"}

level note

Data Example:

{"feature":"match","category":"ship","key":"level","value":"1"}

burning note

Data Example:

{"feature":"match","category":"ship","key":"burning","value":false}

flooding note

Data Example:

{"feature":"match","category":"ship","key":"flooding","value":false}

nation note

Data Example:

{"feature":"match","category":"ship","key":"nation","value":"Pan_Asia"}

state note

Possible values:

• Running – match is active
• Empty string – match is not active

Data Example:

{"feature":"match","category":"match","key":"state","value":"running"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
matchStart	null	Match starts	See notes	119.1
matchEnd	null	Match ends		119.1
matchOutcome	"victory" / "lost"	Match ends		119.1

matchStart note

Data Example:

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

kill

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
kill	Ship ID of the “victim” ship – int	A ship was destroyed by the local user	See notes	121.0
damage	amount – amount of damage done shipId – int	A ship was damaged by the local user	See notes	121.0
ribbon	ribbon – string	Ribbon was awarded	See notes	119.1

kill note

Data Example:

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

damage note

{"events":[{"name":"damage","data":"{"amount":115,"shipId":"351794) (name=:Halgan:"}"}]}

ribbon note

Data Example:

{"events":[{"name":"ribbon","data":"RIBBON_CRIT"}]}
{"events":[{"name":"ribbon","data":"RIBBON_BURN"}]}
{"events":[{"name":"ribbon","data":"RIBBON_FRAG"}]}

death

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
death	Ship ID of the “killer” ship – int	Player's ship was destroyed		119.1
hit	damage – amount -int ship name – string	Player’s ship was damaged		119.1