Loading...

Game events API

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

Sample Apps

• Wardogs game events sample app

Available Features

• gep_internal
• 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	143.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"317.0.0","public_version":"317.0.0","is_updated":true}"}},"feature":"gep_internal"}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	A match starts.	See notes	317.0
match_end	null	A match ends.	See notes	317.0
respawn	null	The local player respawns.	See notes	317.0
death	Number of deaths	The local player dies.	See notes	317.0
killer	Killer's name	The local player is killed by another player.	See notes	317.0
revive	Reviver's name	The local player is revived by a teammate.	See notes	317.0
damage_received	Damage amount	The local player receives damage.	See notes	317.0
control_zone_points	Points	The local player's team scores control zone points.	See notes	317.0

match_start note

Data Example:

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

match_end note

Data Example:

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

respawn note

Data Example:

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

death note

Data Example:

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

killer note

Data Example:

{"events":[{"name":"killer","data":"RoDniK"}]}

revive note

Data Example:

{"events":[{"name":"revive","data":"RoDniK"}]}

damage_received note

Data Example:

{"events":[{"name":"damage_received","data":"100"}]}

control_zone_points note

Data Example:

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

Info Updates

key	Category	Values	Notes	Since GEP Ver.
match_id	match_info	The unique ID of the current match.	See notes	317.0
match_mode	match_info	The current match mode.	See notes	317.0
cash	match_info	The local player's cash summary.	See notes	317.0
xp	match_info	The local player's XP per class.	See notes	317.0

match_id note

Data Example:

{"info":{"match_info":{"match_id":"f40552f7-130c-44f9-93c1-ee8898400898"}},"feature":"match_info"}

match_mode note

Data Example:

{"info":{"match_info":{"match_mode":"KOTH"}},"feature":"match_info"}

cash note

List of parameters:

• total
• earned
• earned_current_life
• eom
• eom_faction_place_bonus
• eom_faction_win_bonus
• eom_match_completion_bonus
• eom_refund
• profit
• profit_current_life
• spent
• spent_current_life

Data Example:

{"info":{"match_info":{"cash":"{\"total\":18448,\"earned\":0,\"earned_current_life\":0,\"eom\":0,\"eom_faction_place_bonus\":0,\"eom_faction_win_bonus\":0,\"eom_match_completion_bonus\":0,\"eom_refund\":0,\"profit\":0,\"profit_current_life\":0,\"spent\":0,\"spent_current_life\":0}"}},"feature":"match_info"}

xp note

List of parameters:

• level
• driver
• infantry
• medic
• pilot
• recon
• support

Data Example:

{"info":{"match_info":{"xp":"{\"level\":0,\"driver\":0,\"infantry\":1225,\"medic\":462,\"pilot\":1466,\"recon\":0,\"support\":0}"}},"feature":"match_info"}

location

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
location	Player's x, y, z coordinates	The local player's location changes.	See notes	317.0

location note

Data Example:

{"events":[{"name":"location","data":"{\"x\":-904.22,\"y\":-2307.67,\"z\":93.23}"}]}

Events status

Loading...