Skip to main content
Loading...

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

trusted mode

When running this game in trusted mode (without any launch parameters), OW can't go into an "exclusive mode" once the game is in a fullscreen state. This means - there is no way to interact with your OW app window when this issue occurs. Read our Exclusive Mode guide to understand how to get a relevant indications for this unique state, so you'll be able to notify the user / change the app flow accordingly if needed.

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. Alternately, 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":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}

live_data

Info Updates

keyCategoryValuesNotesSince GEP Ver.
providerlive_dataIn-game data received by the client.See notes237.0
playerlive_dataIn-game data received by the client.See notes237.0

provider note

Click to see some data example
 {
"provider": {
"name": "Counter-Strike: Global Offensive",
"appid": 730,
"version": 13985,
"steamid": "76561199232414254",
"timestamp": 1706188414
},
"map": {
"mode": "casual",
"name": "de_dust2",
"phase": "live",
"round": 1,
"team_ct": {
"score": 0,
"consecutive_round_losses": 1,
"timeouts_remaining": 1,
"matches_won_this_series": 0
},
"team_t": {
"score": 1,
"consecutive_round_losses": 0,
"timeouts_remaining": 1,
"matches_won_this_series": 0
},
"num_matches_to_win_series": 0
},
"round": {
"phase": "over",
"win_team": "T"
},
"player": {
"steamid": "76561199232414254",
"name": "JacksAtWork",
"observer_slot": 7,
"team": "CT",
"activity": "playing",
"weapons": {}
},
"previously": {
"map": {
"round": 0,
"team_ct": {
"consecutive_round_losses": 0
},
"team_t": {
"score": 0
}
},
"round": {
"phase": "live",
"bomb": "planted"
},
"player": {
"weapons": {
"weapon_0": {
"name": "weapon_knife",
"paintkit": "default",
"type": "Knife",
"state": "holstered"
},
"weapon_1": {
"name": "weapon_fiveseven",
"paintkit": "default",
"type": "Pistol",
"ammo_clip": 20,
"ammo_clip_max": 20,
"ammo_reserve": 100,
"state": "active"
}
}
}
},
"added": {
"round": {
"win_team": true
}
}
}

player note

Click to see some data example
{
"player": {
"state": {
"health": 100,
"armor": 0,
"helmet": false,
"flashed": 0,
"smoked": 0,
"burning": 0,
"money": 10000,
"round_kills": 0,
"round_killhs": 0,
"equip_value": 5800
},
"match_stats": {
"kills": 0,
"assists": 0,
"deaths": 0,
"mvps": 0,
"score": 0
},
"steamid": "7656119923158",
"name": "Naco",
"activity": "playing"
},
"provider": {
"name": "Counter-Strike: Global Offensive",
"appid": 730,
"version": 13960,
"steamid": "7656119923158",
"timestamp": 1697027750
}
}

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
roster_match_infoData about all the players in the rosterSee notes236.0
game_modematch_infoThe current played game mode and the map nameSee notes236.0
match_outcomematch_infovictory / defeat / tieSee notes236.0
steam_idlive_datalocal player steam IdSee notes237.0
game_phaselive_datalist of phases during a gameSee notes237.0
round_phaselive_datalist of phases during a roundSee notes237.0
scorelive_datascore in the game for team T and team CTSee notes237.0
mode_namelive_dataThe name of the played modeSee notes237.0
map_namelive_dataThe name of the played mapSee notes237.0
killslive_dataAmount of kills performed by the local playerSee notes237.0
deathslive_dataAmount of deaths by the local playerSee notes237.0
assistslive_dataAmount of assists performed by the local playerSee notes237.0
elo_pointsmatch_infoThe amount of ELO points the local player will gain or lose in premier modeSee notes237.0
pseudo_match_idmatch_infoUniques mtch_idSee notes237.0
round_numberlive_dataThe current round numberSee notes237.0
is_rankedmatch_infoFlag if the game is ranked or notSee notes239.0

roster note

List of possible values:

  • nickname - The nickname of the player
  • steamid - The player's steam Id
  • money - current money owned by the player
  • kills - current player's kills
  • assists - current player's assists
  • deaths - current player's deaths
  • mvps - current player's mvps number
  • score - current player's score
  • is_local - If the player is the local player the value will be true, if not it will be false
  • ping - the ping of the player
  • hs - headshots in %
  • color - the color of the player in the roster
  • damage - current player's damage, updates at the end of the round (only available in premier and competitive mode)
  • rank - player's rank - In premier mode, the value will be the player's MMR and will be displayed for all players in the match. In wingman the value will be between 1 and 18 with 1 being Silver 1 and 18 being Global Elite, and will only be displayed for the local player and party members.

