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 notes277.0
player_idgame_infoThe local player's idSee notes277.0

player_name note

Data Example:

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

player_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"player_id","value":"7656119235655409266"}

match_info

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullIn the beginning of the gameSee notes277.0
match_endnullAt the end of the gameSee notes277.0
sleep_startnullWhen the local player starts sleepingSee notes277.0
sleep_endnullWhen the local player wakesupSee notes277.0

Info Updates

keyCategoryValuesNotesSince GEP Ver.
player_rankgame_infoThe local player's rank name + curent value + total valueSee notes277.0
pursuit_levelgame_infoThe current pursuit levelSee notes277.0

match_start note

Data Example:

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

match_end note

Data Example:

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

sleep_start note

Data Example:

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

sleep_end note

Data Example:

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

player_rank note

Data Example:

{"feature":"match_info","category":"match_info","key":"player_rank","value":"{\"name\":\"Street Rat III\",\"value\":95,\"total\":170}"}

pursuit_level note

Possible values:

  • regular - by deafult
  • body_search
  • escalating
  • arresting
  • arrested

Data Example:

{"feature":"match_info","category":"match_info","key":"pursuit_level","value":"regular"}