Loading...

Game events API

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

Sample Apps

• ARK: Survival Ascended game events sample app

Available Features

• gep_internal
• game_info
• match_info
• location

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	137.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.
world_name	game_info	The name of the current world	See notes	312.0
server_info	game_info	The name, address and port of the current server	See notes	312.0

world_name note

Data Example:

{"info":{"game_info":{"world_name":"TheIsland_WP"}},"feature":"game_info"}

server_info note

Data Example:

{"info":{"game_info":{"server_info":"{\"address\":\"5.62.112.62\",\"name\":\"EU-PVP-Arkpocalypse-TheIsland1 - (v93.19)\",\"port\":7777,\"type\":\"official\"}"}},"feature":"game_info"}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start		At the beginning of each match	See notes	312.0
match_end		At the end of each match	See notes	312.0
death		When the player dies	See notes	312.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":null}]}

location

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
location	Current location	The player moves	See notes	312.0
rotation	Current rotation	The player rotates	See notes	312.0

location note

Data Example:

{"events":[{"name":"location","data":"{\"x\":-104904.67,\"y\":227074.55,\"z\":-13974.61}"}]}

rotation note

Data Example:

{"events":[{"name":"rotation","data":"{\"direction\":90.57}"}]}

Events status

Loading...