Loading...

Game events API

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

Sample Apps

• Once Human 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	259.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	259.0

scene note

Possible Scene values:

• lobby
• ingame
• death

Data Example:

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

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
knockout	null	When the local player is knockout	See notes	259.0
level_up	null	When the local player level up	See notes	259.0
match_start	null	In the beginning of each match	See notes	259.0
match_end	null	At the end of each match	See notes	259.0
death	null	When the local player dies	See notes	259.0

knockout note

Data Example:

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

level_up note

Data Example:

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

match_start note

Data Example:

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

match_end note

Data Example:

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

death note

Data Example:

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

Events status

Loading...