Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›Available Game Events

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

Rocket League Game Events

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

Game ID

10798

Sample Apps

  • Rocket League game events sample app

Available Features

  • gep_internal
  • stats
  • teamGoal
  • opposingTeamGoal
  • match
  • roster
  • me
  • match_info
  • death

Game events status

It's recommended to communicate errors and warnings to your users. You can check game event status here or easily verify 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"}

stats

Events

EventEvent DataFired WhenNotesSince GEP Ver.
goalCheck notesA goal has been scoredSee notes14.0
scoreCheck notesScore of a player has changedSee notes86.0

goal note

Event Data:

  • steamId – Steam id of the player scoring the goal
  • score – Score of the player scoring the goal
  • goals – Goal count of the player
  • name – Name of the player scoring the goal
  • team – Team number of the scoring player (1 or 2)
  • local – Whether the player who scored is the local player

Comments:

Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and then JSON.parse() on the result

Data Example:

{"events":[{"name":"goal","data":"{  "steamId": "0",  "score": 118,  "goals": "1",  "name": "Ram is troll",  "state": "0",  "team_score": 1,  "team": "2",  "local": "1",  "index": 3}"}]}

score note

Event Data:

  • steamId – Steam ID of the player
  • score – Score of the player
  • goals – Goal count of the player
  • name – Name of the player
  • state
  • team_score
  • team – Team number of the player (1 or 2)
  • index

Comments:

Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and the JSON.parse() on the result

Data Example:

{"info":{"me":{"team_score":"0"}},"feature":"me"}
{"info":{"teamsScore":{"team1_score":"0"}},"feature":"roster"}
{"info":{"teamsScore":{"team2_score":"0"}},"feature":"roster"}
{"info":{"me":{"score":"725"}},"feature":"me"}

teamGoal

Events

EventEvent DataFired WhenNotesSince GEP Ver.
teamGoalnullWhen the local player’s team has scored a goalSee notes131.0

teamGoal note

Data Example:

{"events":[{"name":"teamGoal","data":"{"steamId":"2535424769966317","score":126,"goals":"1","name":"JteRushencroks0","state":"0","team_score":2,"team":"1","index":4}"}]}

opposingTeamGoal

Events

EventEvent DataFired WhenNotesSince GEP Ver.
opposingTeamGoalnullWhen the opposing team has scored a goalSee notes131.0

opposingTeamGoal note

Data Example:

{"events":[{"name":"opposingTeamGoal","data":"{"steamId":"2535461211167231","score":128,"goals":"1","name":"JaffaCake200015","state":"0","team_score":1,"team":"1","index":2}"}]}

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
startedmatchStatetrue / false14.0
endedmatchStatetrue / false86.0
matchTypematchInfoCurrent match typeSee notes86.0
rankedmatchInfoTrue if the match is ranked, false otherwise "True/False"86.0
maxPlayersmatchInfoMaximum number of players allowed in this matchSee notes86.0
gameModematchInfoGame mode of the matchSee notes86.0
gameStatematchInfoCurrent state of the gameSee notes86.0
gameTypematchInfoCurrent game type86.0

matchType note

Data Example:

[“Lobby” | “Private” | “Online” | “Offline”]

Data Example:

{"info":{"matchInfo":{"matchType":"Online"}},"feature":"match"}

maxPlayers note

(integer – use parseInt)

Data Example:

{"info":{"matchInfo":{"maxPlayers":"6"}},"feature":"match"}

gameMode note

Data Example:

[“soccar” | “basketball”, “hockey”, “items”, “volleyball”, “breakout”, “playTest”]

gameState note

Data Example:

[“waitingForPlayers” | “countdown | “active” | “postGoalScored” | “ReplayPlayback” | “PrePodiumSpotlight” | “Finished” | “Unknown” | “PodiumSpotlight”]

