Keywords: 
This table documents real-time events available as of 3.11.0 PM Pro API release:
 
Real-time Event Descriptions
Event Type Description Response Sample Protocol
Mute on* Raw This event is triggered when Mute button is pressed from the headset​ {
  "eventType": "isMute",
  "product": {
    "headset": "",
    "baseId": "0AGUEX"
  },
  "timeStamp": "2018-01-22T21:25:32.344452Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isMute": "true"
}
 
Pubnub
Mute off* Raw This event is triggered when the user un-mutes from the headset
 
{
  "eventType": "isMute",
  "product": {
    "headset": "",
    "baseId": "0AGUEX"
  },
  "timeStamp": "2018-01-22T21:25:32.344452Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isMute": "true"
}
 
Pubnub
Quick
connect
Raw This event is triggered when the headset is connected
(e.g. DA90 connectors)
{
  "eventType": "isConnected",
  "product": {
    "headset": "0BG8UK",
    "baseId": "0AGUEX"
  },
  "timeStamp": "2018-01-22T21:33:27.883175Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isConnected": "true"
}
 
Pubnub
Quick
disconnect
Raw This event is triggered when the headset is disconnected
(e.g. DA90 connectors)
 
{
  "eventType": "isConnected",
  "product": {
    "headset": "",
    "baseId": "0AGUEX"
  },"timeStamp": "2018-01-22T21:33:21.703756Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isConnected": "false"
}
Pubnub
Headset talk button Raw This event is triggered when the call is answered by pressing the call button on the headset
 
{
  "eventType": "HEADSET_BUTTON_TALK",
  "product": {
    "headset": "0BG8UK",
    "baseId": "0AGUEX"
  },
  "timeStamp": "2018-01-22T21:37:07.764642Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isHeadSetTalk": "true"
}
 
Pubnub
Headset reject button Raw This event is triggered when the call is rejected by long-pressing the call button on the headset
 
{
  "eventType": "HEADSET_BUTTON_REJECT",
  "product": {
    "headset": "",
    "baseId": "S/N0KTH5M"
  },
  "timeStamp": "2018-01-22T23:03:53.826856Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isHeadSetTalk": "false"
}
 
Pubnub
Headset DON Raw This event is triggered when the user wears the headset {
  "eventType": "HS_STATE_CHANGE_DON",
  "product": {
    "headset": "",
    "baseId": ""
  },
  "timeStamp": "2018-01-22T21:39:28.741616Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326","isDon": "true"
}
 
Pubnub
Headset DOFF​ Raw This event is triggered when the user removes the headset {
  "eventType": "HS_STATE_CHANGE_DOFF",
  "product": {
    "headset": "",
    "baseId": ""
  },
  "timeStamp": "2018-01-22T21:40:02.288749Z",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "isDon": "false"
}
 
Pubnub
Call event Raw This event is triggered when the call is initiated/ended. {
  "eventType": "CALL_EVENT",
  "relatedDeviceEvent": "",
  "userAction": "softphoneUI",
  "lineType": "VOIP",
  "pluginId": "2100",
  "callId": "39432832041432742996",
  "deviceId": "441A49D95E781546A1174A4AEBA40095",
  "source": "Microsoft Lync & Skype for Business",
  "type": "call",
  "eventTime": "2018-01-22T21:43:30.616683Z",
  "sessionId": "eb3633e0-b22e-4837-9c31-08991eb99d9a",
  "duration": 7000,
  "softphoneVersion": "16.0.8730.2127",
  "direction": "outgoing",
  "name": "ended",
  "tenantId": "752ed37b-fcc6-4532-aae4-c78d3f659326",
  "product": {
    "headset": "",
    "baseId": ""
  }
}
 
Pubnub
Link Quality (LQ) notification Aggregated This event is generated at the end of a call with the aggregated LQ metrics for the call.   WebSockets (native)


any of the Plantronics Hub supported headsets