Loading...

Game events API

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

Sample Apps

• TARKOV game events sample app

Available Features

• gep_internal
• match_info
• game_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	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"}

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
map	match_info	Name of selected map.	See notes	148.0
raid_type	match_info	Name of the raid type scav/pmc.	See notes	270.0
session_type	match_info	Name of the session type pvp/pve.	See notes	274.0

map note

Data Example:

{"info":{"match_info":{"map":"woods"}},"feature":"match_info"}

Possible map values:

• "laboratory" = The Lab
• "Tarkov Streets" = Streets of Tarkov
• "Suburbs" = Suburbs
• "Interchange" = Interchange
• "bigmap" = Customs
• "factory4_day" = Factory (day)
• "factory4_night" = Factory (night)
• "Woods" = Woods
• "Town" = Town
• "RezervBase" = Reserve
• "Lighthouse" = Lighthouse
• "Shoreline" = Shoreline
• "Terminal" = Terminal
• "TarkovStreets" = Streets of Tarkov

raid_type note

Data Example:

{"feature":"match_info","category":"match_info","key":"raid_type","value":"scav"}

session_type note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "session_type", "data": "PVP"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	Match is found and about to start.	See notes	148.0
match_end	null	Match has ended.	See notes	148.0
death	null	Player died	See notes	221.0

match_start note

Data Example:

{“event”:”match_start”,“data”:”null”}

match_end note

Data Example:

{“event”:”match_end”,“data”:”null”}

death note

Data Example:

{“event”:"death",“data”:”null”}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
phase	game_info	Current game state.	See notes	148.0
quests_list	match_info	List of the local player quests status.	See notes	274.0

phase note

Data Example:

{"info":{"game_info":{"phase":"scene_Login"}},"feature":"game_info"}

{"info":{"game_info":{"phase":"scene_ExitRaid"}},"feature":"game_info"}

{"info":{"game_info":{"phase":"scene_BattleUI"}},"feature":"game_info"}

{"info":{"game_info":{"phase":"scene_SelectRaidSide"}},"feature":"game_info"}

{"info":{"game_info":{"phase":"scene_SelectLocation"}},"feature":"game_info"}

{"info":{"game_info":{"phase":"scene_TimeHasCome"}},"feature":"game_info"}

quests_list note

List of parameters:

• trader
• quest
• quest_id
• quest_type
• quest_status
• location
• level

Data Example:

{"feature": "game_info", "category": "game_info", "key": "quests_list", "data": "[{\"trader\":\"Prapor\",\"quest\":\"Debut\",\"quest_id\":\"5936d90786f7742b1420ba5b\",\"quest_type\":\"Elimination\",\"quest_status\":\"Started\",\"location\":\"any\",\"level\":0},{\"trader\":\"Therapist\",\"quest\":\"First in Line\",\"quest_id\":\"657315ddab5a49b71f098853\",\"quest_type\":\"PickUp\",\"quest_status\":\"Started\",\"location\":\"Ground Zero\",\"level\":0},{\"trader\":\"Prapor\",\"quest\":\"Shooting Cans\",\"quest_id\":\"657315df034d76585f032e01\",\"quest_type\":\"Elimination\",\"quest_status\":\"Success\",\"location\":\"Ground Zero\",\"level\":0},{\"trader\":\"Skier\",\"quest\":\"Burning Rubber\",\"quest_id\":\"657315e270bb0b8dba00cc48\",\"quest_type\":\"Exploration\",\"quest_status\":\"AvailableForStart\",\"location\":\"Ground Zero\",\"level\":0},{\"trader\":\"Mechanic\",\"quest\":\"Saving the Mole\",\"quest_id\":\"657315e4a6af4ab4b50f3459\",\"quest_type\":\"PickUp\",\"quest_status\":\"AvailableForStart\",\"location\":\"Ground Zero\",\"level\":0}]"}

Events status

Loading...