Loading...

Game events API

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

Sample Apps

• 2XKO game events sample app

Available Features

• gep_internal
• game_info
• match_info

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event 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	287.0

gep_internal note

Data Example:

{"feature":"gep_internal","category":"gep_internal","key":"version_info","value":"{\"local_version\":\"287.0.1\",\"public_version\":\"287.0.1\",\"is_updated\":true}"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The name of the current scene.	See notes	287.0
player_name	game_info	The local player name and tagline	See notes	287.0

scene note

List of possible values:

• lobby

• inGame

• champion_select

• stage_select

Data Example:

{"feature":"game_info","category":"game_info","key":"scene","value":"lobby"}

player_name note

Data Example:

{"feature":"game_info","category":"game_info","key":"player_name","value":"Overwolf#1234"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
match_id	match_info	The match ID of the current match.	See notes	287.0
player_side	match_info	The side of the local player.	See notes	291.0
game_mode	match_info	The current selected game mode.	See notes	291.0
map	match_info	The current selected map.	See notes	291.0
champ_select	match_info	The current selected champions.	See notes	291.0
selected_fuse	match_info	The current selected fuse.	See notes	291.0
score	match_info	The score of the current match	See notes	291.0

match_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"match_id","value":"323ea434-265d-4b22-86e2-5121de2953ce"}

player_side note

Possible values:

• left
• right

Data Example:

{"feature":"match_info","category":"match_info","key":"player_side","value":"right"}

game_mode note

Data Example:

{"feature":"match_info","category":"match_info","key":"game_mode","value":"ranked"}

map note

Data Example:

{"feature":"match_info","category":"match_info","key":"map","value":"Bilgewater_Tavern"}

champ_select note

Data Example:

{"feature":"match_info","category":"match_info","key":"champ_select","value":"[{\"name\":\"Ekko\",\"side\":\"right\"},{\"name\":\"Darius\",\"side\":\"right\"}]"}

selected_fuse note

Data Example:

{"feature":"match_info","category":"match_info","key":"selected_fuse","value":"double_down"}

score note

Data Example:

{"feature":"match_info","category":"match_info","key":"score","value":"{\"local\":1,\"enemy\":0}"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	In the beginning of each match	See notes	287.0
match_end	null	At the end of each match	See notes	287.0
round_start	null	In the beginning of each round	See notes	287.0
round_end	null	At the end of each round	See notes	287.0
match_outcome	null	At the end of the current match	See notes	287.0

match_start note

Data Example:

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

match_end note

Data Example:

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

round_start note

Data Example:

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

round_end note

Data Example:

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

match_outcome note

Possible values:

• victory
• defeat

Data Example:

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

Events status

Loading...