Skip to main content
Loading...

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

Sample Apps

Available Features

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

keyCategoryValuesNotesSince GEP Ver.
gep_internalgep_internalLocal + Public version numberSee notes263.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"260.0.0","is_updated":true}"}},"feature":"gep_internal"}

game_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe current phase during the gameSee notes263.0
game_modegame_infoThe current played game modeSee notes263.0
match_historygame_infoList of ID's of all the local player previous matchesSee notes263.0
steam_idgame_infoThe local player's Steam IDSee notes263.0

phase note

Possible phase values:

  • Init
  • WaitingForPlayersToJoin
  • PreGameWait
  • GameInProgress
  • PostGame

Data Example:

{"feature":"game_info","category":"game_info","key":"phase","value":"Init"}

game_mode note

Data Example:

{"feature":"game_info","category":"game_info","key":"game_mode","value":"{\"match_mode\":\"Unranked\",\"game_mode\":\"Normal\"}"}

match_history note

List of parameters:

  • match_id
  • hero_id
  • hero_name
  • kills
  • deaths
  • assists

Data Example:

{"feature":"game_info","category":"game_info","key":"match_history","value":"[{\"match_id\":\"19172158\",\"hero_id\":\"1\",\"kills\":2,\"deaths\":11,\"assists\":2,\"hero_name\":\"INFERNUS\"},{\"match_id\":\"19175987\",\"hero_id\":\"4\",\"kills\":0,\"deaths\":10,\"assists\":1,\"hero_name\":\"LADY GEIST\"},{\"match_id\":\"24145672\",\"hero_id\":\"31\",\"kills\":0,\"deaths\":1,\"assists\":4,\"hero_name\":\"LASH\"},{\"match_id\":\"24146361\",\"hero_id\":\"8\",\"kills\":0,\"deaths\":2,\"assists\":0,\"hero_name\":\"MCGINNIS\"}]"}

steam_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"steam_id","value":"765611912345582960"}

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
team_scorematch_infoUpdated team score of the current match for each teamSee notes263.0
match_idmatch_infoID of the current matchSee notes263.0
rostermatch_infoFull roster deails during the matchSee notes263.0

team_score note

Data Example:

{"feature":"match_info","category":"match_info","key":"team_score","value":"{\"amber\": \"6\" , \"sapphire\" : \"0\"}"}

match_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"match_id","value":"25735575"}

roster note

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_0","value":"{\"player_name\":\"MrTesting\",\"steam_id\":76561151141339179,\"team_name\":\"Amber\",\"is_local\":true,\"team_id\":2,\"hero_id\":10,\"level\":1,\"kills\":0,\"deaths\":0,\"assist\":0,\"hero_damage\":0,\"object_damage\":0,\"hero_healing\":0,\"health\":550,\"souls\":124,\"hero_name\":\"PARADOX\"}"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnulllIn the beginning of each matchSee notes263.0
match_endnulllAt the end of each matchSee notes263.0
killnulllWhen the local player kill an enemySee notes266.0
deathnulllWhen the local plyer diedSee notes266.0
assistnulllWhen the local player assist another playerSee notes266.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}]}