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

gep_internal note​

Data Example:

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

match_info​

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullA match starts.See notes318.0
match_endnullA match ends.See notes318.0
respawnnullThe local player respawns.See notes318.0
deathNumber of deathsThe local player dies.See notes318.0
killerKiller's nameThe local player is killed by another player.See notes318.0
killVictim's nameThe local player kills another player.See notes318.0
reviveReviver's nameThe local player is revived by a teammate.See notes318.0
damage_receivedDamage amountThe local player receives damage.See notes318.0
control_zone_pointsPointsThe local player's team scores control zone points.See notes318.0

match_start note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"match_start","value":null}

match_end note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"match_end","value":null}

respawn note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"respawn","value":null}

death note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"death","value":"1"}

killer note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"killer","value":"RoDniK"}

kill note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"kill","value":"Rodnik92"}

revive note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"revive","value":"RoDniK"}

damage_received note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"damage_received","value":"100"}

control_zone_points note​

Data Example:

{"gameId":28196,"feature":"match_info","key":"control_zone_points","value":"1"}

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
match_idmatch_infoThe unique ID of the current match.See notes318.0
match_modematch_infoThe current match mode.See notes318.0
map_namematch_infoThe name of the current map.See notes318.0
cashmatch_infoThe local player's cash summary.See notes318.0
xpmatch_infoThe local player's XP per class.See notes318.0

match_id note​

Data Example:

{"gameId":28196,"feature":"match_info","category":"match_info","key":"match_id","value":"f40552f7-130c-44f9-93c1-ee8898400898"}

match_mode note​

Data Example:

{"gameId":28196,"feature":"match_info","category":"match_info","key":"match_mode","value":"KOTH"}

map_name note​

Data Example:

{"gameId":28196,"feature":"match_info","category":"match_info","key":"map_name","value":"SABATULA"}

cash note​

List of parameters:

  • total
  • earned
  • earned_current_life
  • eom
  • eom_faction_place_bonus
  • eom_faction_win_bonus
  • eom_match_completion_bonus
  • eom_refund
  • profit
  • profit_current_life
  • spent
  • spent_current_life

Data Example:

{"gameId":28196,"feature":"match_info","category":"match_info","key":"cash","data":"{\"total\":18448,\"earned\":0,\"earned_current_life\":0,\"eom\":0,\"eom_faction_place_bonus\":0,\"eom_faction_win_bonus\":0,\"eom_match_completion_bonus\":0,\"eom_refund\":0,\"profit\":0,\"profit_current_life\":0,\"spent\":0,\"spent_current_life\":0}"}

xp note​

List of parameters:

  • level
  • driver
  • infantry
  • medic
  • pilot
  • recon
  • support

Data Example:

{"gameId":28196,"feature":"match_info","category":"match_info","key":"xp","data":"{\"level\":0,\"driver\":0,\"infantry\":1225,\"medic\":462,\"pilot\":1466,\"recon\":0,\"support\":0}"}

location​

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
locationPlayer's x, y, z coordinatesThe local player's location changes.See notes318.0

location note​

Data Example:

{"gameId":28196,"feature":"location","key":"location","value":"{\"x\":-904.22,\"y\":-2307.67,\"z\":93.23}"}