Skip to main content

Halo Infinite

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. 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"}

game_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
scenegame_infoThe name of the current scene.See notes190.0

scene note

Data Example:

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

List of possible values:

  • intro
  • lobby
  • match_start_countdown
  • loading
  • ingame
  • transfer_to_lobby

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
local_player_statsmatch_infoA variety of in-game stats for local player.See notes190.0
playlistmatch_infoThe playlist the player selected.See notes191.0
game_typematch_infoThe selected game type, important only for non custm gamesSee notes191.0
game_modematch_infoThe selected game modeSee notes191.0
match_outcomematch_infoThe final march outcome victory / defeatSee notes210.0

local_player_stats note

Data Example:

{"info":{"match_info":{"local_player_stats":"{"Score":0,"RoundsWon":1,"RoundsTied":0,"PersonalScore":1350,"Kills":8,"Deaths":13,"Assists":8,"KDA":0,"Suicides":0,"Betrayals":0,"AverageLifeDuration":0,"BestKillingSpree":3,"Headshots":0,"ShotsFired":0,"ShotsHit":0,"AccuracyPercentage":0,"MeleeKills":3,"GrenadeKills":1,"PowerWeaponKills":0,"DamageDone":0,"DamageTaken":0}"}},"feature":"match_info"}

Important note: Some of the stat parameters at the moment don't return any values (KDA, AccuracyPercentage, ShotsHit, DamageDone, DamageTaken, ShotsFired, AverageLifeDuration and more).

playlist note

Possible values are:

  • quick_play
  • bot_bootcamp
  • btb
  • fiesta
  • ffa_slayer
  • tactical_slayer
  • team_slayer
  • team_doubles
  • team_snipers
  • rumble_pit
  • land_grab
  • ranked_arena_open
  • ranked_arena_soloduo
  • custom
  • entrenched

Data Example:

{"feature":"match_info","category":"match_info","key":"playlist","value":"bot_bootcamp"}

Important - This info-update change only if the user change playlist

game_type note

Possible values are:

  • arena
  • btb
  • academy
  • campaign
  • landgrab

Data Example:

{"feature":"match_info","category":"match_info","key":"game_type","value":"arena"}

Important - This info-update change only if the user change game type

game_mode note

If the player uses a non-custom game use game_type to understand what type of game the player has selected. In this case the possible values are:

  • oddball
  • ctf
  • btb
  • slayer
  • ctf
  • stockpile
  • total_control
  • strongholds

If the player created a custom game you will get one of the values in the list, it that case you can ignore game_type In this case the possible values are:

  • arena:ctf
  • arena:ffa
  • arena:oddball
  • arena:onectf
  • arena:slayer
  • arena:strongholds
  • arena:landgrab
  • btb:slayer
  • btb:ctf
  • btb:stockpile
  • btb:total_control
  • fiesta:slayer
  • ranked:ctf
  • ranked:oddball
  • ranked:slayer
  • ranked:strongholds

Data Example:

{"feature":"match_info","category":"match_info","key":"game_mode","value":"ctf"}
OR
{"feature":"match_info","category":"match_info","key":"game_mode","value":"btb:ctf"}

match_outcome note

Match outcome at the end of the match

Possible values:

  • victory
  • defeat
  • tie

Data Example:

{"feature":"match_info","category":"match_info","key":"match_outcome","value":"victory"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullWhen loading into map.See notes190.0
match_endnullWhen disconnecting from map.See notes190.0

match_start note

Data Example:

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

match_end note

Data Example:

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

kill

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killIntegerKilling an opponent.See notes190.0

kill note

Data Example:

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

assist

Events

EventEvent DataFired WhenNotesSince GEP Ver.
assistIntegerAssist in killing an opponent.See notes190.0

assist note

Data Example:

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

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathIntegerDying to an opponent.See notes190.0

death note

Data Example:

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

roster

Info Updates

keyCategoryValuesNotesSince GEP Ver.
roster_XXmatch_infoThis feature provides the entire list of players.See notes190.0

roster_XX notes

This feature provides the entire list of players.

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_0","value":{"name":"Cocotte7425","team":1,"local":false}}

As you can see, this object includes:

  • name – Player's name
  • team – The team of the player.
  • local - “true” when the player is the local player that play, "false” when it's another player in the game.

When a player “leaves” the match, the roster will be updated with another player that is in the match. When the match end, the roster value is returned empty, example:

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_0","value":{}}