Loading...

Game events API

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

Sample Apps

• Battlefield 6 game events sample app

Available Features

• gep_internal
• game_info
• match_info

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event status from your app 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.
scene	game_info	The current scene	See notes	292.0

scene note

Possible values:

• lobby
• ingame
• summary

Data Example:

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

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	Round starts	See notes	292.0
match_end	null	Round ends	See notes	292.0
elimination	elimination	An opponent is eliminated by player	See notes	292.0
knockdown	knockdown	The player is knocked down	See notes	292.0
round_outcome	victory	At the end of the current round	See notes	292.0

match_start note

Data Example:

{"events":[{"name":"match_start","data":""}]}

match_end note

Data Example:

{"events":[{"name":"match_end","data":""}]}

elimination note

Data Example:

{"events":[{"name":"elimination","data":"elimination"}]}

knockdown note

Data Example:

{"events":[{"name":"knockdown","data":"knockdown"}]}

round_outcome note

Possible values:

• victory
• defeat

Data Example:

{"events":[{"name":"round_outcome","data":"victory"}]}

Events status

Loading...