Skip to main content

Fortnite

Fortnite

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

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:

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

kill

Info Updates

keyCategoryValuesNotesSince GEP Ver.
killsmatch_infoTotal number of kills in the matchSee notes110.0

kills note

Data Example:

{"info":{"match_info":{"kills":"1"}},"feature":"kill"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killtotalKills – total kills for player in matchThe local player killed another playerSee notes110.0.0
knockoutThe name of the player that you knocked out.The local player knocked out another playerSee notes110.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

kill note

Data Example:

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

knockout note

Data Example:

{"events":[{"name":"knockout","data":"SomeUser"}]}

hit note

Data Example:

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

killed

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killedThe name of the killed player.The local player killed another playerSee notes117.0

killed note

Data Example:

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

killer

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killerName of the killer.The local player was killedSee notes117.0

killer note

Data Example:

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

revived

Events

EventEvent DataFired WhenNotesSince GEP Ver.
revivednullThe local player was revivedSee notes110.0

revived note

Data Example:

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

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathnullThe local player diedSee notes110.0
knockedoutThe name of the player who knocked you out.The local player is knocked-outSee notes118.1

death note

Data Example:

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

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

Important note - Fortnite is a game that rotates game modes when the season changes and with patches. Thus it's important to remember that not all values that are listed below are valid at all times. These values change with time and with patches (except for the base modes like solo / duo / etc).

Furthermore - Event data is not fully reliable in Creative mode and should be taken into consideration when working with that mode.

Data example:

{"info":{"match_info":{"mode":"solo"}},"feature":"match"}
{"info":{"match_info":{"mode":"duo"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Trios"}},"feature":"match"}
{"info":{"match_info":{"mode":"squad"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_ShowdownAlt_Solo"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_ShowdownAlt_Duos"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_ShowdownAlt_Trios"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Daybreak_PE_Squads"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Respawn"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_BattleLab"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Creative_LTM_NewRVB2"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Creative_LTM_ProRVB"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Creative_LTM_PRO100"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Creative_LTM_FinestYTReal2v2"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Daybreak_PP_Squads"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Papaya"}},"feature":"match"}
{"info":{"match_info":{"mode":"Playlist_Daybreak_PE_Squads"}},"feature":"match"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch startedSee notes110.0
matchEndnullMatch endedSee notes110.0

matchStart note

Data Example:

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

matchEnd note

Data Example:

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

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
skirmishmatch_infoThe skirmish data is the enemy gunfire indicator on the compassSee notes195.0
rostermatch_infoThis feature provides the entire list of playersSee notes198.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
generickill/death/knockedGeneric events are generated.See notes153.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"}

skirmish note

The skirmish data array is the enemy gunfire indicator on the compass for each enemy and includes these parameters

  • time - time in seconds since the beginning of the game
  • strength strength of the gunfire from 1 the weakest to maximum 99
  • compass_angle - the angle that the local player is looking on. 0 - 360 deg
  • red_dot_angle - the angle where the gunfire came from. 0 - 360 deg

Data Example:

{"feature":"match_info","category":"match_info","key":"skirmish","value":"{\"skirmish_data\":[{\"index\":1,\"time\":165,\"strength\":18,\"compass_angle\":96,\"red_dot_angle\":57},{\"index\":2,\"time\":166,\"strength\":99,\"compass_angle\":96,\"red_dot_angle\":113}]}"}

roster note

This feature provides the entire list of players

  • player - the player name. If anonymous is activated the value will be anonymous
  • team_id - the ID of the player's team
  • is_local - if the player is the local player the value will be true in not the value will be false

Data Example:

{"feature":"match_info","category":"match_info","key":"roster_99","value":"{\"player\":\"Mefe76\",\"team_id\":102,\"is_local\":false}"}

generic note

These are general events provided by the game client.

Possible values:

  • "knocked"
  • "kill"
  • "2kill" - double kill
  • "3kill" - triple kill
  • "mkill" - multi kill
  • "won"
  • "death"

Data Example:

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

rank

Info Updates

keyCategoryValuesNotesSince GEP Ver.
rankmatch_infoThe player’s rank at the end of the matchSee notes110.0
total_teamsmatch_infoTotal number of active teamsSee notes110.0
total_playersmatch_infoTotal number of active playersSee notes110.0

rank note

Data Example:

{"info":{"match_info":{"rank":"1"}},"feature":"rank"}

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
total_shotsmeThe amount of times the local player shot (not including grenades).See notes157.0

name note

Data Example:

{"info":{"me":{"name":"Sh4rgaas"}},"feature":"me"}

health note

Data Example:

{"info":{"me":{"health":"100"}},"feature":"me"}

accuracy note

Data Example:

{"info":{"me":{"accuracy":"0.500000"}},"feature":"me"}

shield note

Data Example:

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

total_shots note

Data Example:

{"info":{"me":{"total_shots":"84"}},"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’
  • ‘replay’
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 notes114.1

location note

Data Example:

{"info":{"game_info":{"location":"{ "x" : 1209, "y" : 1560, "z" : -18 }"}},"feature":"location"}

team

Info Updates

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

nicknames note

Data Example:

{"info":{"match_info":
{"nicknames":"{"team_members" : [
{"player" : "Sh4rgaas"},
{"player" : "Benda3907"},
{"player" : "KapiXono"},
{"player" : "Bradost-dost12"}
]}"}},"feature":"team"}

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

counters

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pingperformanceLatency changes of the local player in the current match.See notes195.0

ping note

Data Example:

{"feature":"counters","category":"performance","key":"ping","value":61}

map

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mapmatch_infoName of the current played map.See notes
creative_mapmatch_infoDetails about the creative map.See notes

map note

Data Example:

{"feature":"map","category":"match_info","key":"map","value":"Creative_NoApollo_Terrain"}

creative_map note

Data Example:

{"feature":"map","category":"match_info","key":"creative_map","value":"{\"map_id\":\"0353-9713-7218\",\"title\":\"Cyber_Dragon_Hub\",\"account_id\":\"7f1f209123164b1bbf905ad1ef9990de\",\"version\":\"2\"}"}