Skip to main content

Rainbow Six Siege

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

Sample Apps

Available Features

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check game event status here or easily check game event status directly from your app using our API.

gep_internal

Info Updates

keyCategoryValuesNotesSince GEP Ver.
gep_internalgep_internalLocal + Public version numberSee notes143.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

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe current game scene/phase.See notes123.0

phase notes

Possible values:

  • lobby
  • teammates
  • announce
  • operator_select
  • loading
  • round_results

Example:

{"game_info":{"phase":"operator_select"}}

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoThe current match’s ID code. Example:
0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
This is an internal Overwolf-generated code.130.0
game_modematch_infoThe current type of game mode.See notes for possible values134.0
game_mode_logmatch_infoGame mode information.See notes for possible values186.0
match_idmatch_infoThe current match's ID.See notes for possible values162.1
map_idmatch_infoThe currently played map.See notes for possible values162.1
round_outcome_typematch_infoThe type of win/loss of the last-played round.See notes for possible values165.0
general_logmatch_infoGeneral information regarding current created-match.See notes for possible values186.0
match_start_logmatch_infoInformation regarding start of the match.See notes for possible values186.0
round_start_logmatch_infoInformation regarding start of the round.See notes for possible values186.0
round_end_logmatch_infoInformation regarding end of the round.See notes for possible values186.0
move_logmatch_infoInformation regarding movement.See notes for possible values186.0
score_logmatch_infoInformation regarding score.See notes for possible values186.0
kill_logmatch_infoInformation regarding kills.See notes for possible values186.0
ko_logmatch_infoInformation regarding knockout.See notes for possible values186.0
death_logmatch_infoInformation regarding death.See notes for possible values186.0
match_end_logmatch_infoInformation regarding end of match.See notes for possible values186.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
match_startnullWhen a match start.See notes211.0
match_endnullWhen a match ends.See notes211.0

game_mode note

The game_mode returns on this format:

{"info":{"match_info":{"game_mode":"THE_SELECTED_GAME_MODE"}},"feature":"match_info"}

While the possible values are:

  • No mode was selected: NONE
  • Multiplayer > Newcomer: MATCHMAKING_PVP_NEWCOMER
  • Multiplayer > Quick Match: MATCHMAKING_PVP
  • Multiplayer > Special Event: MATCHMAKING_PVP_EVENT
  • Multiplayer > Arcade Playlist: MATCHMAKING_PVP_EVENT
  • Multiplayer > Unranked: MATCHMAKING_PVP_UNRANKED
  • Multiplayer > Ranked: MATCHMAKING_PVP_RANKED
  • Multiplayer > Deathmatch: MATCHMAKING_PVP_WARMUP
  • Multiplayer > Custom game > Local: CUSTOMGAME_PVP
  • Multiplayer > Custom game > Online: CUSTOMGAME_PVP_DEDICATED
  • Player vs. AI > Situations: OPERATIONS
  • Player vs. AI > Training Grounds Lonewolf: MATCHMAKING_PVE_LONEWOLF
  • Player vs. AI > Training Grounds with Squad only: MATCHMAKING_PVE_PARTY
  • Player vs. AI > Training Grounds Online: MATCHMAKING_PVE
  • Match Replay > Watching the replay of a previous match: MATCHREPLAY
  • Tutorials: It’s just a video tutorial, not a game mode.

Note that in Custom games, Training Grounds, or in Match Replay, there is no support for Overwolf real time game events

game_mode_log note

Data example:

{"info":{"match_info":{"game_mode_log":"{"GameModes":7,"MatchType":"MATCHMAKING_PVP"}"}},"feature":"match_info"}

match_id note

The match_id returns on this format:

{"info":{"match_info":{"match_id":"18F5D014-3FB9-0510-9083-DF555E39AD2B"}},"feature":"match_info"}

map_id note

The map_id returns on this format:

{"info":{"match_info":{"map_id":"BANK"}},"feature":"match_info"}

