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 events status​

It's highly recommended to communicate errors and warnings to your app users. Check game event status here or easily check game event status directly from your app 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"}

game_info​

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe current game scene/phase.See notes123.0
steam_idgame_infoThe local player steam ID.See notes256.0

phase notes​

Possible values:

  • lobby
  • teammates
  • announce
  • variation_setup
  • operator_select
  • loading
  • round_results

Example:

{"info":{"game_info":{"phase":"lobby"}},"feature":"game_info"}

steam_id note​

Data Example:

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

match_info​

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoThe current match’s ID code.See notes130.0
game_modematch_infoThe current type of game mode.See notes for possible values228.1
match_idmatch_infoThe current match's ID.See notes for possible values162.1
map_idmatch_infoThe currently played map.See notes for possible values162.1
round_outcome_typematch_infoThe type of win/loss of the last-played round.See notes for possible values165.0

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullWhen a match start.See notes211.0
match_endnullWhen a match ends.See notes211.0
kill_feedKill feed dataWhen a kill feed entry is reported.See notes312.0

pseudo_match_id note​

This is an internal Overwolf-generated code.

Data Example:

{"info":{"match_info":{"pseudo_match_id":"9800ba24-7da7-4e3a-8ab1-a74405780444"}},"feature":"match_info"}

game_mode note​

Data Example:

{"feature": "match_info", "category": "match_info", "key": "game_mode", "data": "{\"playlist\": \"QUICK MATCH\" , \"game_type\": \"ESSENTIALS\" , \"mode_name\" : \"BOMB\"}"}

Possible values for playlist

  • QUICK MATCH
  • DUAL FRONT
  • UNRANKED
  • RANKED
  • DEATHMATCH
  • TUTORIAL
  • SHOOTING RANGE
  • LANDMARK DRILL
  • CLEAR HOUSE
  • FIELD TRAINING
  • CUSTOM

Possible values for game_type

  • ESSENTIALS
  • TRAINING

Possible values for mode_name

  • BOMB
  • SECURE AREA
  • HOSTAGE
  • DUAL FRONT
  • FREE FOR ALL
  • TEAM DEATHMATCH
  • BASICS
  • ATTACK
  • DEFENSE
  • SHOOTING RANGE
  • LANDMARK DRILL
  • CLEAR HOUSE
  • VERSUS AI

match_id note​

The match_id returns on this format:

{"info":{"match_info":{"match_id":"18F5D014-3FB9-0510-9083-DF555E39AD2B"}},"feature":"match_info"}

map_id note​

The map_id returns on this format:

{"info":{"match_info":{"map_id":"BANK"}},"feature":"match_info"}

The possible values are:

  • HOUSE
  • OREGON
  • CLUB HOUSE
  • PLANE
  • BANK
  • KANAL
  • CHALET
  • KAFE DOSTOYEVSKY
  • YACHT
  • BORDER
  • FAVELA
  • SKYSCRAPER
  • COASTLINE
  • THEME PARK
  • TOWER
  • VILLA
  • FORTRESS
  • OUTBACK
  • EMERALD PLAINS
  • STADIUM BRAVO
  • STADIUM 2020
  • CONSULATE
  • NightHaven
  • LAIR

A full list of maps can be found here

round_outcome_type note​

Data Example:

{"info":{"match_info":{"round_outcome_type":"team_has_been_eliminated"}},"feature":"match_info"}

Possible values:

  • "team_has_been_eliminated"
  • "bomb_detonated"
  • "bomb_deactivated"
  • "objective_secured"
  • "objective_protected"
  • "time_has_expired"
  • "extracted_thehostages"
  • "killed_hostages"

match_start note​

Data Example:

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

match_end note​

Data Example:

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

kill_feed note​

Coming Soon

This event is not yet available.

Data Example:

{"events":[{"name":"kill_feed","data":"{\"attacker\":\"overwolfqa\",\"victim\":\"overwolfPTW\",\"weapon_type\":\"assault_rifle\",\"headshot\":false}"}]}

