Edit

Fortnite Game Events

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

Game ID

21216

Sample Apps

Available Features

Game events status

It is highly recommended to communicate errors and warnings to app users. Check game event status here. You can also easily check game events status 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:

{"feature":"gep_internal","category":"gep_internal","key":"version_info","value":"{"local_version":"143.0.10","public_version":"143.0.10","is_updated":true}"}

kill

Info Updates

keyCategoryValuesNotesSince GEP Ver.
killsmatch_infoTotal number of kills in the match110.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killnullThe local player killed another player110.0.0
knockoutnullThe local player knocked out another player110.0.0
hitisHeadshot – bool(“true” when the hit is a “headshot”)The local player hits an enemy with a weapon (hits with a pickaxe are not counted) See notes110.0.0

hit note

Data Example:

{"name":"hit","data":"{"isHeadshot": true}"}

killed

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killedThe name of the killed player. See notesThe local player killed another player117.0

killed note

Data Example:

{"name":"killed","data":"itaygl"}

killer

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killerName of the killer. See notesThe local player was killed117.0

killer note

Data Example:

{"name":"killer","data":"itaygl"}

revived

Events

EventEvent DataFired WhenNotesSince GEP Ver.
revivednullThe local player was revived110.0

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathnullThe local player died110.0
knockedoutThe name of the player who knocked you out. See noteThe local player is knocked-out118.1

knockedout note

Data example:

{"events":[{"name":"knockedout","data":"itaygl"}]}

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
modematch_infoPossible Values:
  • "solo"
  • "duo"
  • "squad"
  • "Playlist_Respawn" (Team Rumble)
  • "Playlist_PlaygroundV2" (Creative)
  • "Playlist_Creative_PlayOnly" (Playground)
  • "Playlist_ShowdownAlt_Solo" (Arena Solo)
  • "Playlist_ShowdownAlt_Squads" (Arena Squads)
  • "Playlist_Crucible_Solo" (The Combine)
  • Playlist_BattleLab
  • Playlist_Creative_ZebraWallet_Random
  • Playlist_Creative_ZebraWallet_Random2
110.0

Data example:

