- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
-
Support for these events is for 16:9 and 16:10 screen resolutions, the game window must be visible and should run with native screen resolution in fullscreen or fullscreen borderless.
-
This game requires enabling exclusive mode on your OW app's windows. Read more about OW exclusive mode.
-
In addition, when developing your app, you must comply with Activision’s Call of Duty: Warzone 2.0 terms and conditions. Supporting queue dodging, interfering with matchmaking or any such behavior is strictly prohibited, and will not be approved. If you have any doubt, please contact us directly before starting development.
For more information check our Game compliance principles
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 | 198.0 |
gep_internal note
Data Example:
{"info":{"gep_internal":{"version_info":"{"local_version":"198.0.0","public_version":"198.0.0","is_updated":true}"}},"feature":"gep_internal"}
match_info
Events
| Event | Event Data | Fired When | Notes | Since GEP Ver. |
|---|---|---|---|---|
| match_start | null | Match started. | See notes | 239.0 |
| match_end | null | Match ended and also data about the match outcome. | See notes | 239.0 |
match_start note
Data Example:
{"events":[{"name":"match_start","data":null}]}
match_end note
Match end event includes the match outcome
Possible values:
- victory
- defeat
Data Example:
{"events":[{"name":"match_end","data":victory}]}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| scene | game_info | current player's scene. | See notes | 239.0 |
| mode | game_info | current game mode selected by the player. | See notes | 239.0 |
scene note
Possible values:
- lobby_wz2
- airplane
- in_game
Data Example:
{"feature":"game_info","category":"game_info","key":"scene","value":"airplane"}
mode note
Data Example:
{"feature":"game_info","category":"game_info","key":"mode","value":"warzone"}