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"}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| phase | game_info | The current game scene/phase. | See notes | 123.0 |
| steam_id | game_info | The local player steam ID. | See notes | 256.0 |
phase notes
Possible values:
- lobby
- teammates
- announce
- variation_setup
- operator_select
- loading
- round_results
Example:
{"gameId":10826,"feature":"game_info","category":"game_info","key":"phase","value":"lobby"}
steam_id note
Data Example:
{"gameId":10826,"feature":"game_info","category":"game_info","key":"steam_id","value":"76561199232414254"}
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.0 |
| game_mode | match_info | The current type of game mode. | See notes for possible values | 228.1 |
| match_id | match_info | The current match's ID. | See notes for possible values | 162.1 |
| map_id | match_info | The currently played map. | See notes for possible values | 162.1 |
| round_outcome_type | match_info | The type of win/loss of the last-played round. | See notes for possible values | 165.0 |
| general_log | match_info | General information regarding the current created match. | See notes for possible values | 186.0 |
| match_start_log | match_info | Information regarding the start of the match. | See notes for possible values | 186.0 |
| round_start_log | match_info | Information regarding the start of the round. | See notes for possible values | 186.0 |
| round_end_log | match_info | Information regarding the end of the round. | See notes for possible values | 186.0 |
| move_log | match_info | movement information. | See notes for possible values | 186.0 |
| score_log | match_info | score information. | See notes for possible values | 186.0 |
| kill_log | match_info | Information regarding kills. | See notes for possible values | 186.0 |
| ko_log | match_info | Information regarding knockout. | See notes for possible values | 186.0 |
| death_log | match_info | Information regarding death. | See notes for possible values | 186.0 |
| match_end_log | match_info | Information regarding the end of match. | See notes for possible values | 186.0 |
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | null | When a match start. | See notes | 211.0 |
| match_end | null | When a match ends. | See notes | 211.0 |