The possible values are:

  • BANK
  • BARLETT UNIVERSITY (note that the actual map name in-game is named Bartlett U.)
  • BORDER
  • COASTLINE
  • CHALET
  • CLOSE QUARTER
  • CLUB HOUSE
  • CONSULATE
  • EMERALD PLAINS
  • FAVELA
  • FORTRESS
  • HEREFORD BASE
  • HOUSE
  • KAFE DOSTOYEVSKY
  • KANAL
  • OREGON
  • OUTBACK
  • PRESIDENTIAL PLANE
  • SKYSCRAPER
  • THEME PARK
  • TOWER
  • VILLA
  • YACHT

round_outcome_type note

Data Example:

{"info":{"match_info":{"round_outcome_type":"team_has_been_eliminated"}},"feature":"match_info"}

Possible values:

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

general_log note

Data example:

{"info":{"match_info":{"general_log":"{"createdDate":"2021-11-25T08:07:12.245Z","obj":{"targetname":"Engine - Final"},"typeData":{"machineId":"b42e9940e006","buildVersion":"Y6S3.3.1.2pc_C6585743_D1370787_S44651_35130040_PROD","gameVersion":"MAIN","gameSku":"uplay","usSdkVersion":"2020.Release.30"},"type":"game.start","seqId":0,"contexts":[]},{"createdDate":"2021-11-25T08:07:14.445Z","obj":{},"typeData":{"abtesting":{"BattlePassSyncState.V2_Preconfirmed":{},"BattlePassUI.Enabled":{},"ClubChallenge.ChallengesDisabled":{},"CommunityEvent.Live":{},"DebugCamera.Disabled":{},"Fleet.Fleet_Disabled":{},"GamePlay.FullPopulation":{},"HighFrequencyEvents.NoSend":{},"IsDedicatedServerForCustomGamesEnabled.CustomGameDedicatedEnabled":{},"IsRealSenseEnabled.RealSense_Enabled":{},"IsRecommenderServiceEnabled.RecommenderServiceEnabled":{},"IsUSPrimaryStoreEnabled.PrimaryStore_Enabled":{},"MatchmakingHack.none":{},"MicroServices.MicroServices_Disabled":{},"NewcomerPlaylist.Enabled":{},"PopulationBasedChallenges.Group4":{},"QC.LiveConfig":{},"RecoServiceBackend.Ubiservices":{},"RemoteLogs.Minimal":{},"RemoteLogsV2.ByDefault":{},"tg_CrashReport.UploadReport":{},"Watermark.Enabled":{}},"platformType":"uplay"},"type":"player.start","absolutePlaytime":241988,"relativePlaytime":0,"seqId":1,"contexts":[]},{"createdDate":"2021-11-25T08:07:14.445Z","obj": {},"typeData":{"playtimeAbsolute":241988,"playtimeRelative":0,"playtimeAppAbsolute":241988},"type":"player.stats.playtime","absolutePlaytime":241988,"relativePlaytime":0,"seqId":2,"contexts":[]},{"createdDate":"2021-11-25T08:07:15.546Z","obj":{},"typeData":{"menuLanguage":"en-US","audioLanguage":"en-US","platformLanguage":"en-US","areSubtitlesEnabled":true,"subtitlesLanguage":"en-US"},"type":"game.localization","absolutePlaytime":241988,"relativePlaytime":0,"seqId":3,"contexts":[]},{"createdDate":"2021-11-25T08:07:15.546Z","obj":{"CPU_Name":"Intel(R) Core(TM) i7-8700 CPU @ 3.20GHz","CPUS":1,"CPU_Frequency_MHz":3192,"RAM":16317,"OS":"Windows 10","OS_ServicePack":0,"CONTR":false,"GPU_Name":"NVIDIA GeForce GTX 1070","GPU_Memory":8088,"GPU_Count":1,"GPU_Score":11210,"GPU_BadDriverSettings":false,"RESOLX":1920,"RESOLY":1080,"NUMDISP":2,"GPUVER":"30.0.14.9649","HAS_MIC":true,"GRAPHICSAPI_VULKAN":false},"type":"custom.PC_SPECS","absolutePlaytime":241988,"relativePlaytime":0,"seqId":4,"contexts":[]},{"createdDate":"2021-11-25T08:07:15.546Z","obj":{"OVERALLQUALITY":7,"AntiAliasingQuality":3,"GeometryQuality":4,"LightingQuality":2,"ShadowQuality":3,"SharpnessQuality":10,"TextureQuality":3,"VFXQuality":0,"TextureFilteringQuality":4,"ReflectionQuality":2,"AOQuality":2,"LensEffectsQuality":2,"DOFQuality":1,"AdaptiveRenderScalingTargetFPSQuality":0,"RenderScalingFactorQuality":10,"DLSSPerfQualQuality":0},"type":"custom.player.GRAPHICOPTIONS","absolutePlaytime":241988,"relativePlaytime":0,"seqId":5,"contexts":[]},{"createdDate":"2021-11-25T08:07:15.546Z","obj":{"showpcchat":1,"hidenames":0,"hideavatar":0,"hideregionandping":0,"hidemmdelay":0,"hideclearancelevel":0,"customsightmode":"DefaultColorMode","sightcolor":"Default","sightcoloropacity":100,"convertvoicetotext":0,"converttexttovoice":0,"chatassistandthints":"Off","chatscale":1.0,"chatbackgroundvis":"Transparent","showpingcrossfp":1,"showpingcrossot":1,"savereplay":1,"controllerrumble":1},"type":"custom.player.optionhighfreq","absolutePlaytime":241988,"relativePlaytime":0,"seqId":6,"contexts":[]},{"createdDate":"2021-11-25T08:07:15.546Z","obj":{"ADVANCEDGADGETMK":true,"ADVANCEDGADGETCONTROLLER":true,"ADVANCEDDRONEMK":false,"ADVANCEDDRONECONTROLLER":false,"METAFEEDBACK":true,"CONTROLLERSTICKUNIFIEDCURVE":false,"STAYINDRONE":0},"type":"custom.player.OPTIONS","absolutePlaytime":241988,"relativePlaytime":0,"seqId":7,"contexts":[]},{"createdDate":"2021-11-25T08:07:21.125Z","obj":{},"typeData":{"addOns":[{"id":"635","isRevoked":false,"state":"readyToUse"},{"id":"2064","isRevoked":false,"state":"readyToUse"},{"id":"2957","isRevoked":false,"state":"readyToUse"},{"id":"5503","isRevoked":false,"state":"readyToUse"}]},"type":"player.primaryStore.pc","absolutePlaytime":241988,"relativePlaytime":0,"seqId":8,"contexts":[]},{"createdDate":"2021-11-25T08:07:28.849Z","obj":{"GameVersionKind":"FullGame"},"type":"custom.game.gameversion","absolutePlaytime":241988,"relativePlaytime":0,"seqId":9,"contexts":[]},{"createdDate":"2021-11-25T08:07:31.165Z","obj":{"HASFULLGAME":1,"HASSPDISCOUNT":0,"RECOMD5":"1C348C8ADB1AC421254C0D553234F5C7","NBOPERATORS":0,"NBATTACHMENTS":0,"NBSKINS":9,"NBUNIVSKINS":0,"NBUNIVCHARMS":9,"NBBOOSTERS":0,"NBBUNDLES":7,"NBHEADGEARS":6,"NBLEGENDARY":4,"NBUNIFORMS":4,"NBVICPOSES":0,"NBUNIVVICPOSES":0,"NBVICDANCES":0,"NBUNIVVICDANCES":0,"NBUNKNOWN":1,"NBINVALID":0,"STATUSOPERATORS":3,"STATUSATTACHMENTS":3,"STATUSSKINS":1,"STATUSUNIVSKINS":1,"STATUSUNIVCHARMS":1,"STATUSBOOSTERS":3,"STATUSBUNDLES":1,"STATUSHEADGEARS":1,"STATUSLEGENDARY":1,"STATUSUNIFORMS":1,"STATUSVICPOSES":3,"STATUSUNIVVICPOSES":3,"STATUSVICDANCES":3,"STATUSUNIVVICDANCES":3},"typeData":{"contextName":"RecommenderServiceEnabled","contextId":0},"type":"context.start.STORERECO","absolutePlaytime":241988,"relativePlaytime":0,"seqId":10,"contexts":[0]},{"createdDate":"2021-11-25T08:07:35.545Z","obj":{},"typeData":{"achievementId":52},"type":"player.achievement","absolutePlaytime":241988,"relativePlaytime":0,"seqId":11,"contexts":[0]},{"createdDate":"2021-11-25T08:07:35.586Z","obj":{},"typeData":{"achievementId":52},"type":"player.achievement","absolutePlaytime":241988,"relativePlaytime":0,"seqId":12,"contexts":[0]},{"createdDate":"2021-11-25T08:07:36.675Z","obj": {},"typeData":{"newsId":"ignt.29284","placement":"mainmenu","duration":0},"type":"player.news.impression","absolutePlaytime":241989,"relativePlaytime":1,"seqId":13,"contexts":[0]},{"createdDate":"2021-11-25T08:07:36.675Z","obj":{"NewsID":"ignt.29284","NewsType":"CommunityNews","Placement":"Banner","Duration":0.0},"type":"custom.InGameNewsImpression","absolutePlaytime":241989,"relativePlaytime":1,"seqId":14,"contexts":[0]},{"createdDate":"2021-11-25T08:07:37.733Z","obj": {},"typeData":{"newsId":"ignt.29284","placement":"mainmenu","duration":0},"type":"player.news.impression","absolutePlaytime":241989,"relativePlaytime":1,"seqId":15,"contexts":[0]},{"createdDate":"2021-11-25T08:07:37.733Z","obj":{"NUMNOTIFUNREAD":30,"NUMPACKUNOPENED":34,"NUMBOOSTERNOTUSED":0},"type":"custom.player.playerhub","absolutePlaytime":241989,"relativePlaytime":1,"seqId":16,"contexts":[0]},{"createdDate":"2021-11-25T08:07:43.385Z","obj": {},"typeData":{"newsId":"neolane.mainmenu.4710","placement":"mainmenu","duration":0},"type":"player.news.impression","absolutePlaytime":241996,"relativePlaytime":8,"seqId":17,"contexts":[0]},{"createdDate":"2021-11-25T08:07:43.389Z","obj":{"NewsID":"neolane.mainmenu.4710","NewsType":"GameNews","Placement":"Banner","Duration":0.0},"type":"custom.InGameNewsImpression","absolutePlaytime":241996,"relativePlaytime":8,"seqId":18,"contexts":[0]},{"createdDate":"2021-11-25T08:07:47.756Z","obj":{"GameModes":7,"MatchType":"MATCHMAKING_PVP"},"type":"custom.player.matchmakingpreferences","absolutePlaytime":242000,"relativePlaytime":12,"seqId":19,"contexts":[0]},{"createdDate":"2021-11-25T08:07:47.756Z","obj":{},"typeData":{"contextName":"MATCHMAKING_PVP_HIGHLEVEL","contextId":1},"type":"context.start.GameModeHighLevelContext","absolutePlaytime":242000,"relativePlaytime":12,"seqId":20,"contexts":[0,1]},{"createdDate":"2021-11-25T08:07:47.756Z","obj":{},"typeData":{"contextName":"MATCHMAKING_PVP","contextId":2},"type":"context.start.GameMode","absolutePlaytime":242000,"relativePlaytime":12,"seqId":21,"contexts":[0,1,2]},{"createdDate":"2021-11-25T08:07:47.796Z","obj":{"STARTREASON":"PlayButton (Quick Play)","MTYPE":"PVP_Casual","NAT":"open","DATACENTERPINGS":"playfab/westus:203,playfab/westeurope:63,playfab/uaenorth:152,playfab/southeastasia:189,playfab/southcentralus:158,playfab/southafricanorth:211,playfab/northeurope:68,playfab/japaneast:257,playfab/eastus:133,playfab/eastasia:219,playfab/centralus:165,playfab/brazilsouth:237,playfab/australiaeast:277,gamelift/us-west-1:203,gamelift/us-east-2:151,gamelift/us-east-1:143,gamelift/sa-east-1:259,gamelift/eu-west-2:61,gamelift/eu-west-1:81,gamelift/eu-central-1:66,gamelift/ap-northeast-1:366,gamelift/ap-east-1:371","SKILLRANK":0,"SKILLMEAN":17.989,"SKILLSTDEV":4.040163,"SKILLMMR":1799.0,"CLLEVEL":48,"LANGUAGE":"en-US","PLAYLISTS":"245225348295","PARTYSIZE":1,"ISSQUADLEADER":true,"PARTYSESSIONID":""},"typeData":{"contextName":"1","contextId":3},"type":"context.start.MATCHMAKING","absolutePlaytime":242000,"relativePlaytime":12,"seqId":22,"contexts":[0,1,2,3]},{"createdDate":"2021-11-25T08:07:50.011Z","obj": {},"typeData":{"newsId":"ignt.29284","placement":"mainmenu","duration":0},"type":"player.news.impression","absolutePlaytime":242002,"relativePlaytime":14,"seqId":23,"contexts":[0,1,2,3]}"}},"feature":"match_info"}

