- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
- gep_internal
- kill
- revived
- death
- killer
- match
- match_info
- rank
- counters
- location
- me
- team
- phase
- map
- roster
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
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"}
kill
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
kills | match_info | Total number of kills in the match | See notes | 90.0 |
headshots | match_info | Total number of headshots in the match | See notes | 127.0 |
total_damage_dealt | match_info | Total damage dealt in the current match | See notes | 127.0 |
max_kill_distance | match_info | Max kill distance in CM | See notes | 127.0 |
kills
notes:
Currently, there is a known issue where if a teammate knocks out an enemy and the 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
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
kill | null | The local player killed another player | 90.0 | |
knockout | null | The local player knocked-out another player | 127.0 | |
headshot | null | The local player hit another player with a headshot | 127.0 | |
damage_dealt | amount of damage dealt by the local player | The local player “damaged” an enemy or himself | 127.0 | |
fire | null | When 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 the 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 unfair advantage to the user. You can use it post-match.
Data Example:
{"events":[{"name":"damage_dealt","data":"39.102"}]}
match
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
mode | match_info | Solo/Duo/Squad Example: {"mode":"squad"} | 90.0 | |
match_id | match_info | The 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 link | 120.0 |
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
matchStart | null | Match started | 90.0 | |
matchEnd | null | Match ended. See notes below | 90.0 | |
matchSummary | null | The 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 is fired when your player is killed, and when you exit to the lobby. (which means that if you get killed and then you exit to the lobby, you will see two calls for this event).
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. 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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
me | match_info | The player’s rank at the end of the match | See notes | 90.0 |
total | match_info | The total number of players | See notes | 90.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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
ping | performance | The local player’s latency | Example: {"name":"ping","data":"66"} | 0.133 |
location
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
location | game_info | The player’s current grid location (x,y,z). | See example below | 0.116 |
safe_zone | game_info | The location of the white circle and its radius | See example below | 0.133 |
blue_zone | game_info | The location of the blue circle and its radius | See example below | 0.133 |
red_zone | game_info | The location of the red circle and its radius | See example below | 0.133 |
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
time_to_next_circle | Amount of seconds left to next safe zone | From the moment the first safe zone is formed. | See example below | 0.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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
name | me | The player’s nickname{"name":"itayG"} | 90.0 | |
bodyPosition | me | The local player’s peek-position.
| 128.0 | |
inVehicle | me | Whether the local player is inside a vehicle or not.
| Valid for the airplane as well. | 128.0 |
aiming | me | The player’s different type of aim-focus usage.
| 128.0 | |
view | me | The player’s perspective (Third Person/First Person).
| 128.0 | |
freeView | me | When the local player uses the ‘ALT’ feature to look around.
| 128.0 | |
movement | me | The player’s type of movement speed.
| 128.0 | |
inventory_XX | inventory | Info 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:
{"feature":"me","category":"inventory","key":"inventory_1", "value":"{"name" :"Item_Attach_Weapon_Muzzle_FlashHider _Medium_C_2","count":"1"}"} | 130.0.9 | |
equipped_XX | inventory | Info 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
{"feature":"me","category":"inventory","key":"equipped_1", "value":"{"name": "Item_Weapon_vz61Skorpion_C_1" "count":"1"}"} | 130.0.9 | |
weaponState | inventory | Info about the weapon and its state. This info-update provides:
| 130.0.9 | |
health | me | The player’s current health | See notes | 135.0 |
stance | me | The player’s current stance | Possible values are: stand, crouch and prone. | 135.0 |
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
jump | null | Local player jumps (space) | 128.0 |
health note:
Data Example:
{"health":"{"health":100,"ko_health":100}"}
team
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
nicknames | match_info | The names of players in the local players' squad. | See notes | 90.0 |
team_location | match_info | The X, Y, and Z coordinates of your team members. | See notes | 134.0 |
team_index | match_info | The index number of every squad member position by order of appearance. | See notes | 134.0 |
nicknames note
Each member has an index number that indicates his position in the squad's roster 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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
phase | game_info | The game’s current state | see notes | 90.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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
map | match_info | The current map name{"map":"Erangel_Main"} | map names mapping | 0.90 |
roster
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
roster_XX | match_info | This 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
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
revived | null | The local player was revived | See notes | 0.90 |
revived
notes
Data Example:
{"events":[{"name":"revived","data":""}]}
death
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
death | null | The local player dies | See notes | 0.90 |
knockedout | null | The local player is knocked-out | See notes 0.90 | |
damageTaken | null | The 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
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
killer | The killer’s nickname | The local player was killed by one of the players | See notes | 90.4 |
killer
notes:
When one of the local player’s squad members kills the local player, the provided data will be "self_kill”.
Data Example:
{"events":[{"name":"killer","data":"{ "killer_name": "Ace_Tullis"}"}]}