Rainbow Six Siege Game events | Overwolf Developers

Game events API
Events status

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

Sample Apps

R6:Siege game events sample app

Available Features

gep_internal
game_info
match
match_info
roster
kill
death
me
defuser
damage

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.
phase	game_info	The current game scene/phase.	See notes	123.0
steam_id	game_info	The local player steam ID.	See notes	256.0

`phase` notes

Possible values:

lobby
teammates
announce
variation_setup
operator_select
loading
round_results

Example:

{"gameId":10826,"feature":"game_info","category":"game_info","key":"phase","value":"lobby"}

steam_id note

Data Example:

{"gameId":10826,"feature":"game_info","category":"game_info","key":"steam_id","value":"76561199232414254"}

`match_info`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
pseudo_match_id	match_info	The current match’s ID code.	See notes	130.0
game_mode	match_info	The current type of game mode.	See notes for possible values	228.1
match_id	match_info	The current match's ID.	See notes for possible values	162.1
map_id	match_info	The currently played map.	See notes for possible values	162.1
round_outcome_type	match_info	The type of win/loss of the last-played round.	See notes for possible values	165.0

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	When a match start.	See notes	211.0
match_end	null	When a match ends.	See notes	211.0
kill_feed	Kill feed data	When a kill feed entry is reported.	See notes	312.0

pseudo_match_id note

This is an internal Overwolf-generated code.

Data Example:

{"gameId":10826,"feature":"match_info","category":"match_info","key":"pseudo_match_id","value":"9800ba24-7da7-4e3a-8ab1-a74405780444"}

game_mode note

Data Example:

{"gameId":10826,"feature":"match_info","category":"match_info","key":"game_mode","value":"{\"playlist\": \"QUICK MATCH\" , \"game_type\": \"ESSENTIALS\" , \"mode_name\" : \"BOMB\"}"}

Possible values for playlist

QUICK MATCH
DUAL FRONT
UNRANKED
RANKED
DEATHMATCH
TUTORIAL
SHOOTING RANGE
LANDMARK DRILL
CLEAR HOUSE
FIELD TRAINING
CUSTOM

Possible values for game_type

ESSENTIALS
TRAINING

Possible values for mode_name

BOMB
SECURE AREA
HOSTAGE
DUAL FRONT
FREE FOR ALL
TEAM DEATHMATCH
BASICS
ATTACK
DEFENSE
SHOOTING RANGE
LANDMARK DRILL
CLEAR HOUSE
VERSUS AI

match_id note

The match_id returns on this format:

{"gameId":10826,"feature":"match_info","category":"match_info","key":"match_id","value":"64078ae1-87fe-4d94-a305-753546d2a1d2"}

map_id note

The map_id returns on this format:

{"gameId":10826,"feature":"match_info","category":"match_info","key":"map_id","value":"HOUSE"}

The possible values are:

HOUSE
OREGON
CLUB HOUSE
PLANE
BANK
KANAL
CHALET
KAFE DOSTOYEVSKY
YACHT
BORDER
FAVELA
SKYSCRAPER
COASTLINE
THEME PARK
TOWER
VILLA
FORTRESS
OUTBACK
EMERALD PLAINS
STADIUM BRAVO
STADIUM 2020
CONSULATE
NightHaven
LAIR

A full list of maps can be found here

round_outcome_type note

Data Example:

{"gameId":10826,"feature":"match_info","category":"match_info","key":"round_outcome_type","value":"team_has_been_eliminated"}

Possible values:

"team_has_been_eliminated"
"bomb_detonated"
"bomb_deactivated"
"objective_secured"
"objective_protected"
"time_has_expired"
"extracted_thehostages"
"killed_hostages"

match_start note

Data Example:

{"gameId":10826,"feature":"match_info","key":"match_start","value":null}

match_end note

Data Example:

{"gameId":10826,"feature":"match_info","key":"match_end","value":null}

kill_feed note

Data Example:

