Fortnite | Overwolf Developers

Game events API
Events status

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

Sample Apps

Fortnite game events sample app

Available Features

gep_internal
game_info
kill
killed
killer
revived
death
match
match_info
rank
me
phase
location
team
items
counters
map

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

key	Category	Values	Notes	Since GEP Ver.
gep_internal	gep_internal	Local + Public version number	See notes	143.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

key	Category	Values	Notes	Since GEP Ver.
server	game_info	The server name	See notes	260.0
privacy	game_info	The selected privacy	See notes	260.0
game_title	game_info	The title of the selected game	See notes	260.0
game_type	game_info	The type of the selected game	See notes	260.0
title_mnemonic	game_info	The mnemonic title of the selected game	See notes	260.0
player_rank	game_info	The local player different ranks	See notes	262.0
party_players	game_info	An array of players that joined the party in the lobby	See notes	263.0

server note

Data Example:

{"feature":"game_info","category":"game_info","key":"server","value":"BR"}

privacy note

Possible values:

public
private

Data Example:

{"feature":"game_info","category":"game_info","key":"privacy","value":"public"}

game_title note

Data Example:

{"feature":"game_info","category":"game_info","key":"game_title","value":"Solo"}

game_type note

Data Example:

{"feature":"game_info","category":"game_info","key":"game_type","value":"Battle Royal"}

title_mnemonic note

Data Example:

{"feature":"game_info","category":"game_info","key":"title_mnemonic","value":"set_nobuild_playlists"}

player_rank note

Data Example:

 {"feature":"game_info","category":"game_info","key":"player_rank","value":"[{\"rank_type\":\"reload_build\",\"rank\":0,\"progress\":0},{\"rank_type\":\"battle_royal\",\"rank\":2,\"progress\":0.2},{\"rank_type\":\"reload_zero_build\",\"rank\":0,\"progress\":0},{\"rank_type\":\"zero_build\",\"rank\":6,\"progress\":0.53}]"}

party_players note

Data Example:

 {"feature":"game_info","category":"game_info","key":"party_players","value":"["Nano888","Shared118"]"}

`kill`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
kills	match_info	Total number of kills in the match	See notes	110.0

kills note

Data Example:

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

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
kill	totalKills – total kills for player in match	The local player killed another player	See notes	110.0.0
knockout	The name of the player that you knocked out.	The local player knocked out another player	See notes	110.0.0
hit	isHeadshot – deprecated and will always return false	The local player hits an enemy with a weapon (hits with a pickaxe are not counted)	See notes	110.0.0

kill note

Data Example:

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

knockout note

Data Example:

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

hit note

caution

isHeadshot is deprecated and will always return false

Data Example:

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

`killed`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
killed	The name of the killed player.	The local player killed another player	See notes	117.0

killed note

Data Example:

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

`killer`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
killer	Name of the killer.	The local player was killed	See notes	117.0

killer note

Data Example:

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

`revived`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
revived	null	The local player was revived	See notes	110.0

revived note

Data Example:

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

`death`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
death	null	The local player died	See notes	110.0
knockedout	The name of the player who knocked you out.	The local player is knocked-out	See notes	118.1

death note

Data Example:

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

`knockedout` note

Data example:

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

`match`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
mode	match_info	Possible 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

Event	Event Data	Fired When	Notes	Since GEP Ver.
matchStart	null	Match started	See notes	110.0
matchEnd	null	Match ended	See notes	110.0

matchStart note

Data Example:

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

matchEnd note

Data Example:

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

`match_info`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
pseudo_match_id	match_info	The current match’s ID code.	See notes	130.2
sessionID	match_info	The current session’s ID code.	See notes	132.0
matchID	match_info	The current match’s ID.	See notes	132.0
userID	match_info	The current user’s ID code.	See notes	132.0
ticketID	match_info	The current ticket’s ID code.	See notes	132.0
partyID	match_info	The current party’s ID code.	See notes	132.0
skirmish	match_info	The skirmish data is the enemy gunfire indicator on the compass	See notes	195.0
match_stats	match_info	Statistics when the match is over	See notes	258.0

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
generic	kill/death/knocked	Generic events are generated.	See notes	153.0
message_feed	Send the messages from the feed	Each time there is a new message in the feed	See notes	258.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 of the gunfire from 1 the weakest to a maximum of 99
compass_angle - the angle that the local player is looking at. 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}]}"}

match_stats note

Data Example:

{"feature":"match_info","category":"match_info","key":"match_stats","value":"{\"place\":42,\"elimination\":6,\"assist\":0,\"revive\":0,\"hits\":51}"}

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 if 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"}]}

message_feed note

Data Example:

