Loading...
- Game events API
Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.
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"}
game_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| scene | game_info | Current state (screen) of the game | See notes | 150.0 |
| sideboard_cards | game_info | Cards that are currently held in the sideboard. | See notes | 150.0 |
| main_deck_cards | game_info | Cards that are currently in your main deck. | See notes | 150.0 |
| inventory_cards | game_info | Card ID + Quantity. | See notes | 180.0 |
| inventory_stats | game_info | Current statistics and information of the local player's profile. | See notes | 180.0 |
scene note
Possible values:
- scene_home
- scene_event_page
- scene_deck_builder
- scene_draft_table
- scene_draft_table_queue: IKO_Premier_Draft
Data Example:
{"feature":"game_info","category":"game_info","key":"scene","value":"home"}
sideboard_cards note
Data Example:
{
"info": {
"game_info": {
"sideboard_cards": "{"
cards ":[{"
card_id ":71208,"
Wandering Monster ","
card_amount ":1}]}"
}
},
"feature": "game_info"
}
main_deck_cards note
Data Example:
{"info":{"game_info":{"main_deck_cards":"{"cards":[{"card_id":75487","card_amount":4},{"card_id":75498","card_amount":2},{"card_id":75504","card_amount":2},{"card_id":75488","card_amount":1},{"card_id":75490","card_amount":2},{"card_id":75492","card_amount":3},{"card_id":75505","card_amount":3},{"card_id":75506","card_amount":2},{"card_id":75493","card_amount":3},{"card_id":75494","card_amount":4},{"card_id":75499","card_amount":4},{"card_id":75502","card_amount":3},{"card_id":75501","card_amount":2},{"card_id":75503","card_amount":2},{"card_id":75486","card_amount":2},{"card_id":75495","card_amount":2},{"card_id":75489","card_amount":3},{"card_id":75557","card_amount":25}]}"}},"feature":"game_info"}
inventory_cards note
Data Example:
{"info":{"game_info":{"inventory_cards":"[{"card_id":77460,"quantity":1},{"card_id":77461,"quantity":1},{"card_id":77462,"quantity":1},{"card_id":77463,"quantity":1},{"card_id":77464,"quantity":1},{"card_id":77465,"quantity":1},{"card_id":77466,"quantity":1},{"card_id":77467,"quantity":1},{"card_id":77468,"quantity":1},{"card_id":77469,"quantity":1},{"card_id":77470,"quantity":1},{"card_id":77471,"quantity":1},{"card_id":77472,"quantity":1},{"card_id":77473,"quantity":1},{"card_id":77474,"quantity":1},{"card_id":77475,"quantity":1},{"card_id":77476,"quantity":1},{"card_id":77477,"quantity":1},{"card_id":77478,"quantity":1},{"card_id":77479,"quantity":1},{"card_id":77263,"quantity":3},{"card_id":77362,"quantity":1},{"card_id":77249,"quantity":2},{"card_id":77182,"quantity":1},{"card_id":77267,"quantity":2},{"card_id":77177,"quantity":3},{"card_id":77179,"quantity":4},{"card_id":77253,"quantity":3},{"card_id":77251,"quantity":2},{"card_id":77188,"quantity":4},{"card_id":77190,"quantity":1},{"card_id":77255,"quantity":2}]"}},"feature":"match_info"}
inventory_stats note
Data Example:
{"info":{"game_info":{"inventory_stats":"[{"WcCommon":35,"WcUncommon":34,"WcRare":10,"WcMythic":7,"Gold":5150,"Gems":1020,"WcTrack":15,"VaultProgress":1717986918}]"}},"feature":"match_info"}
match_info
Info Updates
| key | Category | Values | Notes | Since GEP Ver. |
|---|---|---|---|---|
| draft_pack | match_info | Pack number you currently pick for, time left to pick and pick number. | See notes | 150.0 |
| draft_cards | match_info | Name and ID of all picked cards during the draft. | See notes | 150.0 |
| draft_picked_card | match_info | Name and ID of currently picked card. | See notes | 150.0 |
draft_pack note
Data Example:
{
"info": {
"match_info": {
"draft_pack": "{"
pack_number ":1,"
pick_number ":2,"
pick_time ":70}"
}
},
"feature": "match_info"
}
draft_cards note
Updates each time you add/remove cards from your pack.
Data Example:
{
"info": {
"match_info": {
"draft_cards": "{"
cards ":[{"
id ":71319, "
name ":"
Rugged Highlands "}, {
"id": 71196
},
{
"id": 71219
},
{
"id": 71090
},
{
"id": 71307
},
{
"id": 71162
},
{
"id": 71098
},
{
"id": 71143
},
{
"id": 71309
},
{
"id": 71199
},
{
"id": 71215
}]
}
"}},
"feature": "match_info"
}
draft_picked_card note
Data Example:
{
"info": {
"match_info": {
"draft_picked_card": "{"
picked_card_id ":71073 , "
Coordinated Charge "}"
}
},
"feature": "match_info"
}
Events
| Event | Event Data | Fired When (announcement) | Notes | Since GEP Ver. |
|---|---|---|---|---|
| draft_start | null | When a draft has started. | See notes | 150.0 |
| draft_end | null | When a draft has ended. | See notes | 150.0 |
draft_start note
Data Example:
{"events":[{"name":"draft_start","data":""}]}
draft_end note
Data Example:
{"events":[{"name":"draft_end","data":""}]}
Loading...