{"feature":"match","category":"match_info","key":"mode","value":"solo"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch started110.0
matchEndnullMatch ended110.0

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoThe current match’s ID code. See notes130.2
sessionIDmatch_infoThe current session’s ID code. See notes132.0
matchIDmatch_infoThe current match’s ID. See notes132.0
userIDmatch_infoThe current user’s ID code. See notes132.0
ticketIDmatch_infoThe current ticket’s ID code. See notes132.0
partyIDmatch_infoThe current party’s ID code. See notes132.0

pseudo_match_id note

Note that this is an Overwolf-generated code, not an Epic Games designation.

Example data:

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f

sessionID note

Data Example:

{"info":{"match_info":{"sessionID":"03765ae468cb4e8ca21cc290302a0ba0"}},"feature":"match"}

matchID note

Data Example:

{"info":{"match_info":{"matchID":"ff75f8541670a4317136b0b239955416"}},"feature":"match"}

userID note

Data Example:

{"info":{"match_info":{"userID":"0608873718b84a11a2ee66316d09c941"}},"feature":"match"}

ticketID note

Data Example:

{"info":{"match_info":{"ticketID":"dd7fd486ad6c9ab52627514f1921d765"}},"feature":"match"}

partyID note

Data Example:

{"info":{"match_info":{"partyID":"24f122daf9c446199e59f1f6841cacfe"}},"feature":"match"}

rank

Info Updates

keyCategoryValuesNotesSince GEP Ver.
rankmatch_infoThe player’s rank at the end of the match110.0
total_teamsmatch_infoTotal number of active teams110.0
total_playersmatch_infoTotal number of active players110.0

total_teams note

This is a dynamic variable that is being updated every time a team joins, leaves or dies during the game

total_players note

This is a dynamic variable that is being updated every time a player joins, leaves or dies during the game

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
namemeThe player’s nickname. See notes110.0
healthmeThe player’s current health % (100-0). See notes110.0
accuracymeThe local player’s current accuracy (hits/total shots). See notes110.0
shieldmeThe amount of shield the local player currently has. See notes110.0

name note

Data Example:

{"name":"itayG"}

health note

Data Example:

{"health":"37"}

accuracy note

Data Example:

{"accuracy":"0.333333"}

shield note

Data Example:

{"info":{"me":{"shield":"50"}},"feature":"me"}

phase

Info Updates

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe game’s current state, can be one of the following:
  • 'lobby'
  • ‘loading_screen’
  • ‘airfield’
  • ‘aircraft’
  • ‘freefly’
110.0

location

Info Updates

keyCategoryValuesNotesSince GEP Ver.
locationgame_infoPlayer’s current grid location, represented by (x,y,z).
  • Top left corner of the map is (0,0,z)
  • Bottom right corner of the map is (2500,2500,z). See notes
114.1

location note

Data Example:

{"x" : 621, "y" : 2469, "z" : 50}

team

Info Updates

keyCategoryValuesNotesSince GEP Ver.
nicknamesmatch_infoNames of the players in the user’s team. See notes170.0

team note

Data Example:

{"feature":"team","category":"match_info","key":"nicknames","value":"{"team_members":[{"player":"Itaygl"},{"player":"ErW_iN"},{"player":"einhorn28"},{"player":"Jacqulees"}]}"}

items

Info Updates

keyCategoryValuesNotesSince GEP Ver.
item_XinventoryCurrent inventory of the local player. See notes119.2
selected_slotselected_slotCurrently selected slot in the quickbar. See notes119.2
quickbar_XquickbarDisplay names of the items in the primary quickbar. (list of possible display names can be found here) See notes119.2
selected_materialselected_materialThe currently selected building material. See notes119.2

item_X note

Each item in the inventory has the following properties:

  • name – display name of the item (list of possible display names can be found here)
  • count – number of units
  • ammo – amount of loaded ammo (when relevant)
  • rarity – rarity of the item [0-4]
    • 0 – none
    • 1 – green
    • 2 – blue
    • 3 – purple
    • 4 – gold

Data Example:

"inventory":
{
    "item_0":"{"name":"WID_Harvest_Pickaxe_NeonCat","count":"1","ammo":"0","rarity":"3"}",
    "item_3":"{"name":"StoneItemData","count":"2","ammo":"0","rarity":"0"}",
    "item_7":"{"name":"AthenaAmmoDataShells","count":"4","ammo":"0","rarity":"0"}",
    "item_11":"{"name":"Athena_Balloons_Consumable","count":"7","ammo":"0","rarity":"3"}",3
    "item_15":null,
    "item_14":null,
    "item_13":"{"name":"WID_Assault_AutoHigh_Athena_SR_Ore_T03","count":"1","ammo":"30","rarity":"4"}"
}

selected_slot note

This info-update includes the following properties:

  • isPrimary – “true” when the selected slot is in the main quickbar (weapons), “false” when the selected slot is in the secondary quickbar (build options)
  • slot – the selected slot (0-5)

Data Example:

{"info":{"selected_slot":{"selected_slot":"{"isPrimary":true,"slot":"1"}"}},"feature":"items"}

quickbar_X note

Data Example:

{"info":{"quickbar":{"quickbar_1":"{"name":"WID_Shotgun_SemiAuto_Athena_UC_Ore_T03"}"}},
"feature":"items"}

selected_material note

Possible values are:

  • 0 – wood
  • 1 - stone
  • 2 – metal

Data Example:

{"info":{"selected_material":{"selected_material":"1"}},"feature":"items"}

coutners

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pingperformanceLatency changes of the local player in the current match.This feature is currently disabled.128.0
Last updated on 2020-1-26 by eransharv
← Dota UnderlordsHearthstone →