Loading...

Game events API

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

Sample Apps

• Path of Exile game events sample app

Available Features

• gep_internal
• kill
• death
• me
• match_info
• game_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"}

kill

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
boss_kill	Name of boss	Boss was killed	See notes	268.0

boss_kill note

Data Example:

{"events":[{"name":"boss_kill","data":"Fire Fury"}]}

death

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
death	null	Local player died	See notes	268.0

death note

Data Example:

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

me

Info Updates

key	Category	Values	Notes	Since GEP Ver.
character_name	me	Local player nickname.	See notes	268.0
character_level	me	Local player level.	See notes	268.0
character_exp	me	Local player experience.	See notes	269.0
character_class	me	Local player class.	See notes	291.0
character_gold	me	Local player gold amount.	See notes	311.0

character_name note

Data Example:

{"info":{"me":{"character_name":"Shaelgaas"}},"feature":"me"}

character_level note

Data Example:

{"info":{"me":{"character_level":31}},"feature":"me"}

character_exp note

Data Example:

{"feature":"me","category":"me","key":"character_exp","value":684}

character_class note

Data Example:

{"info":{"me":{"character_class":"Witch"}},"feature":"me"}

character_gold note

Data Example:

{"info":{"me":{"character_gold":74}},"feature":"me"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
current_zone	match_info	Name of the current zone	See notes	268.0
opened_page	match_info	Whether inventory is open/closed	See notes	268.0
opened_pages	match_info	The list of currently opened pages.	See notes	311.0
in_town	match_info	Whether the player is in town or hideout true/false	See notes	269.0

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_outcome	victory/defeat	Boss killed/You died.	See notes	268.0
chat	Chat messages	A message is sent / received in the chat.	See notes	269.0
match_start	null	The match started	See notes	271.0
match_end	null	The match ended	See notes	271.0

current_zone note

Data Example:

{"info":{"match_info":{"current_zone":"Lioneye's Watch"}},"feature":"match_info"}

opened_page note

Possible values:

• inventory
• passive_tree
• character_sheet
• stash
• map_device
• pantheon
• crafting_bench

Data Example:

{"info":{"match_info":{"opened_page":"inventory"}},"feature":"match_info"}
{"info":{"match_info":{"opened_page":null}},"feature":"match_info"}

opened_pages note

Possible values:

• inventory
• passive_tree
• character_sheet
• stash
• map_device
• pantheon
• crafting_bench
• market

Data Example:

{"feature":"match_info","category":"match_info","key":"opened_pages","data":"[\"character_sheet\",\"inventory\"]"}

in_town note

Data Example:

{"info":{"match_info":{"in_town":true}},"feature":"match_info"}

match_outcome note

Data Example:

{"events":[{"name":"match_outcome","data":"victory"}]}
{"events":[{"name":"match_outcome","data":"defeat"}]}

chat note

This event is intended for real-time usage only, and its content should not be logged.

Special symbols in the chat messages:

• Starting with # - global chat
• Starting with @ - whisper - private chat
• Starting with $ - trade
• Starting with & - guild
• Starting with % - party
• Without special symbol - local chat

Items in chat messages

Items in chat messages start with | (vertical bar) and end with |

Data Example:

{"events":[{"name":"chat","data":"You have entered Lioneye's Watch."}]}
{"events":[{"name":"chat","data":"#yaoiLNine: some text"}]}
{"events":[{"name":"chat","data":"#Rodger_The_Sausage: |Agony Shadows, Alleyways Map||Agony Shadows, Alleyways Map||Remote Nexus, Crimson Temple Map| free"}]}

match_start note

Data Example:

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

match_end note

Data Example:

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

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
language	language	The game's selected language	See notes	269.0
chat_language	language	The chat's selected language	See notes	269.0
scene	game_info	The name of the current scene.	See notes	271.0
party_players	game_info	The list of players that are in party.	See notes	288.0

language note

Both 'language' and 'chat_language' info-updates are updated once at the beginning of the game

Data Example:

{"info":{"language":{"language":"en"}},"feature":"game_info"}

chat_language note

Both 'language' and 'chat_language' info-updates are updated once at the beginning of the game

Data Example:

{"info":{"language":{"chat_language":"fr"}},"feature":"game_info"}

scene note

List of possible values:

• login
• select_character
• loading
• in_game
• escape_menu

Data Example:

{"info":{"game_info":{"scene":"login"}},"feature":"game_info"}

party_players note

Data Example:

{"feature":"game_info","category":"game_info","key":"party_players","value":"[{\"name\" : \"bosskillsama\", \"account\" : \"test00765#7856\", \"league\" : \"Standard\", \"class\" : 7, \"level\" : 4},{\"name\" : \"bestyFox\", \"account\" : \"Overwolf_#5831\", \"league\" : \"Standard\", \"class\" : 7, \"level\" : 4}]"}

Events status

Loading...