Loading...

Game events API

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.

danger

• The implementation of this game's GEP is experimental and is considered a Beta version

• Support for these events is for English only and for 16:9 and 16:10 screen resolutions, the game window must be visible and should run with native screen resolution.

• 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: Vanguard 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

• Vanguard game events sample app

Available Features

• gep_internal
• match_info
• game_info
• me
• kill
• death

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	198.0
match_end	null	Match ended and also data about the match outcome.	See notes	198.0
round_outcome	null	Current round result.	See notes	198.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}]}

round_outcome note

Data Example:

{"name":"round_outcome","data":"defeat"}
{"name":"round_outcome","data":"victory"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	current player's scene.	See notes	198.0
game_mode	game_info	current game mode selected by the player.	See notes	198.0

scene note

Possible values:

• lobby
• inGame

Data Example:

{"feature":"game_info","category":"game_info","key":"scene","value":"lobby"}

game_mode note

Possible values:

• free_for_all
• team_deathmatch
• kill_confirmed
• domination
• search_destroy
• hardpoint
• control
• patrol
• champion_hill
• arms_race

Data Example:

{"feature":"game_info","category":"game_info","key":"game_mode","value":"domination"}

me

Info Updates

key	Category	Values	Notes	Since GEP Ver.
player_name	me	current player's name.	See notes	198.0

player_name note

Data Example:

{"feature":"me","category":"me","key":"player_name","value":"someUser"}

kill

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
kill	null	Local player has performed a kill.	See notes	198.0

kill note

Data Example:

{"events":[{"name":"kill","data":null}]}

death

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
death	null	Local player has died.	See notes	198.0

death note

Data Example:

{"events":[{"name":"death","data":null}]}

Events status

Loading...