Loading...
- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
Sample Apps
Available Features
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_name | me | Name of local player. | See notes | 148.0 |
| player_id | me | ID of the local player. | See notes | 148.0 |
| region | me | Region of the local player. | See notes | 148.0 |
| agent | me | Character Internal ID. | See notes | 149.0 |
| health | me | Character current health. | See notes | 238.0 |
| abilities | me | Current available abilities | See notes | 239.0 |
| server | me | Server of the local player. | See notes | 257.0 |
player_name note
Data Example:
{"info":{"me":{"player_name":"Doom#5339"}},"feature":"me"}
player_id note
Data Example:
{"info":{"me":{"player_id":"f4029eff-92e6-56db-adba-4d073df968a4"}},"feature":"me"}
region note
Data Example:
{"info":{"me":{"region":"esp"}},"feature":"me"}
agent note
Not all agents have their game name match their ID data, since this is an internal name, so take that into account. Furthermore, if a character has an ability that gives him different points of view (e.g. Sova with his drone), the ID will change accordingly to the drone.
Possible agent values:
- "Clay_PC_C" = Raze
- "Pandemic_PC_C" = Viper
- "Wraith_PC_C" = Omen
- "Hunter_PC_C" = Sova
- "Thorne_PC_C" = Sage
- "Phoenix_PC_C" = Phoenix
- "Wushu_PC_C" = Jett
- "Gumshoe_PC_C" = Cypher
- "Sarge_PC_C" = Brimstone
- "Breach_PC_C" = Breach
- "Vampire_PC_C" = Reyna
- "Killjoy_PC_C" = Killjoy
- "Guide_PC_C" = Skye
- "Stealth_PC_C" = Yoru
- "Rift_PC_C" = Astra
- "Grenadier_PC_C" = KAY/O
- "Deadeye_PC_C" = Chamber
- "Sprinter_PC_C" = Neon
- "BountyHunter_PC_C" = Fade
- "Mage_PC_C" = Harbor
- "AggroBot_PC_C" = Gekko
- "Cable_PC_C" = Deadlock
- "Sequoia_PC_C" = Iso
- "Smonk_PC_C" = Clove
- "Nox_PC_C" = Vyse
- "Cashew_PC_C" = Tejo
- "Terra_PC_C" = Waylay
Data Example:
{"info":{"me":{"agent":"Phoenix_PC_C"}},"feature":"me"}
health note
Data Example:
{"feature": "me", "category": "me", "key": "health", "data": "100"}
abilities note
Data Example:
{"feature": "me", "category": "me", "key": "abilities", "data": "{\"C\":true,\"Q\":true,\"E\":true,\"X\":false}"}
server note
Data Example:
{"feature":"me","category":"me","key":"server","value":"eu"}
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, unrelated to Riot. | 159.0 |
| round_number | match_info | Number of current round. | See notes | 149.0 |
| score | match_info | Amount of rounds won/lost. | See notes | 149.0 |
| match_score | match_info | Match score by teams | See notes | 258.0 |
| round_phase | match_info | Current state of the round. | See notes | 149.0 |
| team | match_info | Attack / Defense. | See notes | 149.0 |
| match_outcome | match_info | victory/defeat/draw. | See notes | 149.0 |
| round_report | match_info | * Total Damage * Total number of bullets hit. * Number of bullets hit on head. * Number of hit headshots that killed. | See notes | 150.0 |
| game_mode | match_info | The current played mode and whether or not it is ranked/custom | See notes | 151.0 |
| roster | match_info | * Player Name * Player ID * Name of picked character * Player's Rank * Whether it is the local player * If player is a teammate or not. | See notes | 151.0 |
| scoreboard | match_info | Scoreboard changes and updates during the game | See notes | 151.0 |
| kill_feed | match_info | kill feed updates during the game | See notes | 209.0 |
| map | match_info | Current played map name | See notes | 217.0 |
| escalation_stage | match_info | Each team's currnt weapon stage in Escalation game mode. | See notes | 250.0 |
| observing | match_info | The name of the palyer you are observing or coach (In custom mode only) | See notes | 257.0 |
| planted_site | match_info | A, B or C The sites where the bomb was planted in each round of a match | See notes | 261.0 |
| match_id | match_info | The ID of the current match | See notes | 262.0 |
| ui_team_order_allies | match_info | The order of the allies in the UI of the game | See notes | 283.0 |
| ui_team_order_enemies | match_info | The order of the enemies in the UI of the game | See notes | 283.0 |