match_start_log note

Data Example:

{"info":{"match_info":{"match_start_log":"{"MAP":"0000002E8679C826","STARTREASON":"PlayButton (Quick Play)","MMID":"1","PARTY":1,"SQUADID":"22038977","TEAM":"0","SKILLRANK":0,"SKILLMEAN":17.989,"SKILLSTDEV":4.040163,"SKILLMMR":1799.0,"MTYPE":"00000000138BDF6E"}"}},"feature":"match_info"}

round_start_log note

Data Example:

{"info":{"match_info":{"round_start_log":"{"MAP":"0000002E8679C826","TEAM":"0","CLASS":"00000000194386F5","CTU":"000000008F2F7DAA","ROLE":"Attacker","WEAPON1":"00000000B79310C6","W1SIGHT":"0000000106FF2340","W1MUZZLE":"0000000106FF22EE","W1LASER":"0000000106FF2318","W1GRIP":"0000000106FF22C1","W1SKIN":"00000055E1C9FA63","WEAPON2":"00000000B79310CA","W2SIGHT":"000000024D7F55E5","W2MUZZLE":"000000024D7F55E5","W2LASER":"000000024D7F55E5","W2GRIP":"000000024D7F55E5","W2SKIN":"00000055E1CA0011","GADGET1":"00000036232BA67D","GADGET2":"00000024F9498268","OPHEADGEAR":"000000086AA28666","OPUNIFORM":"00000008FB56ABB2","CHARM":"000000024D7F55E5","CHECKPOINTID":""}"}},"feature":"match_info"}

