- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
This is a on-going development. All events and info updates can be target to changes.
- gep_internal
- me
- match_info
- matching
- character_selection
- kills
- announces
- game_objects
- day_change
- move_regions
- scoreboards
- damages
- level_ups
- routes
- equipments
- restriction_timers
- match_ends
Game event status
It is highly recommended to communicate errors and warnings to app users.
Check the current game event status here. Alternatively, you can easily check that status from your app itself, 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"}
me
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player_info | me | ID of the local player. | See notes | 148.0 |
player_info note
Data Example:
{"info":{"me":{"player_info":{"user_num": 144222} }},"feature":"me"}
match_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
team | match_info | ID of the team player in the match. | See notes | 148.0 |
roster | match_info | All other player info is known to the local player. | See notes | 159.0 |
match | match_info | ID of the match. | See notes | 159.0 |
region | match_info | Starting location of all the users (if selected). | See notes | 159.0 |
team note
Data Example:
{"info":{"match_info":{"team":{"ally1" : 1003024, "ally2" : 144240}}},"feature":"me"}
This distinction of ally1 and ally2 will be used as a reference point in later events.
The team
info update does not work for premade teams.
The user number will return 0 as a value if there are none.
For example, in solo mode, both ally1 and ally2 will return 0.
roster note
Data Example:
{"info":{"match_info" : {"roster" : [{"player_name" : "TestSubject1", "is_ally" : false, "player_character" : 12, "player_skin" : 1}]}},"feature":"me"}
"roster" includes information on all 18 players in the game.
"is_ally" will specify whether the subject is an ally or not.
This info will contain the local player itself.
match note
Data Example:
{
"info": {
"match_info": {
"match_id": 1223222,"feature":"me"}
}
}
region note
Data Example:
{"info":{"match_info" : {"enemy" : [1, 2, 5, 2, 0 ,0 ...],"Self" : 12, "Ally1" : 12, " Ally2" : 12 } ,"feature":"me"}}
The enemy array will be an array containing 16 integers. Each index number + 1 will represent the area code of area_code.
eg) index 0 of the array represents the number of players selecting area code 1 as their starting point.
matching
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
matching_start | game_mode, matching_team_mode | Matching started. | See notes | 148.0 |
matching_standby | null | Accept matching inquiry started | See notes | 148.0 |
matching_complete | null | Match starts. | See notes | 148.0 |
matching_start note
Data Example:
{"event":"matching_start","data":{"game_mode" : "", "matching_team_mode" : ""}}
Possible game modes :
- Normal
- Rank
Possible matching team modes :
- Solo
- Duo
- Squad
matching_standby note
Data Example:
{"event":"matching_standby","data":""}
This is triggered when the local player inquires whether to accept or decline the current matching.
It does not return the action of the local player.
matching_complete note
Data Example:
{"event":"matching_complete","data":""}
character_selection
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
select_character | Character code | Local player selects character in character selection. | See notes | 148.0 |
select_weapon | Weapon code | Local player selects weapon in character selection. | See notes | 148.0 |
team_character | Ally, Character code | Ally player selects a character in character selection. | See notes | 148.0 |
team_weapon | Weapon code | Ally player selects weapon in character selection. | See notes | 148.0 |
select_route | Target items, Target regions | Local player selects plan in character selection. | See notes | 148.0 |
select_trait | SelectedTraits | Local player selects trait for the character. | See notes | 148.0 |
select_starting_point | Area code | Local player selects starting point in character selection. | See notes | 148.0 |
ally_starting_point | Area code, Area code | Ally player selects the starting point in character selection. | See notes | 148.0 |
select_character note
Data Example:
{"event":"select_character","data":1}
See character_code for more info on character number.
select_weapon note
Data Example:
{"event":"select_character","data":1}
See weapon_code for more info on weapon number.
team_character note
Data Example:
{"event":"team_character","data":{"who" : "ally1", "character_num" : 12}}
The data "who" refers to the distinction in teams.
See character_code for more info on character number.
team_weapon note
Data Example:
{"event":"team_weapon","data":{"who" : "ally1", "weapon_num" : 12}}
The data "who" refers to the distinction in teams.
See weapon_code for more info on weapon number.
select_route note
Data Example:
{"event":"select_route","data":{"items" : [122232, 144244, ...], "regions" : [11, 3, 8, 5]}}
The 'items' array consists of 6 items, each representing the item code. See item_code for more info.
The 'regions' array is the area code in order of index. See area_code for more info.
eg) Local player's saved plan visits area 11, 3, 8, and 5 in the written order.
select_trait note
Data Example:
{"event":"select_trait","data":{"trait" : [122232, 144244, 155255, 152525, 155555]}}
This feature will be effective after December 9th, 2021.
The trait data will include 5 integers that represent the trait code.
See trait for more info.
select_starting_point note
Data Example:
{"event":"select_starting_point","data":1}
Area code for the local player's starting point.
See area_code for more info.
ally_starting_point note
Data Example:
{"event":"ally_starting_point","data":{"ally1" : 5, "ally2" : 5}}
Both ally's starting point area code is given.
See area_code for more info.
kills
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
knock_down | Victim name, Current kill count | Local player kills or knocks down an enemy. | See notes | 148.0 |
downed | Victim name, Time left | Ally player is downed. | See notes | 148.0 |
down_count | Victim name, Time left | Downed ally player has taken damag. | See notes | 148.0 |
get_up | Victim name, Healer name | Downed ally player has recovered. | See notes | 148.0 |
hunt | Monster name, Level | Local player hunts a monster. | See notes | 148.0 |
knock_down note
Data Example:
{"event":"knock_down","data":{"victim" : "TestSubject5", "total_kills" : 5}}
Knock-downs will also return kills in Solo game mode.
The victim returns the name of the player.
The name of the player can be an anonymous nickname such as "Test Subject 1"
downed note
Data Example:
{"event":"downed","data":{"victim" : "AllyPlayer", "time_left" : 15.0f}}
down_count note
Data Example:
{"event":"down_count","data":{"victim" : "MeOrAllyPlayer125", "time_left" : 10.5f}}
This triggers when a downed ally has taken damage and the time left is updated consequently.
get_up note
Data Example:
{"event":"get_up","data":{"victim" : "MeOrAllyPlayer125", "healer" : "MeOrAlly112"}}
hunt note
Data Example:
{"event":"hunt","data":{"monster" : "Chicken", "level" : 12}}
See monster for more info.
announces
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
kill | Killer name, Victim name, Killer kill count | Player kills another player. (Announcement) | See notes | 148.0 |
death | Victim name, Killer type | Player is dead. (Announcement) | See notes | 148.0 |
resurrect | Player name | Player is resurrected. (Announcement) | See notes | 148.0 |
kill note
Data Example:
{"event":"kill","data":{"killer" : "Test Subject 15", "victim" : "Someone", "total_kills" : 5}}
Kill will return the kill logs of all players. (Including the local player.) This will be triggered via announcements.
death note
Data Example:
{"event":"death","data":{"victim" : "Test Subject 15", "killer_type" : "WildLife"}}
Possible killer type
- WildLife
- Restriction
- Meteor
resurrect note
Data Example:
{"event":"resurrect","data":"Test Subject 15"}
game_objects
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
wickeline_prep | Boolean | 1 minute before Wickeline is about to spawn. (Announcement) | See notes | 148.0 |
wickeline_appear | Boolean | Wickeline has spawned. (System chat) | See notes | 148.0 |
wickeline_move | Area code | Wickeline has moved to another area. (System chat) | See notes | 148.0 |
wickeline_dead | Killer name | Player kills Wickeline. (System chat) | See notes | 148.0 |
android_prep | Area code, Android name | 1 minute before Android Alpha/Omega is about to spawn. (Announcement) | See notes | 148.0 |
android_appear | Android name | Android Alpha/Omega has spawned. (Announcement) | See notes | 148.0 |
android_dead | Boolean | Android Alpha/Omega is dead. (Announcement) | See notes | 148.0 |
meteorite_prep | Area code | 1 minute before meteorite is about to spawn. (Announcement) | See notes | 148.0 |
meteorite_appear | Boolean | Meteorite has spawned. (Announcement) | See notes | 148.0 |
tree_of_life_prep | Area code | 1 minute before the tree of life is about to spawn. (Announcement) | See notes | 148.0 |
tree_of_life_appear | Boolean | Tree of life has spawned. (Announcement) | See notes | 148.0 |
wickeline_prep note
Data Example:
{"event":"wickeline_prep","data":true}
All of the events in "game_objects" feature are triggered by announcements and system chats.
wickeline_appear note
Data Example:
{"event":"wickeline_appear","data":true}
wickeline_move note
Data Example:
{"event":"wickeline_move","data":14}
Area code of wickeline's new location.
See area_code for more info.
wickeline_dead note
Data Example:
{"event":"wickeline_dead","data": "Test Subject 15"}
Player name of Wickeline's killer.
android_prep note
Data Example:
{"event":"android_prep","data": {"region" : 15, "android" : "alpha"}}
Area code of androids's spawn location.
See area_code for more info.
Possible Android value :
- alpha
- omega
android_appear note
Data Example:
{"event":"android_prep","data": "alpha"}
Note that android_appear will not specify the spawn area code.
Possible Android value :
- alpha
- omega
android_dead note
Data Example:
{"event":"android_prep","data": "alpha"}
Possible Android value :
- alpha
- omega
meteorite_prep note
Data Example:
{"event":"meteorite_prep","data": 15}
Area code of meteorite's spawn location.
See area_code for more info.
meteorite_appear note
Data Example:
{"event":"meteorite_prep","data": true}
tree_of_life_prep note
Data Example:
{"event":"tree_of_life_prep","data": 15}
Area code of tree of life's spawn location.
See area_code for more info.
tree_of_life_appear note
Data Example:
{"event":"tree_of_life_prep","data": true}
day_change
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
change_to_day | Date | Atmosphere changes from night to day. | See notes | 148.0 |
change_to_night | Date | Atmosphere changes from day to night. | See notes | 148.0 |
new_restriction | New area codes, Old area codes | New restricted areas are set. | See notes | 148.0 |
restriction_accel | Boolean | Restriction accel announcement is made. | See notes | 148.0 |
final_restriction | Restriction step | Restriction steps announcement is made in Duo/Squaed matching team mode. | See notes | 148.0 |
competitive_restriction | Restriction step | Restriction steps announcement is made in Solo matching team mode. | See notes | 148.0 |