{"gameId":10826,"feature":"match_info","key":"kill_feed","value":"{\"attacker\":\"overwolfqa\",\"victim\":\"overwolfPTW\",\"weapon_type\":\"assault_rifle\",\"headshot\":false}"}

`match`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
number	round	Current round number	See notes	123.0
score	match	Match score	See notes	123.0

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
roundStart	null	Round starts.	See notes	123.0
roundEnd	null	Round ends.	See notes	123.0
roundOutcome	victory / defeat	Round concluded.	See notes	123.0
matchOutcome	victory / defeat	Match concluded.	See notes	123.0

number note

Data Example:

{"gameId":10826,"feature":"match","category":"match","key":"number","value":"1"}

match_score note

Match score info-update presents the score as it is in the game's UI, the local player is always in the blue team

Data Example:

{"gameId":10826,"feature":"match","category":"match","key":"score","value":"{\"blue\":\"1\",\"orange\":\"0\"}"}

roundStart note

Data Example:

{"gameId":10826,"feature":"match","key":"roundStart","value":null}

roundEnd note

Data Example:

{"gameId":10826,"feature":"match","key":"roundEnd","value":null}

roundOutcome note

Data Example:

{"gameId":10826,"feature":"match","key":"roundOutcome","value":"victory"}

matchOutcome note

Data Example:

{"gameId":10826,"feature":"match","key":"matchOutcome","value":"victory"}

`roster`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
roster_XX	players	Provides info for the currently active players (10 players).	See notes	123.0
health	player	Player’s current health	See notes	123.0
score	player	Player’s current score or `null`	See notes	123.0
kills	player	Total number of kills by the player or `null`	See notes	123.0
deaths	player	Total number of player's deaths or `null`	See notes	123.0

`roster_XX` notes

Each player joining the game will be reported in the following way:

Backslashes were omitted for legibility.

{"gameId":10826,"feature":"roster","category":"players","key":"roster_0","value":"{\"player\":\"overwolfqa\",\"is_anonymous\":false,\"suffix\":0,\"player_id\":\"e558fedb-ed64-4d8f-9758-c1bffca8abd8\",\"is_local\":true,\"team\":\"Blue\",\"role\":\"defender\",\"operator\":\"SENTRY\",\"kills\":0,\"deaths\":0,\"score\":0,\"assists\":0,\"ping\":0}"}

This object includes:

player - player's name + suffix Important note - "name" is the player's username or nickname if enabled
is_anonymous - Boolean if the player's privacy is set to true or false
suffix - the player's suffix
player_id - the player's ID
is_local - is the player the local player true or false
team - Blue/Orange
kills - Total amount of kills made by the player
deaths - Total amount of deaths
assists - Total amount of assists
score - Player score in the current round
ping - the ping of the player
operator - the name of the current operator

When one of the players leaves the match, the relevant “roster_ XX” object will be updated to:

{"players":{"roster_3":null}}

If a new player replaces a leaver, a new “roster_XX” object will be assigned to the new player who joined.

health note

Current health of the player Important! - health always includes 20 points for the knockout stage, so the event will always add 20 health points more than the game

{"gameId":10826,"feature":"roster","category":"roster","key":"health","value":"41"}

score note

{"gameId":10826,"feature":"roster","category":"roster","key":"score","value":"100"}

kills note

{"gameId":10826,"feature":"roster","category":"roster","key":"kills","value":"2"}

deaths note

{"gameId":10826,"feature":"roster","category":"roster","key":"deaths","value":"1"}

`kill`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
kill	null	Local player killed an enemy	See notes	123.0
headshot	null	Local player killed an enemy with a headshot	See notes	123.0

kill note

{"gameId":10826,"feature":"kill","key":"kill","value":null}

headshot note

{"gameId":10826,"feature":"kill","key":"headshot","value":null}

`death`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
knockedout	null	Local player is knockedout	See notes	123.0
death	null	Local player dies	See notes	123.0
killer	Killer id	The local player was killed by an enemy	See notes	123.0