round_end_log note

Data example:

{"info":{"match_info":{"round_end_log":"{"MAP":"0000002E8679C826","OBJVAR":"N/A","ENDROUNDREASON":"AttackersEliminated","WINROLE":"Defender","LOCCHOSEN":"0000000019438607","SURVATTACK":0,"SURVDEF":4,"ROUNDWON":"false","TEAM":"0","CLASS":"00000000194386F5","CTU":"000000008F2F7DAA","ROLE":"Attacker","CLLEVEL":48,"MARKALIVE":0,"MARKSUPPORT":0,"MARKTOTAL":0,"PING":1,"TIMEALIVE":62810,"TIMEDEAD":44146,"NUMKILLS":0,"NUMTEAMKILLS":0,"CONTROLLER":"mouse-keyboard","KEYBOARDANDMOUSEPRESENT":true,"OPERATORCHOICE":"["00000000194386ED","00000000194386F1","00000000194386F5","00000000194386F9","000000001943872D","0000000019438731","0000000019438735","0000000019438739","0000000014E0348B","0000000014E0348F","0000000014E03493","0000000014E03497","000000001943870D","0000000019438711","0000000019438715","0000004246B907A0","0000000014E034AB","0000000014E034AF","0000000014E034B3","0000000014E034B7"]","RANDOMPICKED":0,"NUMDEFENTERWZONE":0,"NUMDEFKILLEDWZONE":0,"NUMATTKILLEDWZONE":0,"WINTEAM":"1","PLAYERSCORE":65,"ESCATTEMPTS":0,"DBNOHOSTAGE":0,"DEFUSERPLANTED":0,"BOMBDISARMED":0,"OBJSECSTARTED":0,"NUMASSISTS":0,"MINPING":65,"MAXPING":9999,"AVGPING":171,"STDEVPING":929,"CNTPING":28076,"DCENTER":"gamelift/eu-west-2","AVGFPS":59.987537,"MINFPS":59.867961,"MAXFPS":60.039981,"CNTFPS":30,"STDEVFPS":0.022091,"TTPACTIVE":242510,"TTPPVP":216791,"TTPPVE":1106,"NBMSGSENT":0,"NBMSGCENSOR":0}"}},"feature":"match_info"}

