Loading...

Game events API

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

Sample Apps

• Monster Hunter Wilds 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 here the game events status. OR - easily check the game events 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	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	274.0

scene note

Possible Scene values:

• lobby
• ingame

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	274.0
match_end	null	At the end of each match	See notes	274.0
quest_start	quest_start	When the local player start a quest	See notes	274.0
quest_complete	quest_complete	When the local player complete a quest	See notes	274.0
boss_kill	boss_kill	When the local player kill a boss in quest	See notes	274.0
quest_failed	quest_failed	When the local player failed a quest	See notes	274.0
death	death	When the local player dies	See notes	274.0

match_start note

Data Example:

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

match_end note

Data Example:

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

quest_start note

Data Example:

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

quest_complete note

Data Example:

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

boss_kill note

Data Example:

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

quest_failed note

Data Example:

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

death note

Data Example:

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

Events status

Loading...