Loading...

Game events API

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

info

Note that Roblox and Roblox - Rivals share the same Game ID.

In order to check the API health of this minigme check the tracking ID number

Sample Apps

• Roblox game events sample app

Available Features

• gep_internal
• inventory

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.
scene	game_info	The current scene	See notes	304.0

steam_id note

Data Example:

{"feature":"game_info","category":"game_info","key":"steam_id","value":76561198088746530}

scene note

Possible values:

• lobby
• ingame
• summary

Data Example:

{"feature":"game_info","category":"game_info","key":"scene","value":"ingame"}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
game_start	null	Match in rivals game mode start	See notes	304.0
game_end	null	Match in rivals game mode end	See notes	304.0
elimination	number of eliminations	An opponent is eliminated by a team member	See notes	304.0
death	number of deaths	The local player died	See notes	304.0

game_start note

Data Example:

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

game_end note

Data Example:

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

elimination note

Data Example:

{"events":[{"name":"elimination","data":1}]}

death note

Data Example:

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

Events status

Loading...