move_log note

Data Example:

{"info":{"match_info":{"move_log":"{"MAP":"0000002E8679C826","TEAM":"0","POSTURE":"Standing","PAWNCONTEXT":"GroundNav","MOVETYPE":"Idle","CLASS":"00000000194386F5","CTU":"000000008F2F7DAA","ROLE":"Attacker","WEAPON":"00000000B79310C6","ISINCAMERA":true,"X":-43.942409,"Y":34.173423,"Z":0.923974,"ROOMID":0}"}},"feature":"match_info"}

score_log note

Data Example:

{"info":{"match_info":{"score_log":"{"MAP":"0000002E8679C826","TEAM":"0","CLASS":"00000000194386F5","CTU":"000000008F2F7DAA","ROLE":"Attacker","SCORENAME":"0000000118B323A2","AMOUNT":10,"MULTIPLIER":100}"}},"feature":"match_info"}

kill_log note

Data example:

{"info":{"match_info":{"kill_log":"{"CLASS":"00000000194386F5","ROLE":"Attacker","TEAM":"0","CTU":"000000008F2F7DAA","MAP":"0000002E8679C826","WEAPONID":"00000000B79310C6","WEAPONCATEGORY":2,"WEAPONTYPE":1,"SUPPRESSEDWEAPON":false,"FFIRE":false,"KILLREASON":"Bullet","ISHOSTAGE":false,"VCLASS":"00000002213707C3","VPROFILEID":"254007ea-ec3e-4af6-977c-08a7bfaa3527","DBNO":false,"ISHEADSHOT":true,"KISRUNNINGOUT":false,"VISRUNNINGOUT":false,"ACTIVEEFFECTS":[],"ACTIVEEFFECTSK":[],"AISTATE":"","KX":7.00137,"KY":-4.839494,"KZ":4.399999,"VX":7.978,"VY":-23.389001,"VZ":4.4,"KROOMID":238908,"VROOMID":238908,"STARTTIMEINROUND":51609,"ISENEMYKILL":1,"PENETRATIONKILL":false}"}},"feature":"match_info"}

