Loading...

Game events API

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

Sample Apps

• Street Fighter 6 game events sample app

Available Features

• gep_internal
• game_info
• match_info

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	272.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"244.0.0","public_version":"258.0.0","is_updated":true}"}},"feature":"gep_internal"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The current scene-state	See notes	272.0
game_mode	game_info	The current game mode	See notes	272.0

scene note

Possible values:

• fighting_ground
• battle_hub
• ingame
• match_outcome

Data Example:

{"feature": "game_info", "category": "game_info", "key": "scene", "data": "fighting_ground"}

game_mode note

Possible values:

• fighting_ground
• battle_hub

Data Example:

{"feature": "game_info", "category": "game_info", "key": "game_mode", "data": "battle_hub"}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
round_start	null	In the beginning of each round	See notes	272.0
round_end	null	At the end of each round	See notes	272.0
match_start	null	In the beginning of each match	See notes	272.0
match_end	null	At the end of each match	See notes	272.0
match_outcome	null	Outcome of the current match	See notes	272.0

round_start note

Data Example:

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

round_end note

Data Example:

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

match_start note

Data Example:

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

match_end note

Data Example:

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

match_outcome note

Possible values:

• victory
• defeat

Data Example:

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

Events status

Loading...