{"events":[{"name":"message_feed","data":"RoDnik92 (110) has thanked the bus driver"}]}
{"events":[{"name":"message_feed","data":"Sashator7684 eliminated RoDnik92 (111) with a pistol (97 m)"}]}

`rank`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
rank	match_info	The player’s rank at the end of the match	See notes	110.0
total_teams	match_info	Total number of active teams	See notes	110.0
total_players	match_info	Total number of active players	See notes	110.0

rank note

Data Example:

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

total_teams note

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

total_players note

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

`me`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
name	me	The player’s nickname.	See notes	110.0
health	me	The player’s current health % (100-0).	See notes	110.0
accuracy	me	The local player’s current accuracy (hits/total shots).	See notes	110.0
shield	me	The amount of shield the local player currently has.	See notes	110.0
total_shots	me	The number of times the local player shot (not including grenades).	See notes	157.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

key	Category	Values	Notes	Since GEP Ver.
phase	game_info	The game’s current state can be one of the following: 'lobby' ‘loading_screen’ ‘airfield’ ‘aircraft’ ‘freefly’ ‘replay’		110.0

`location`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
location	game_info	Player’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 (3000,3000,z).	See notes	114.1

location note

Data Example:

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

`team`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
nicknames	match_info	Names of the players in the user’s team.	See notes	170.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

key	Category	Values	Notes	Since GEP Ver.
item_X	inventory	Current inventory of the local player.	See notes	119.2
selected_slot	selected_slot	Currently selected slot in the quickbar.	See notes	119.2
quickbar_X	quickbar	Display the names of the items in the primary quick bar.	See notes	119.2
selected_material	selected_material	The currently selected building material.	See notes	119.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 quick bar (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

key	Category	Values	Notes	Since GEP Ver.
ping	performance	Latency changes of the local player in the current match.	See notes	195.0

ping note

Data Example:

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

`map`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
map	match_info	Name of the current played map.	See notes
creative_map	match_info	Details about the creative map.	See notes

map note

Data Example:

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

creative_map note

Missing data

account_is and title parameters are not working in Creative Maps 2.0

List of parameters:

map_id - the current played map ID
title - the title of the current played map
account_id - the user's account ID
creative_mode_version - for creative 1.0 the value will be 1, for creative 2.0 the value will be 2
version - the current map version

Data Example:

{"feature":"map","category":"match_info","key":"creative_map","value":"{\"map_id\":\"3305-1661-7747\",\"title\":\"GO_Zone_Wars\",\"account_id\":\"3e7027499f3b5b72374bd\",\"creative_mode_version\":1,\"version\":\"1055\"}"}

Sample Apps​

Available Features​

Game events status​

gep_internal​

Info Updates​

gep_internal note​

game_info​

Info Updates​

server note​

privacy note​

game_title note​

game_type note​

title_mnemonic note​

player_rank note​

party_players note​

kill​

Info Updates​

kills note​

Events​

kill note​

knockout note​

hit note​

killed​

Events​

killed note​

killer​

Events​

killer note​

revived​

Events​

revived note​

death​

Events​

death note​

knockedout note​

match​

Info Updates​

Events​

matchStart note​

matchEnd note​

match_info​

Info Updates​

Events​

pseudo_match_id note​

sessionID note​

matchID note​

userID note​

ticketID note​

partyID note​

skirmish note​

match_stats note​

roster note​

generic note​

message_feed note​

rank​

Info Updates​

rank note​

total_teams note​

total_players note​

me​

Info Updates​

name note​

health note​

accuracy note​

shield note​

total_shots note​

phase​

Info Updates​

location​

Info Updates​

location note​

team​

Info Updates​

nicknames note​

items​

Info Updates​

item_X note​

selected_slot note​

quickbar_X note​

selected_material note​

Sample Apps

Available Features

Game events status

`gep_internal`

Info Updates

gep_internal note

`game_info`

Info Updates

server note

privacy note

game_title note

game_type note

title_mnemonic note

player_rank note

party_players note

`kill`

Info Updates

kills note

Events

kill note

knockout note

hit note

`killed`

Events

killed note

`killer`

Events

killer note

`revived`

Events

revived note

`death`

Events

death note

`knockedout` note

`match`

Info Updates

Events

matchStart note

matchEnd note

`match_info`

Info Updates

Events

pseudo_match_id note

sessionID note

matchID note

userID note

ticketID note

partyID note

skirmish note

match_stats note

roster note

generic note

message_feed note

`rank`

Info Updates

rank note

total_teams note

total_players note

`me`

Info Updates

name note

health note

accuracy note

shield note

total_shots note

`phase`

Info Updates

`location`

Info Updates

location note

`team`

Info Updates

nicknames note

`items`

Info Updates

item_X note

selected_slot note

quickbar_X note

selected_material note