ko_log note

Data example:

{"info":{"match_info":{"ko_log":"{"VTEAM":"0","VCLASS":"00000000194386F5","VCTU":"000000008F2F7DAA","VPosture":"Sprinting","VMoveType":"Sprint","KISRUNNINGOUT":false,"VISRUNNINGOUT":false,"MAP":"0000002E8679C826","TIMEALIVE":80069,"VX":-4.371304,"VY":-16.423547,"VZ":4.398569,"VROOMID":238908,"VROLE":"Attacker","DBNOREASON":"Bullet","FFIRE":false,"KILLERID":"eb96475f-cc15-4b5e-a0d5-b5c927bf1d4d","WEAPONID":"00000000B79310D1","KX":-5.94,"KY":-13.774001,"KZ":4.396,"KROOMID":238908,"KROLE":"Defender","KTEAM":"1","KCLASS":"00000000194386F1","KCTU":"000000008F2F7DAA","IsMarked":false}"}},"feature":"match_info"}

death_log note

Data Example:

{"info":{"match_info":{"death_log":"{"VTEAM":"0","VCLASS":"00000000194386F5","VCTU":"000000008F2F7DAA","VPosture":"Prone","VMoveType":"Idle","KISRUNNINGOUT":false,"VISRUNNINGOUT":false,"MAP":"0000002E8679C826","TIMEALIVE":80384,"VX":-4.577148,"VY":-16.393556,"VZ":4.398437,"VROOMID":238908,"VROLE":"Attacker","DEATHREASON":"Bullet","ACTIVEEFFECTS":[{"Effect":"EntityEffect_AudioAlarmAffected","Cause":"Gadget_AudioAlarm"}],"FFIRE":false,"KILLERID":"eb96475f-cc15-4b5e-a0d5-b5c927bf1d4d","ISHEADSHOT":false,"WEAPONID":"00000000B79310D1","KX":-5.922852,"KY":-13.820313,"KZ":4.395508,"KROOMID":238908,"KROLE":"Defender","KTEAM":"1","KCLASS":"00000000194386F1","KCTU":"000000008F2F7DAA","IsMarked":false,"IsJackalHeatVisionon":false}"}},"feature":"match_info"}

