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 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	287.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"287.0.1","public_version":"287.0.1","is_updated":true}"}},"feature":"gep_internal"}

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

Data Example:

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

player_name note

Data Example:

{"info":{"game_info":{"player_name":"Overwolf#1234"}},"feature":"game_info"}

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
champ_select	match_info	The selected champs for the local player	See notes	287.0

match_id note

Data Example:

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

champ_select note

Data Example:

{"feature":"match_info","category":"match_info","key":"champ_select","value":"[\"Yasuo\",\"Braum\"]"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	Round starts	See notes	287.0
match_end	null	Round ends	See notes	287.0
round_start	null	Record starts	See notes	287.0
round_end	null	Record ends	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":""}]}

Events status

Loading...