Data example:

{"feature":"match_info","category":"match_info","key":"roster_1","value":"{\"nickname\":\"Naco\",\"steamid\":\"76561199123132960\",\"team\":\"T\",\"money\":6650,\"kills\":5,\"assists\":0,\"deaths\":1,\"mvps\":1,\"score\":10,\"damage\":500,\"hs\":100,\"is_local\":\"true\",\"color\":\"blue\",\"ping\":62,\"rank\":7650}"}

game_mode note

Data examples:

Competitive mode on "Dust II" map

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Competitive Dust II"}

VS BOTS on "Dust II" map

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Offline Deathmatch Dust II"}

Community Server, "Causal" mode and server name

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Community Casual surf_ski_2_GO_sw"}

"Casual" mode on "Dust II" map

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Casual Dust II"}

Spectating "Casual" mode on "Dust II" map

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Dust II"}

match_outcome note

Data Example:

{"info":{"match_info":{"match_outcome":"victory"}},"feature":"match_info"}
{"info":{"match_info":{"match_outcome":"defeat"}},"feature":"match_info"}

steam_id note

Data Example:

{"info":{"live_data":{"steam_id":"76561199899040908"}},"feature":"match_info"}

game_phase note

List of possible values:

  • live
  • warmup
  • gameover
  • intermission

Data Example:

{"info":{"live_data":{"game_phase":"live"}},"feature":"match_info"}

round_phase note

List of possible values:

  • live
  • freezetime
  • over

Data Example:

{"info":{"live_data":{"round_phase":"live"}},"feature":"match_info"}

score note

Data Example:

{"info":{"live_data":{"score":"{\"team_t\":0,\"team_ct\":2}"}},"feature":"match_info"}

mode_name note

Data Example:

{"info":{"live_data":{"mode_name":"deathmatch"}},"feature":"match_info"}

map_name note

Data Example:

{"info":{"live_data":{"map_name":"de_dust2"}},"feature":"match_info"}

kills note

Data Example:

{"info":{"live_data":{"kills":10}},"feature":"match_info"}

deaths note

Data Example:

{"info":{"live_data":{"deaths":5}},"feature":"match_info"}

assists note

Data Example:

{"info":{"live_data":{"assists":1}},"feature":"match_info"}

elo_points note

Data Example:

{"info":{"match_info":{"elo_points":"{\"lose\":136,\"win\":364}"}},"feature":"match_info"}

pseudo_match_id note

This is an Overwolf-generated code, unrelated to the game.

Data Example:

{"info":{"match_info":{"pseudo_match_id":"5a7e3729-993c-414d-8e3f-592faeef81e7"}},"feature":"match_info"}

round_number note

Data Example:

{"info":{"live_data":{"round_number":2}},"feature":"match_info"}

is_ranked note

In game modes "premier", "competitive" and "wingman" the value will be true.

Data Example:

{"info":{"match_info":{"is_ranked":true}},"feature":"match_info"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startIn the beginning of each matchSee notes228.0
match_endAt the end of each matchSee notes228.0
killtotal killsWhen the player kill another playerSee notes235.0
deathtotal deathsWhen the player diesSee notes235.0
assisttotal assistsWhen the player assist a team member to kill an enemySee notes235.0
kill_feedKills & assists informationAnytime a player dies in match.See notes236.0
round_startIn the beginning of each roundSee notes237.0
round_endAt the end of each roundSee notes237.0

match_start note

Data Example:

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

match_end note

Data Example:

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

kill note

Data Example:

{"events":[{"name":"kill","data":2}]}

death note

Data Example:

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

assist note

Data Example:

{"events":[{"name":"assist","data":2}]}

kill_feed note

List of possible values:

  • attacker - attacker name
  • assister - assister name
  • victim - victim name
  • weapon - used weapon name
  • list of metadata with true / false data
    • headshot
    • suicide
    • wallbang
    • flashed
    • throughsmoke
    • noscope
    • domination
    • revenge

Data Example:

{\"attacker\":\"BOT Efe\",\"assister\":\"\",\"weapon\":\"m4a1_silencer\",\"headshot\":false,\"suicide\":false,\"wallbang\":false,\"revenge\":false,\"domination\":false,\"noscope\":false,\"throughsmoke\":false,\"flashed\":false,\"victim\":\"BOT Yanni\"}

round_start note

Data Example:

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

round_end note

Data Example:

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