Loading...

Game events API

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

Sample Apps

• Honkai Star Rail 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	253.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"253.0.0","public_version":"253.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	253.0

scene note

Possible Scene values:

• lobby
• ingame
• battle
• outcome

Data Example:

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

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	In the beginning of each match	See notes	253.0
match_end	null	At the end of each match	See notes	253.0
battle_start	null	In the beginning of each battle	See notes	253.0
battle_end	null	At the end of each battle	See notes	253.0
match_outcome	victory/defeat	The result of the battle	See notes	253.0

match_start note

Data Example:

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

match_end note

Data Example:

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

battle_start note

Data Example:

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

battle_end note

Data Example:

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

match_outcome note

Data Example:

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

Events status

Loading...