Skip to main content

PlayerUnkown's Battlegrounds Game Events

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

Game ID

10906

Sample Apps

Available Features

Game events status

It is highly recommended to communicate errors and warnings to your app users.

Check here the game events status. OR - easily check the 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 notes90.0
headshotsmatch_infoTotal number of headshots in the matchSee notes127.0
total_damage_dealtmatch_infoTotal damage dealt in the current matchSee notes127.0
max_kill_distancematch_infoMax kill distance in CMSee notes127.0

kills notes:

Currently there is a known issue where if a teammate knocks out an enemy and local player finishes him off, he will not get the kill event.

Data Example:

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

headshots note

Data Example:

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

total_damage_dealt note

Data Example:

{"info":{"match_info":{"total_damage_dealt":"100"}},"feature":"kill"}

max_distance_kill note

{"info":{"match_info":{"max_kill_distance":"8488.008789"}},"feature":"kill"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killnullThe local player killed another player90.0
knockoutnullThe local player knocked-out another player127.0
headshotnullThe local player hit another player with a headshot127.0
damage_dealtamount of damage dealt by the local playerThe local player “damaged” an enemy or himself127.0
firenullWhen local player attacks.Relevant also for fists.128.0

kill note:

Currently there is a known issue where if a teammate knocks out an enemy and local player finishes him off, he will not get the kill event.

Data Example:

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

knockout note

Data Example:

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

headshot note

Data Example:

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

damage_dealt note:

This event can not be used in real time, as it can give an un-fair advantage to the user. You can use it post-match.

Data Example:

{"events":[{"name":"damage_dealt","data":"39.102"}]}

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
modematch_infoSolo/Duo/Squad
Example:
{"mode":"squad"}
90.0
match_idmatch_infoThe current match ID code.
Example:
match.bro.official.pc-2018-03.steam.
solo.eu.2019.05.07.08.ce8d1a14-b2af
-41c8-8bf4-d2a504326630
Can be compared and checked at this link120.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch started90.0
matchEndnullMatch ended. See notes below90.0
matchSummarynullThe match summary screen (with the user’s rank) is shown
{"name":"matchSummary","data":""}
120.0

matchStart notes

Data Example:

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

matchEnd notes

The matchEnd event fired when your player is killed, and when you exit to the lobby. (which means that if you get killed and than you exit to the lobby, you will see two calls for this event).

Data Example:

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

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoThe current match’s ID code.
Example:
0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
This is an Overwolf-generated code which is unrelated to the match ID given above.130.0.15

rank

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mematch_infoThe player’s rank at the end of the matchSee notes90.0
totalmatch_infoThe total number of playersSee notes90.0

me notes

Data Example:

{"info":{"match_info":{"me":"38"}},"feature":"rank"}

total notes

Data Example:

{"info":{"match_info":{"total":"98"}},"feature":"rank"}

counters

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pingperformanceThe local player’s latencyExample: {"name":"ping","data":"66"}0.133

location

Info Updates

keyCategoryValuesNotesSince GEP Ver.
locationgame_infoThe player’s current grid location (x,y,z).See example below0.116
safe_zonegame_infoThe location of the white circle and its radiusSee example below0.133
blue_zonegame_infoThe location of the blue circle and its radiusSee example below0.133
red_zonegame_infoThe location of the red circle and its radiusSee example below0.133

Events

EventEvent DataFired WhenNotesSince GEP Ver.
time_to_next_circleAmount of seconds left to next safe zoneFrom the moment the first safe zone is formed.See example below0.133

location notes

  • Top-left is (0,0,z)
  • Large map (Miramar, Erangel, etc.) size is 8160×8160 (8 sq. KM)
  • Medium map (Vikendi) size is 6120×6120 (6 sq. KM)
  • Small map (Sanhok) size is 4080×4080 (4 sq. KM)
  • The location is being updated every two seconds while the player is in the airplane
  • The location is being updated every second while the user is not in the airplane (freefly or on the ground)

Example:

{"location":"{"x":2300,"y":5740,"z":1520}"}

zones notes

  • x & y are the center of the circle.
  • radius is the circle’s radius.

Examples:

{"info":{"game_info":{"safe_zone":"{"x":6727,"y":2556,"radius":1507}"}},"feature":"location"}
{"info":{"game_info":{"blue_zone":"{"x":6727,"y":2556,"radius":1507}"}},"feature":"location"}

time_to_next_circle notes

{"name":"time_to_next_circle","data":"{"phase":"3","time":"438"}"}

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
namemeThe player’s nickname
{"name":"itayG"}
90.0
bodyPositionmeThe local player’s peek-position.
  • ‘leanLeft’
  • ‘leanRight’
  • ‘straight’
128.0
inVehiclemeWhether local player is inside a vehicle or not.
  • ‘null’Bool - ‘True‘/‘False‘
Valid for the airplane as well.128.0
aimingmeThe player’s different type of aim-focus usage.
  • ‘null’
  • ‘focusedAim’
  • ‘aimDownSight’
  • aimDownSight_holding_breath’
128.0
viewmeThe player’s perspective (Third Person/First Person).
  • ‘TPP’
  • ‘FPP’
128.0
freeViewmeWhen the local player uses ‘ALT’ feature to look around.
  • Bool - ‘True‘/‘False‘
128.0
movementmeThe player’s type of movement speed.
  • ‘normal’
  • ‘fast’
  • ‘stealth’
128.0
inventory_XXinventoryInfo about the inventory of the local player. Each “inventory_XX” object
represents one item and is being cleared once this item is dropped/replaced
by the player.
This info-update provides:
  • name (string) – name of the item
  • count (int) – number of items
{"feature":"me","category":"inventory","key":"inventory_1",
"value":"{"name" :"Item_Attach_Weapon_Muzzle_FlashHider
_Medium_C_2","count":"1"}"}
130.0.9
equipped_XXinventoryInfo about “equipable” items. Each “equipped_XX” object represents
one item and is being cleared once this item is dropped/replaced
by the player.
This info-update provides:
  • name (string) – the name of the item
  • count (int) – number of items
  • {"feature":"me","category":"inventory","key":"equipped_1",
    "value":"{"name": "Item_Weapon_vz61Skorpion_C_1"
    "count":"1"}"}
130.0.9
weaponStateinventoryInfo about the weapon and its state.
This info-update provides:
  • name (string) – the name of the weapon used by the local player
  • equipped (bool) – in hand (true) or holstered (false)
  • count (int) – number of items
130.0.9
healthmeThe player’s current healthSee notes135.0
stancemeThe player’s current stancePossible values are: stand, crouch and prone.135.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
jumpnullLocal player jumps (space)128.0

health note:

Data Example:

{"health":"{"health":100,"ko_health":100}"}

team

Info Updates

keyCategoryValuesNotesSince GEP Ver.
nicknamesmatch_infoThe names of players in the local players' squad.See notes90.0
team_locationmatch_infoThe X,Y,Z location of your team members.See notes134.0
team_indexmatch_infoThe index number of every squad member position by order of appearance.See notes134.0

nicknames note

Each member has an index number that indicates his position in the squad's roste by order of appearance (f.ex first position is index 0, 2nd position is index 1, 3rd position is index 2... etc.)

Data Example:

{"info":{"match_info":{"nicknames":"{"team_members":["Siogioto","AgCorp","LEOkonami"]}"}},"feature":"team"}

team_location note

Data Example:

{"info":{"game_info":{"team_location":"[
{"player":"Stilee","location":{"x":"4185","y":"1309","z":"1500"}},
{"player":"hajjjekc","location":{"x":"4185","y":"1309","z":"1500"}},
{"player":"itayG","location":{"x":"4185","y":"1309","z":"1500"}},
{"player":"ARNKC","location":{"x":"4185","y":"1309","z":"1500"}}]"}},"feature":"location"}

team_index note

Data Example:

{"info":{"match_info":{"team_index":"[{"player":"Siogioto","index":0},{"player":"AgCorp","index":1},{"player":"LEOkonami","index":3}]"}},"feature":"team"}

phase

Info Updates

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe game’s current statesee notes90.0

phase notes

Possible values:

  • lobby
  • loading_screen
  • airfield
  • aircraft
  • freefly
  • landed

Data example:

{"feature":"phase","category":"game_info","key":"phase","value":"lobby"}

map

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mapmatch_infoThe current map name
{"map":"Erangel_Main"}
map names mapping0.90

roster

Info Updates

keyCategoryValuesNotesSince GEP Ver.
roster_XXmatch_infoThis feature provides the entire list of players
(~99 players). See notes below
119.1

roster_XX notes

This feature provides the entire list of players (~99 players). Each player that joins the game (during the “airfield” phase) will be reported in the following way:

{"info":{"match_info":{"roster_0":"{"player":"Dr4ex","kills":"0","out":false}"}},"feature":"roster"}

As you can see, this object includes:

  • player – Player name
  • kills – Number of kills. This field is being updated once the player leaves the game ( = quit the match).
  • out - false” when the player is “alive”, “true” when the player left the game (died or quit the match).
    When a player “leaves” the match, the following info-update will be reported:
    {"feature":"roster","category":"match_info","key":"roster_0","value":"{"player":"Dr4ex""kills":"0","out":true}"}

revived

Events

EventEvent DataFired WhenNotesSince GEP Ver.
revivednullThe local player was revivedSee notes0.90

revived notes

Data Example:

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

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathnullThe local player diesSee notes0.90
knockedoutnullThe local player is knocked-outSee notes 0.90
damageTakennullThe local player receives damage.Not including damage
taken when outside the zone.
0.128

death notes

Data Example:

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

knockedout notes

Data Example:

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

killer

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killerThe killer’s nicknameThe local player was killed by one of the playersSee notes90.4

killer notes:

When one of local player’s squad members kill the local player, the provided data will be "self_kill”.

Data Example:

{"events":[{"name":"killer","data":"{ "killer_name": "Ace_Tullis"}"}]}