Loading...

Game events API

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

Sample Apps

• Roblox 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.
user_id	game_info	The local player user ID.	See notes	257.0

user_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"user_id","value":"9193"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
game_id	game_info	The current played minigame ID.	See notes	257.0
universe_id	match_info	The current played universe ID.	See notes	258.0

game_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"game_id","value":"15744137588"}

universe_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"universe_id","value":"3164075108"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	Round starts	See notes	257.0
match_end	null	Round ends	See notes	257.0
record_start	null	Record starts	See notes	257.0
record_end	null	Record ends	See notes	257.0

match_start note

Data Example:

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

match_end note

Data Example:

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

record_start note

Data Example:

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

record_end note

Data Example:

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

Events status

Loading...