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"}
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| map | match_info | Name of selected map. | See notes | 148.0 |
map note
Data Example:
{"info":{"match_info":{"map":"woods"}},"feature":"match_info"}
Possible map values:
- "laboratory" = The Lab
- "Tarkov Streets" = Streets of Tarkov
- "Suburbs" = Suburbs
- "Interchange" = Interchange
- "bigmap" = Customs
- "factory4_day" = Factory (day)
- "factory4_night" = Factory (night)
- "Woods" = Woods
- "Town" = Town
- "RezervBase" = Reserve
- "Lighthouse" = Lighthouse
- "Shoreline" = Shoreline
- "Terminal" = Terminal
- "TarkovStreets" = Streets of Tarkov
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | null | Match is found and about to start. | See notes | 148.0 |
| match_end | null | Match has ended. | See notes | 148.0 |
| death | null | Player died | See notes | 221.0 |
match_start note
Data Example:
{“event”:”match_start”,“data”:”null”}
match_end note
Data Example:
{“event”:”match_end”,“data”:”null”}
death note
Data Example:
{“event”:"death",“data”:”null”}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| phase | game_info | Current game state. | See notes | 148.0 |
phase note
Data Example:
{"info":{"game_info":{"phase":"scene_Login"}},"feature":"game_info"}
{"info":{"game_info":{"phase":"scene_ExitRaid"}},"feature":"game_info"}
{"info":{"game_info":{"phase":"scene_BattleUI"}},"feature":"game_info"}
{"info":{"game_info":{"phase":"scene_SelectRaidSide"}},"feature":"game_info"}
{"info":{"game_info":{"phase":"scene_SelectLocation"}},"feature":"game_info"}
{"info":{"game_info":{"phase":"scene_TimeHasCome"}},"feature":"game_info"}
Loading...