- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
We are aware that recently an Epic Games version was released, and our events are currently unreliable in that version. Please make sure to use the events below for Steam and Standalone PoE versions
Sample Apps
Available Features
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_name note
Data Example:
{"info":{"me":{"character_name":"Shaelgaas"}},"feature":"me"}
character_level note
Data Example:
{"info":{"me":{"character_level":"31"}},"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 |
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 | TBD |
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"}
match_outcome note
Data Example:
{"events":[{"name":"match_outcome","data":"victory"}]}
{"events":[{"name":"match_outcome","data":"defeat"}]}
chat note
This event is not supported yet
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 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"}]}
game_info
This feature is not supported yet
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| language | language | The game's selected language | See notes | TBD |
| chat_language | language | The chat's selected language | See notes | TBD |
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"}