match_end_log note

Data Example:

{"info":{"match_info":{"match_end_log":"{"MAP":"0000002E8679C826","ENDREASON":"MatchOver","ROUNDSPLAYED":5,"ISJIP":false,"PARTY":1,"MATCHWON":"false","DATACENTER":"playfab/westeurope","LEAVEREASON":27,"WIRELESS":false,"TEAM":"0","WINTEAM":"1","PLAYERSCORE":1220,"VSETTING":"PushToTalk","VNUM":0,"SKILLRANK":0,"SKILLMEAN":17.339664,"SKILLSTDEV":4.017635,"SKILLMMR":1734.0,"AlphaPackDropRate":550,"AlphaPackDropIncrease":150,"AlphaPackHasDropped":false,"MULTIPLIER":100,"MTYPE":"00000000138BDF6E"}"}},"feature":"match_info"}

match_start note

Data Example:

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

match_end note

Data Example:

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

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
numberroundCurrent round number
Example:
{"round":{"number":"3"}}
123.0
scorematchMatch score
Example:
{"match":{"score":"{"blue":"2","orange":"1"}"}}
123.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
roundStartnullRound starts.123.0
roundEndnullRound ends.123.0
roundOutcomevictory / defeat
{"name":"roundOutcome","data":"victory"}
Round concluded.123.0
matchOutcomevictory / defeat
{"name":"matchOutcome","data":"defeat"}
Match concluded.123.0

roster

Info Updates

keyCategoryValuesNotesSince GEP Ver.
roster_XXplayersProvides info for the currently active players (10 players).See notes123.0
teamplayersPlayer’s current team – Orange/Blue/Spectator123.0
healthplayersPlayer’s current healthSee notes123.0
scoreplayersPlayer’s current score or null
{"player":{"score":"335"}}
See notes123.0
killsplayersTotal number of kills by the player or null
{"player":{"kills":"0"}}
123.0
deathsplayersTotal number of player's deaths or null
{"player":{"deaths":"1"}}
123.0
operatorplayersThe numeric ID of the chosen operator.
{"player":{"operator":"514"}}
151.0
player_idplayersThe player's ID number {"player":{"player_id":"1b810848-34df-4834-aa26-61c838059a37"}}191.0