match​

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
numberroundCurrent round numberSee notes123.0
scorematchMatch scoreSee notes123.0

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
roundStartnullRound starts.See notes123.0
roundEndnullRound ends.See notes123.0
roundOutcomevictory / defeatRound concluded.See notes123.0
matchOutcomevictory / defeatMatch concluded.See notes123.0

number note​

Data Example:

{"info":{"round":{"number":"1"}},"feature":"match"}

match_score note​

Match score info-update presents the score as it is in the game's UI, the local player is always in the blue team

Data Example:

{"info":{"match":{"score":"{\"blue\":\"1\",\"orange\":\"0\"}"}},"feature":"match"}

roundStart note​

Data Example:

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

roundEnd note​

Data Example:

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

roundOutcome note​

Data Example:

{"events":[{"name":"roundOutcome","data":"victory"}]}

matchOutcome note​

Data Example:

{"events":[{"name":"matchOutcome","data":"defeat"}]}

roster​

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
roster_XXplayersProvides info for the currently active players (10 players).See notes123.0
healthplayerPlayer’s current healthSee notes123.0
scoreplayerPlayer’s current score or nullSee notes123.0
killsplayerTotal number of kills by the player or nullSee notes123.0
deathsplayerTotal number of player's deaths or nullSee notes123.0

roster_XX notes​

Each player joining the game will be reported in the following way:

Backslashes were omitted for legibility.

{"feature": "roster", "category": "players", "key": "roster_5", "data": "{\"player\":\"Overwolf355\",\"is_anonymous\":true,\"suffix\":355,\"player_id\":\"5115efd3-d131-818a-b04d-2cd694dd61a1\",\"is_local\":true,\"team\":\"Blue\",\"operator\":\"JACKAL\",\"kills\":3,\"deaths\":1,\"score\":435,\"assists\":0,\"ping\":32}"}

This object includes:

  • player - player's name + suffix Important note - "name" is the player's username or nickname if enabled
  • is_anonymous - Boolean if the player's privacy is set to true or false
  • suffix - the player's suffix
  • player_id - the player's ID
  • is_local - is the player the local player true or false
  • team - Blue/Orange
  • kills - Total amount of kills made by the player
  • deaths - Total amount of deaths
  • assists - Total amount of assists
  • score - Player score in the current round
  • ping - the ping of the player
  • operator - the name of the current operator

When one of the players leaves the match, the relevant “roster_ XX” object will be updated to:

{"players":{"roster_3":null}}

If a new player replaces a leaver, a new “roster_XX” object will be assigned to the new player who joined.

health note​

Current health of the player Important! - health always includes 20 points for the knockout stage, so the event will always add 20 health points more than the game

{"info":{"player":{"health":"41"}},"feature":"roster"}

score note​

{"info":{"player":{"score":"100"}},"feature":"roster"}

kills note​

{"info":{"player":{"kills":"2"}},"feature":"roster"}

deaths note​

{"info":{"player":{"deaths":"1"}},"feature":"roster"}

kill​

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
killnullLocal player killed an enemySee notes123.0
headshotnullLocal player killed an enemy with a headshotSee notes123.0

kill note​

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

headshot note​

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

death​

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
knockedoutnullLocal player is knockedoutSee notes123.0
deathnullLocal player diesSee notes123.0
killerKiller idThe local player was killed by an enemySee notes123.0

knockedout note​

Data Example:

{"name":"knockedout","data":""}

death note​

Data Example:

{"name":"death","data":""}

killer note​

Data Example:

{"name":"killer","data":"eb96475f-cc15-4b5e-a0d5-b5c927bf1d4d"}

me​

Info Updates​

keyCategoryValuesNotesSince GEP Ver.
namemeLocal player's in-game name.See notes148.0

name note​

Data Example:

{"info":{"me":{"name":"WolfOnTop.top"}},"feature":"me"}

Important note - "name" is the player's username or nickname if enabled

defuser​

Events​

EventEvent DataFired WhenNotesSince GEP Ver.
defuser_plantednullDefuser was planted.See notes162.1
defuser_disablednullDefuser was disabled.See notes165.0

defuser_planted note​

Data Example:

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

defuser_disabled note​

Data Example:

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