Loading...

Game events API

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

Sample Apps

• Diablo 4 game events sample app

Available Features

• gep_internal
• game_info
• match_info
• location
• me

Game events status

It is highly recommended to communicate errors and warnings to your 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	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.
battlenet_tag	game_info	Player's battelnet tag	See notes	229.2
gold	gold	The player's gold across all characters	See notes	229.2

battlenet_tag note

Data Example:

{"feature":"game_info","category":"game_info","key":"battlenet_tag","value":"OverTheTop#2100"}

gold note

Data Example:

{"feature":"game_info","category":"gold","key":"gold","value":6512}

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start		In the beginning of each match after selecting your character	See notes	228.0
match_end		At the end of each match and exit to the main menu	See notes	228.0
death		When the character dies	See notes	235.0

match_start note

Data Example:

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

match_end note

Data Example:

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

death note

Data Example:

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

location

Info Updates

key	Category	Values	Notes	Since GEP Ver.
location	match_info	player location	See notes	229.1
map	match_info	Map name including area id and territory id	See notes	229.2

location note

Data Example:

{"feature":"location","category":"match_info","key":"location","value":"{\"x\" : -1001.76,\"y\" : 133.699,\"z\" : 77.6396}"}

map note

Area possible ID and names - See details

Territory possible ID and names - See details

Data Example:

{"feature":"location","category":"match_info","key":"map","value":"{\"area\" : 448837,\"territory\" : 445427}"}

me

Info Updates

key	Category	Values	Notes	Since GEP Ver.
name	character	Current character name	See notes	229.2
class	character	Current character class	See notes	229.2
level	character	Current character level	See notes	229.3
paragon_level	character	Current character paragon level - when available	See notes	270.0
xp	character	Current character xp	See notes	235.0
health	character	Current character health	See notes	235.0

name note

Data Example:

{"feature":"me","category":"character","key":"name","value":"Bruce"}

class note

List of possible values

• -1 = Invalid
• 176832 = "Barbarian Male"
• 232657 = "Barbarian Female"
• 338122 = "Druid Male"
• 421560 = "Druid Female"
• 430081 = "Necromancer Male"
• 502576 = "Necromancer Female"
• 486910 = "Rogue Male"
• 223602 = "Rogue Female"
• 220940 = "Sorcerer Male"
• 72908 = "Sorcerer Female"
• 1256872 = "Spiritborn Male"
• 1241729 = "Spiritborn Female"
• 2081670 = "Paladin Male"
• 2131351 = "Paladin Female"

Data Example:

{"feature":"me","category":"character","key":"class","value":220940}

level note

Data Example:

{"feature":"me","category":"character","key":"level","value":2}

paragon_level note

Data Example:

{"feature":"me","category":"character","key":"paragon_level","value":30}

xp note

Data Example:

{"feature":"me","category":"character","key":"xp","value":1498}

health note

Data Example:

{"feature":"me","category":"character","key":"health","value":80}

Events status

Loading...