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

PlayerUnkown's Battlegrounds Lite Game Events

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

Game ID

21598

Sample Apps

  • PUBG game events sample app

Available Features

  • gep_internal
  • kill
  • revived
  • death
  • killer
  • match
  • rank
  • me
  • phase
  • map
  • team_feed
  • team

Game events status

It is highly recommended to communicate errors and warnings to your app users.

Check here the game events status. OR - easily check the game events status from your app, using our API.

gep_internal

Info Updates

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

kill

Info Updates

keyCategoryValuesNotesSince GEP Ver.
killsmatch_infoTotal number of kills in the match146.0
headshotsmatch_infoTotal number of headshots in the match146.0
total_damage_dealtmatch_infoTotal damage dealt in the current match146.0
max_kill_distancematch_infoMax kill distance in CM146.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killnullThe local player killed another player146.0
headshotnullThe local player hit another player with a headshot146.0
damage_dealtamount of damage dealt by the local playerThe local player “damaged” an enemy or himselfSee notes146.0
knockoutweapon name + victim nameThe local player knocked-out another playerSee notes148.0

damage_dealt note

This event can not be used in real time, as it can give an un-fair advantage to the user. You can use it post-match.

Data Example:

{"events":[{"name":"damage_dealt","data":"42.63"}]}

knockout note

Data Example:

{"events":[{"name":"knockout","data":"{"weapon":"SLR","victim":"salambebek1"}"}]}

match

Info Updates

keyCategoryValuesNotesSince GEP Ver.
modematch_infoSolo/Duo/Squad
Example:
{"mode":"squad"}
See notes146.0
match_idmatch_infoThe current match ID code.
Example:
match.bro.official.pc-2018-03.steam.
solo.eu.2019.05.07.08.ce8d1a14-b2af
-41c8-8bf4-d2a504326630
Can be compared and checked at this link146.0
pseudo_match_idmatch_infoThe current match’s ID code.
Example:
0c0ea3df-97ea-4d3a-b1f6-f8e34042251f
This is an Overwolf-generated code which is unrelated to the match ID given above.146.0

Events

EventEvent DataFired WhenNotesSince GEP Ver.
matchStartnullMatch started146.0
matchEndnullMatch ended. See notes below146.0

mode note

Data Example:

{"info":{"match_info":{"mode":"squad"}},"feature":"match"}

match_id note

Data Example:

{"info":{"match_info":{"match_id":"match.bro.official.lpc-2019-06.gacct.squad.eu.2020.10.04.08.aa64b4d8-0f0a-4892-9678-3cdca2b0fedb"}},"feature":"match"}

matchEnd note

The matchEnd event fired when your player is killed, and when you exit to the lobby. (which means that if you get killed and than you exit to the lobby, you will see two calls for this event).

rank

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mematch_infoThe player’s rank at the end of the match146.0
totalmatch_infoThe total number of players146.0

me

Info Updates

keyCategoryValuesNotesSince GEP Ver.
namemeThe player’s nickname
{"name":"itayG"}
146.0
healthmeThe player’s current healthSee notes146.0
viewmeSee notes146.0

health note:

Data Example:

{"health":"{"health":100,"ko_health":100}"}

view note:

Data Example:

{"view":"TPP"}

phase

Info Updates

keyCategoryValuesNotesSince GEP Ver.
phasegame_infoThe game’s current state, can be one of the following:
  • ‘lobby’
  • ‘loading_screen’
  • ‘airfield’
  • ‘aircraft’
  • ‘freefly’
  • ‘landed’
146.0

map

Info Updates

keyCategoryValuesNotesSince GEP Ver.
mapmatch_infoThe current map name
{"map":"Desert_Main"}
map names mapping146.0

revived

Events

EventEvent DataFired WhenNotesSince GEP Ver.
revivednullThe local player was revived146.0

death

Events

EventEvent DataFired WhenNotesSince GEP Ver.
deathnullThe local player diesSee notes146.0
knockedoutnullThe local player is knocked-outSee notes146.0

death note

Data Example:

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

knockedout note

Data Example:

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

killer

Events

EventEvent DataFired WhenNotesSince GEP Ver.
killerThe killer’s nicknameThe local player was killed by one of the players146.0

killer notes:

When one of local player’s squad members kill the local player, the provided data will be "self_kill”.

team_feed

Events

EventEvent DataFired WhenNotesSince GEP Ver.
team_feedAction name, attacker name, weapon name, and victim name.Whenever a game update appears in the middle of the screen.See notes148.0

team_feed note

Data Examples:

{"events":[{"name":"team_feed","data":"{"message":"YouKilledPlayer","attacker":"Shargaas","weapon": "SKS","victim":"sOrgUsUs"}"}]}
{"events":[{"name":"team_feed","data":"{"message":"YourTeammateKilledPlayer","attacker":"KingSlayer3x","weapon": "QBZ","victim":"4Senius"}"}]}
{"events":[{"name":"team_feed","data":"{"message":"YourTeammateHaveBeenPutDown","attacker":"Egemen365", "weapon":"SLR","victim":"KingSlayer3x"}"}]}
{"events":[{"name":"team_feed","data":"{"message":"YouPutDownPlayer","attacker":"Shargaas","weapon": "M416","victim":"cerenihat}"}]}

team

Info Updates

keyCategoryValuesNotesSince GEP Ver.
nicknamesmatch_infoThe nicknames of your team members.See notes151.0

nicknames note

Data Example:

{"info":{"match_info":{"nicknames":"{"team_members":["REMT1","Shargaas","anselxx"]}"}},"feature":"team"}
Last updated on 2020-10-13 by eransharv
← PUBGRainbow Six Siege →
  • Sample Apps
  • Available Features
  • Game events status
  • gep_internal
    • Info Updates
  • kill
    • Info Updates
    • Events
  • match
    • Info Updates
    • Events
  • rank
    • Info Updates
  • me
    • Info Updates
  • phase
    • Info Updates
  • map
    • Info Updates
  • revived
    • Events
  • death
    • Events
  • killer
    • Events
  • team_feed
    • Events
  • team
    • Info Updates
  • 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