Loading...

Game events API

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

Sample Apps

• Hytale 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	252.0

gep_internal note

Data Example:

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

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
player_name	game_info	The local player's name	See notes	296.0
player_id	game_info	The local player's id	See notes	296.0
phase	game_info	The actual phase	See notes	296.0
world_name	game_info	The name of the selected world	See notes	296.0

player_name note

Data Example:

{"feature":"game_info","category":"game_info","key":"player_name","value":"Rodnix"}

player_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"player_id","value":"17b6109a-309e-4203-9c6e-b348dd888ade"}

phase note

Possible values:

• Startup
• MainMenu
• GameLoading
• InGame
• Exited

Data Example:

{{"feature":"game_info","category":"game_info","key":"phase","value":"MainMenu"}}

world_name note

Data Example:

{"feature":"game_info","category":"game_info","key":"world_name","value":"new world"}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	In the beginning of the game	See notes	296.0
match_end	null	At the end of the game	See notes	296.0

match_start note

Data Example:

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

match_end note

Data Example:

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

Events status

Loading...