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

gep_internal note

Data Example:

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

game_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
player_namegame_infoThe local player's nameSee notes282.0
scenegame_infoDifferent scenes during the gameSee notes282.0
party_playersgame_infoA list of players that joined the partySee notes282.0
game_modegame_infoThe current game modeSee notes282.0

player_name note

Data Example:

{"feature":"game_info","category":"game_info","key":"player_name","value":"Stungaxi"}

scene note

Possible values:

  • main_menu
  • airport
  • ingame

Data Example:

{"feature":"game_info","category":"game_info","key":"scene","value":"main_menu"}

party_players note

Data Example:

{"feature":"game_info","category":"game_info","key":"party_players","value":"["Captain a","OverTheTop"]"}

game_mode note

Possible values:

  • offline
  • host

Data Example:

{"feature":"game_info","category":"game_info","key":"game_mode","value":"offline"}

match_info

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullAt the beginning of the gameSee notes282.0
match_endnullAt the end of the gameSee notes282.0
deathnullWhen the local player diesSee notes282.0
teammate_deathThe name of the playerWhen a teammate diesSee notes282.0
checkpointnullWhen the local player lights a campfireSee notes282.0

match_start note

Data Example:

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

match_end note

Data Example:

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

death note

Data Example:

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

teammate_death note

Data Example:

{"events":[{"name":"teammate_death","data":"Captain a"}]}

checkpoint note

Data Example:

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