Loading...

Game events API

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

Sample Apps

• Rematch game events sample app

Available Features

• gep_internal
• game_info
• match_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	272.0

gep_internal note

Data Example:

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

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
player_name	game_info	The local player name	See notes	281.0
player_id	game_info	The local player id	See notes	281.0
scene	game_info	The current scene-state	See notes	281.0
game_mode	game_info	The current selected mode	See notes	281.0

player_name note

Data Example:

{"feature": "game_info", "category": "game_info", "key": "player_name", "data": "some player name"}

player_id note

Data Example:

{"feature": "game_info", "category": "game_info", "key": "player_id", "data": 12345678}

scene note

Possible values:

• lobby
• ingame
• replay

Data Example:

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

game_mode note

Data Example:

{"feature": "game_info", "category": "game_info", "key": "game_mode", "data": "QuickMatch3v3"}
{"feature": "game_info", "category": "game_info", "key": "game_mode", "data": "custom"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
match_outcome	match_info	The game outcome	See notes	281.0
score	match_info	The game score	See notes	281.0

match_outcome note

Possible values:

• victory
• defeat
• draw

Data Example:

{"feature": "match_info", "category": "match_info", "key": "match_outcome", "data": "defeat"}

score note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "score", "data": {"right_score": 3, "left_score": 5}}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	In the beginning of each match	See notes	281.0
match_end	null	At the end of each match	See notes	281.0
team_goal	null	The local player team scored	See notes	281.0
opponent_goal	null	The opponent team scored	See notes	281.0

match_start note

Data Example:

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

match_end note

Data Example:

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

team_goal note

Data Example:

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

opponent_goal note

Data Example:

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

Events status

Loading...