Loading...

Game events API

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

Sample Apps

• World of Warcraft game events sample app

An official Blizzard API is available at the following link - https://develop.battle.net/. If you have further requests for events that you require please contact us at developers@overwolf.com

Available Features

• gep_internal
• game_info
• location
• player_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	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.
group_applicants	game_info	The number of applicants and information regarding their item score, role, class and name of their server.	See notes	146.0.7

group_applicants note

Data Example:

{
  "info": {
    "game_info": {
      "group_applicants": "{\"Noupak\":{\"player_name\" : \"overwolf\", \"server_name\" : \"Drak'thul\", \"applicant_id\" : \"1\", \"application_status\" : \"10\", \"level\" : \"70\", \"item_level\" : \"406\", \"honor_level\" : \"0\", \"role\" : \"8\",\"rating\" : \"2037\",\"class\" : \"1\"}}"
    }
  },
  "feature": "game_info"
}

Possible values for application_status:

• 0 - None
• 1 - Applied
• 2 - Invited
• 3 - Failed
• 4 - Cancelled
• 5 - Declined
• 6- DeclinedFull
• 7 - DeclinedDelist
• 8 - Timedout
• 9 - Invitedeclined
• 10 - Inviteaccepted

Possible values for role:

• 2- tank
• 4- healer
• 8- damage

Possible values for class:

• Warrior = 1
• Paladin = 2
• Hunter = 3
• Rogue = 4
• Priest = 5
• Death Knight = 6
• Shaman = 7
• Mage = 8
• Warlock = 9
• Monk = 10
• Druid = 11
• Demon Hunter = 12

location

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
location	Current player coordinates (x, y) and map ID (map)	The player moves	See notes	315.0

location note

Data Example:

{"gameId":765,"feature":"location","key":"location","value":"{\"x\" : 53.5386,\"y\" : 3.73504,\"map\" : 84}"}

player_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
player_level	player_info	The player's current level	See notes	315.0
player_exp	player_info	The player's current experience points	See notes	315.0
player_exp_max	player_info	The experience points required for the player's next level	See notes	315.0
player_money_gold	player_info	The amount of gold the player has	See notes	315.0
player_money_silver	player_info	The amount of silver the player has	See notes	315.0
player_money_copper	player_info	The amount of copper the player has	See notes	315.0

player_info note

Data Examples:

{"gameId":765,"feature":"player_info","category":"player_info","key":"player_level","value":"70"}
{"gameId":765,"feature":"player_info","category":"player_info","key":"player_exp","value":"1574"}
{"gameId":765,"feature":"player_info","category":"player_info","key":"player_exp_max","value":"58645"}
{"gameId":765,"feature":"player_info","category":"player_info","key":"player_money_gold","value":"4893"}
{"gameId":765,"feature":"player_info","category":"player_info","key":"player_money_silver","value":"40"}
{"gameId":765,"feature":"player_info","category":"player_info","key":"player_money_copper","value":"83"}

addons

Deprecated

Support for this event has been marked as deprecated, due to lack of usage/support.

Info Updates

key	Category	Values	Notes	Since GEP Ver.
addon_xx	addons	Name, version number (if exists), and status of addon.	See notes	189.0

addon note

Data Example:

Possible values:

• 0 - Loading
• 1 - Loaded
• 2 - Disabled
• 3 - Unknown

{"info":{"addons":{"addon_10":"{"name":"DBM-StatusBarTimers","version":"8110645","status":"1"}"}},"feature":"addons"}

Events status

Loading...