- Game events API
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 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
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"}
stats
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player0 / player1 … playerN(N = number of players in the match) | playersInfo | Check notes | See notes | 14.0 |
player note
- Encoded stringified JSON containing the properties:
- 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)
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"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
goal | Check notes | A goal has been scored | See notes | 14.0 |
score | Check notes | Score of a player has changed | See notes | 86.0 |
teamGoal | null | When the local player’s team has scored a goal | See notes | 131.0 |
opposingTeamGoal | null | When the opposing team has scored a goal | See notes | 131.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 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 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
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
started | matchState | "true" / "false" | 14.0 | |
ended | matchState | "true" / "false" | 86.0 | |
matchType | matchInfo | Current match type | See notes | 86.0 |
ranked | matchInfo | True if the match is ranked, false otherwise "true"/"false" | 86.0 | |
maxPlayers | matchInfo | Maximum number of players allowed in this match | See notes | 86.0 |
gameMode | matchInfo | Game mode of the match | See notes | 86.0 |
gameState | matchInfo | Current state of the game | See notes | 86.0 |
gameType | matchInfo | Current game type | 86.0 |
matchType note
Possible values:
- 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
Possible values:
- Soccar
- Breakout (Dropshot)
- Basketball
- Hockey
- Items
- Unknown
Data Example:
{"feature":"match","category":"matchInfo","key":"gameMode","value":"Soccar"}
gameState note
Possible values:
- WaitingForPlayers
- Countdown
- Active
- PostGoalScored
- ReplayPlayback
- PrePodiumSpotlight
- Finished
- Unknown
- PodiumSpotlight
Data Example:
{"info":{"matchInfo":{"gameState":"WaitingForPlayers"}},"feature":"match"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
matchStart | null | Match starts | See notes | 14.0 |
matchEnd | null | Match ends | See notes | 14.0 |
victory | null | team_score (1 / 2)(1 – Victory, 2 - defeat) | 86.0 | |
defeat | null | team_score (1 / 2)(1 – Victory, 2 - defeat) | 86.0 | |
surrender | ID of the forfeiting team | A team forfeits the match | See notes | 253.0 |
overtime | null | The match reaches overtime | See notes | 253.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}"}]}
Data Example:
{"events":[{"name":"defeat","data":"{"team_score":0}"}]}
surrender note
Data Example:
{"events":[{"name":"surrender","data": "{\"team\":1}"}]}
overtime note
Data Example:
{"events":[{"name":"overtime","data":""}]}
match_info
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
pseudo_match_id | match_info | Current match’s internal ID code. | See notes | 130.0 |
mutator_settings | match_info | The current-chosen settings of the private match. | See notes | 147.0 |
arena | match_info | The current private match's arena setting. | See notes | 147.0 |
server_info | match_info | The info of the current match's server info. | See notes | 147.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"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
action_points | match_info | Name of action that granted a score to the local player. | See notes | 160.0 |
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"}]}
{"events":[{"name":"action_points","data":"Long Shot"}]}
roster
Info Updates
key | Category | Values | Notes | Since GEP Ver. |
---|---|---|---|---|
player0 / player1 … playerN (N = number of players in the match) | playersInfo | Check notes | See notes | 14.0 |
team1 / team2 | teamsInfo | Check notes | See notes | 24.0 |
team1_score / team2_score | teamsScore | team1 / team2 score – integer | See notes | 86.0 |
players_rank | playersInfo | The rank of each player at the end of a match | See notes | 237.0 |
players_boost | playersInfo | The boost level of each teammate during the match | See notes | 252.0 |
player note
- Encoded stringified JSON containing the properties:
- 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)
- platform - The platform's current platform name
- Available platforms: Steam, PS4 (PS5), PS3, Dingo, Epic, NNX (Nintendo)
- player_id - the current player ID in the specific platform
- assists - Total assists of the player
- saves - Total saves of the player
- shots - Total shots of the player
- mvp - 1 if the player is the MVP, 0 if not
- team_score - Total team score
- local - 1 If the player is the local player, 0 if not
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":"{"steamId":"0","player_id":"af52b92db42242592e73bbbf8c4","platform":"Epic","score":0,"assists":"0","saves":"0","shots":"0","goals":"0","mvp":"0","name":"oSparrow","state":"0","team_score":0,"team":"1","local":"1","index":2}"}},"feature":"roster"}
teamsInfo note
Value:
An encoded stringified array of strings indicating the player's 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"}
players_rank note
Data Example
{"feature": "roster", "category": "playersInfo", "key": "players_rank", "data": "[{\"name\":\"Yo55680\",\"rank\":\"Silver III\"},{\"name\":\"BruTS93330\",\"rank\":\"Silver III\"},{\"name\":\"ruzgaasar07\",\"rank\":\"Silver III\"},{\"name\":\"t2l__ll\",\"rank\":\"Silver III\"}]"}
players_boost note
Data Example
Values are round up and the possible values are 0,10,20,30,40,50,60,70,80,90,100.
{"feature":"roster","category":"playersInfo","key":"players_boost","value":"[{\"player_name\":\"Centice\",\"boost\":50},{\"player_name\":\"Naco8\",\"boost\":0}]"}
Events
Event | Event Data | Fired When | Notes | Since GEP Ver. |
---|---|---|---|---|
rosterChange | Array containing players' information | A player leaves or joins the match | See notes | 14.0 |
playerJoined | Check notes | A player joins the match | See notes | 24.0 |
playerLeft | Check notes | A player leaves the match | See notes | 24.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}"}]}