Skip to main content

World of Warships

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

Sample Apps

Available Features

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

keyCategoryValuesNotesSince GEP Ver.
gep_internalgep_internalLocal + Public version numberSee notes143.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

keyCategoryValuesNotesSince GEP Ver.
game_start_timestampmatch_infoTime when the game process started runningSee notes119.1
scenematch_infoSee notes119.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

keyCategoryValuesNotesSince GEP Ver.
realmaccount_infoSee notes119.1
idaccount_infoLocal player’s Wargaming account IDSee notes119.1
playerNameaccount_infoLocal player’s Wargaming name119.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

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoCurrent match’s ID codeSee notes119.1

pseudo_match_id note

Data Example:

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

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mapNamematchMap name – stringSee notes119.1
playersrosterArray of “player” objectsSee notes119.1
healthshipThe current “health” of the user’s ship – intSee notes119.1
nameshipShip’s name – stringSee notes119.1
levelshipLevel of the player’s shipSee notes122.1
burningshipWhether the ship is burning or not (true / false)See notes122.1
floodingshipWhether the ship is flooding or notSee notes122.1
nationshipCurrent ship's nationSee notes122.1
statematchCheck notesSee notes119.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

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch startsSee notes119.1
matchEndnullMatch ends119.1
matchOutcome"victory" / "lost"Match ends119.1

matchStart note

Data Example:

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

kill

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killShip ID of the “victim” ship – intA ship was destroyed by the local userSee notes121.0
damage
  • amount – amount of damage done
  • shipId – int
A ship was damaged by the local userSee notes121.0
ribbonribbon – stringRibbon was awardedSee notes119.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

EventEvent DataFired WhenNotesSince GEP Ver.
deathShip ID of the “killer” ship – intPlayer's ship was destroyed119.1
hit
  • damage – amount -int
  • ship name – string
Player’s ship was damaged119.1