roster_XX notes

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

Backslashes omitted for legibility.

{
"info": {
"players":{
"roster_0": "{
"name": "WolfOnTop.top",
"player_id": "1b810848-34df-4834-aa26-61c838059a37",
"is_local": true,
"team": 1,
"operator": 0,
"kills": 0,
"headshots": 0,
"deaths": 0,
"score": 0,
"defuser": 0,
"health": 0,
"suffix": 123
}"
}
},
"feature": "roster"}

As you can see, this object includes:

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

  • team - Blue/Orange/Spectator
    As of version 159, you may detect the local player as a spectator when creating a custom match (Example: {"info":{"player":{"team":"Spectator"}},"feature":"roster"}).

  • is_local - local player or not (Boolean)

  • operator - The ID of the selected operator (available for team members only)

  • kills - Total amount of kills made by the player (Important: Kill score is being reset between rounds).

  • deaths - Total amount of deaths (Important: Death score is being reset between rounds).

  • score - Player score in the current round (Important: Score is being reset between rounds).

  • health - Current health of the player (available for team members only). Important! - health always include 20 points for the knockout stage, so the event will always add 20 health points more then the game

  • player_id - each player in the roster will have his unique player_id
    As of version 191 the Ubisoft user ID is provided. This may not be used to circumvent Nicknames set through Privacy Mode.

  • suffix - If the user uses a nickname (from the privacy menu), this field will include a number between 2-5 digits. According to Ubisoft privacy rules, in case there is a value in this field it must be linked to the name field wherever it appears during the match. The suffix will be reset at the end of each match and regenerate a new one at the beginning of the next match.

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 include 20 points for the knockout stage, so the event will always add 20 health points more then the game

{"info":{"player":{"health":"41"}},"feature":"roster"}

score note

Since december 2021 patch - team colors provided by GEP do not correspond to the game's UI team color (the local player is always blue in the game's UI). The local player's score, team score and roster regarding to his color are still consistent.

kill

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killnullLocal player killed an enemy123.0
headshotnullLocal player killed an enemy with a headshot123.0

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
knockedoutnullLocal player is knockedoutSee notes123.0
deathnullLocal player diesSee notes123.0
killerKiller nameThe local player was killed by an enemySee notes123.0

knockedout note

Data Example:

{"name":"knockedout","data":""}

death note

Data Example:

{"name":"death","data":""}

killer note

Data Example:

{"name":"killer","data":"Pickyuser18857"}

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
namemeLocal player's in-game name.See notes148.0
account_idmeOBSOLETESee notes148.0
account_id_logmeLocal player's account ID information and privacy informationSee notes186.0

name note

Data Example:

{"info":{"me":{"name":"WolfOnTop.top"}},"feature":"me"}

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

account_id note

OBSOLETE

This event is currently NOT supported. Please use account_id_log instead

account_id_log note

Data Example:

{"info":{"me":{"account_id_log":"{"message":{"params":{"clearance_level":"50","nickname":"mrtest123","nickname_enabled":"1","sender":"7e909880-5b34-4757-b826-31614ba76186","two_factor_auth_enabled":"0"},"type":3}}"}},"feature":"me"}

Privacy mode:

  • nickname_enabled - 0/1 if nickname is disabled/enabled
  • nickname - if enabled will show the nickname else the username

defuser

Events

EventEvent DataFired WhenNotesSince GEP Ver.
defuser_plantednullDefuser was planted.See notes162.1
defuser_disablednullDefuser was disabled.See notes165.0

defuser_planted note

Data Example:

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

defuser_disabled note

Data Example:

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