knockedout note

Data Example:

{"gameId":10826,"feature":"knockedout","key":"knockedout","value":""}

death note

Data Example:

{"gameId":10826,"feature":"death","key":"death","value":null}

killer note

Data Example:

{"gameId":10826,"feature":"death","key":"killer","value":"e558fedb-ed64-4d8f-9758-c1b11ca8abd8"}

`me`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
name	me	Local player's in-game name.	See notes	148.0

name note

Data Example:

{"gameId":10826,"feature":"me","category":"me","key":"name","value":"e558fedb-ed64-4d8f-9758-c1bffca8abd8"}

Important note - "name" is the player's username or nickname if enabled

`defuser`

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
defuser_planted	null	Defuser was planted.	See notes	162.1
defuser_disabled	null	Defuser was disabled.	See notes	165.0

defuser_planted note

Data Example:

{"gameId":10826,"feature":"defuser_planted","key":"defuser_planted","value":""}

defuser_disabled note

Data Example:

{"gameId":10826,"feature":"defuser_disabled","key":"defuser_disabled","value":""}

`damage`

Info Updates

key	Category	Values	Notes	Since GEP Ver.
round_damage_report	damage	A post-round damage breakdown between the local player and each opponent.	See notes	314.0

round_damage_report note

Reported for the round that just ended. The opponents array holds one entry per opponent the local player exchanged damage with, where outgoing is the damage the local player dealt to that opponent, and incoming is the damage that opponent dealt to the local player.

Each entry in hit_locations is keyed by the body part that was hit (for example head, body, pelvis, arms, legs), and includes the number of hits, the total damage, and the hit_types that caused it (for example bullet, explosive, melee).

Data Example:

{"gameId":10826,"featureName":"damage","categoryName":"damage","key":"round_damage_report","value":{"round_number":2,"opponents":[{"player_name":"KingWolf.over","operator":"MELUSI","outgoing":{"total_damage":145,"hit_locations":{"body":{"hits":2,"damage":145,"hit_types":["bullet","explosive"]}}},"incoming":{"total_damage":27,"hit_locations":{"pelvis":{"hits":1,"damage":27,"hit_types":["bullet"]}}}}]}}

Sample Apps​

Available Features​

Game event status​

gep_internal​

Info Updates​

gep_internal note​

game_info​

Info Updates​

phase notes​

steam_id note​

match_info​

Info Updates​

Events​

pseudo_match_id note​

game_mode note​

match_id note​

map_id note​

round_outcome_type note​

match_start note​

match_end note​

kill_feed note​

match​

Info Updates​

Events​

number note​

match_score note​

roundStart note​

roundEnd note​

roundOutcome note​

matchOutcome note​

roster​

Info Updates​

roster_XX notes​

health note​

score note​

kills note​

deaths note​

kill​

Events​

kill note​

headshot note​

death​

Events​

knockedout note​

death note​

killer note​

me​

Info Updates​

name note​

defuser​

Events​

defuser_planted note​

defuser_disabled note​

damage​

Info Updates​

round_damage_report note​

Sample Apps

Available Features

Game event status

`gep_internal`

Info Updates

gep_internal note

`game_info`

Info Updates

`phase` notes

steam_id note

`match_info`

Info Updates

Events

pseudo_match_id note

game_mode note

match_id note

map_id note

round_outcome_type note

match_start note

match_end note

kill_feed note

`match`

Info Updates

Events

number note

match_score note

roundStart note

roundEnd note

roundOutcome note

matchOutcome note

`roster`

Info Updates

`roster_XX` notes

health note

score note

kills note

deaths note

`kill`

Events

kill note

headshot note

`death`

Events

knockedout note

death note

killer note

`me`

Info Updates

name note

`defuser`

Events

defuser_planted note

defuser_disabled note

`damage`

Info Updates

round_damage_report note