{"info":{"matchInfo":{"gameState":"WaitingForPlayers"}},"feature":"match"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch startsSee notes14.0
matchEndnullMatch endsSee notes14.0
victorynullteam_score (1 / 2)(1 – Victory, 2 - defeat)86.0
defeatnullteam_score (1 / 2)(1 – Victory, 2 - defeat)86.0

matchStart note

Data Example:

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

matchEnd note

Data Example:

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

victory note

Data Example:

{"events":[{"name":"victory","data":"{"team_score":5}"}]}

defeat note

Data Example:

{"events":[{"name":"defeat","data":"{"team_score":0}"}]}

match_info

Info Updates

keyCategoryValuesNotesSince GEP Ver.
pseudo_match_idmatch_infoCurrent match’s internal ID code.See notes130.0
mutator_settingsmatch_infoThe current-chosen settings of the private match.See notes147.0
arenamatch_infoThe current private match's arena setting.See notes147.0
server_infomatch_infoThe info of the current match's server info.See notes147.0
action_pointsmatch_infoName of action that granted a score to local player.See notes160.0

pseudo_match_id note

Data Example:

0c0ea3df-97ea-4d3a-b1f6-f8e34042251f

mutator_settings note

Data Example:

{"info":{"match_info":{"mutator_settings":"SmallBall,HighBounciness,FastBall,LightBall,Pinball,BotsNone"}},"feature":"match_info"}

arena note

Data Example:

{"info":{"match_info":{"arena":"Random"}},"feature":"match_info"}

server_info note

Data Example:

{"info":{"match_info":{"server_info":"EU511-Gimbal9"}},"feature":"match_info"}

action_points note

Data Examples:

{"events":[{"name":"action_points","data":"Shot On Goal"}]}
{"events":[{"name":"action_points","data":"Goal"}]}
{"events":[{"name":"action_points","data":"First Touch"}]}
{"events":[{"name":"action_points","data":"Center Ball"}]}
{"events":[{"name":"action_points","data":"Pool Shot"}]}
{"events":[{"name":"action_points","data":"Assist"}]}
{"events":[{"name":"action_points","data":"Clear Goal"}]}
{"events":[{"name":"action_points","data":"Demolish"}]}
{"events":[{"name":"action_points","data":"Save"}]}
{"events":[{"name":"action_points","data":"Epic Save"}]}

roster

Info Updates

keyCategoryValuesNotesSince GEP Ver.
player0 / player1 … palyerN(N = number of players in the match)playersInfoCheck notesSee notes14.0
team1 / team2teamsInfoCheck notesSee notes24.0
team1_score / team2_scoreteamsScoreteam1 / team2 score – integerSee notes86.0

player note

  • Encoded stringified JSON containing the properties:
    • steamId – Steam ID of the player who died
    • score – Score of the player who died
    • goals – Goal count of the player
    • name – Name of the player that died
    • team – Team number of the player (1 or 2)

Comment:

Encoded stringified JSON containing the properties. Need to do a decodeURI() on the value and then JSON.parse() on the result.

Data Example:

{"info":{"playersInfo":{"player0":"%7B%22steamId%22:%222535466851496806%22,%22score%22:52,%22goals%22:%220%22,%22name%22:%22Daknowntesco%22,%22state%22:%220%22,%22team_score%22:0,%22team%22:%221%22,%22local%22:%220%22,%22index%22:0%7D"}},"feature":"roster"}

teamsInfo note

Value:

Encoded stringified array of strings indicating the players IDs for each team. Each ID corresponds to an ID under the playersInfo category.

Data Example

{"info":{"teamsInfo":{"team1":"%5B%22player0%22%5D"}},"feature":"roster"}

Events

EventEvent DataFired WhenNotesSince GEP Ver.
rosterChangeArray containing players' informationA player leaves or joins the matchSee notes14.0
playerJoinedCheck notesA player joins the matchSee notes24.0
playerLeftCheck notesA player leaves the matchSee notes24.0

rosterChange note

Data Example:

{"events":[{"name":"rosterChange","data":"{"roster": [{"steamId": "2535466851496806","score": 52,"goals": "0","name": "Daknowntesco","state": "0","team_score": 0,"team": "1","local": "0","index": 0},{"steamId": "8815809362838850094","score": 0,"goals": "0","name": "YT_BR33Z3_","state": "0","team_score": 0,"team": "2","local": "0","index": 1},{"steamId": "76561198239574678","score": 0,"goals": "0","name": "lars","state": "0","team_score": 0,"team": "1","local": "0","index": 2}]}"}]}

playerJoined note

Event Data:

  • steamId – Steam ID of the player
  • score – Score of the player
  • goals – Goal count of the player
  • name – Name of the player
  • team – Team number of the player (1 or 2)

Data Example:

{"events":[{"name":"playerJoined","data":"{"steamId":"2535428144972964","score":0,"goals": "0","name":"Joschy900","state":"0\","team_score":0,"team":"1","index": 2}"}]}

playerLeft note

Event Data:

  • steamId – Steam ID of the player
  • score – Score of the player
  • goals – Goal count of the player
  • name – Name of the player
  • team – Team number of the player (1 or 2)

Data Example:

{"events":[{"name":"playerLeft","data":"{"steamId":"156382600742638838","score":52,"goals":"0","name":"JHONNYHS","state":"0","team_score":1,"team":"2","index": 2}"}]}

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
steamIdmePlayer’s Steam ID14.0
namemePlayer’s name14.0
goalsmePlayer’s goal count14.0
scoremePlayer’s score14.0
teammePlayer’s team number14.0
team_scoremeTeam score86.0

me note

Data Examples:

{"info":{"me":{"goals":"1"}},"feature":"me"}
{"info":{"me":{"score":"102"}},"feature":"me"}
{"info":{"me":{"team_score":"1"}},"feature":"me"}

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathnullA player is demolished by an opponent.See notes160.0

death note

Data Example:

{"events":[{"name":"death","data":""}]}
Last updated on 2020-12-28 by Sh4rgaas
← Rainbow Six SiegeStarCraft II →
  • Sample Apps
  • Available Features
  • Game events status
  • gep_internal
    • Info Updates
  • stats
    • Events
  • teamGoal
    • Events
  • opposingTeamGoal
    • Events
  • match
    • Info Updates
    • Events
  • match_info
    • Info Updates
  • roster
    • Info Updates
    • Events
  • me
    • Info Updates
  • death
    • Events
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf