Loading...

Game events API

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

Sample Apps

• Elden Ring Nightreign 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	260.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	281.0

scene note

Possible Scene values:

• lobby
• ingame
• death
• boss_fight

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	281.0
match_end	null	At the end of each match	See notes	281.0
death	death	When the local player dies	See notes	281.0
boss_fight	boss_fight	When the local player fight with a boss	See notes	281.0
day	day	When start a new day	See notes	292.0

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":"death"}]}

boss_fight note

Data Example:

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

day note

Data Example:

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

Events status

Loading...