Skip to content

WebSocket Events

The server sends an event message through the WebSocket channel when an event occurs and client has subscription on this. All event messages contain the next fields:

  • type - enum. "event".
  • event - enum. Can be "state", "state_batch", "lifecycle", or "logout".
  • data - optional object. Specific event payload.

State event

Can be used for 100 devices. If there are more devices, please use state batch event

These messages are coming from server if client subscribed to the state events of the specific tracker that not blocked. It occurs in the next cases:

  • Tracker state changed.
  • Immediately after subscription.
  • Immediately after unblocking.

Message fields:

  • type - "event".
  • event - "state".
  • data - depends on format request parameter:
  • user_time - current time in user's timezone.

Message sample:

{
  "type": "event",
  "event": "state",
  "user_time": "2018-10-17 12:51:55",
  "data": {
    "source_id": 10284,
    "gps": {
      "updated": "2018-10-17 12:51:43",
      "signal_level": 100,
      "location": {
        "lat": 14.330065796228606,
        "lng": -90.99037259141691
      },
      "heading": 248,
      "speed": 0,
      "alt": 431
    },
    "connection_status": "active",
    "movement_status": "parked",
    "gsm": null,
    "last_update": "2018-10-17 12:51:46",
    "battery_level": null,
    "battery_update": null,
    "inputs": [false, false, false, false, false, false, false, false],
    "inputs_update": "2018-10-17 12:51:43",
    "outputs": [false, false, false, false, false, false, false, false],
    "outputs_update": "2018-10-17 12:51:43",
    "actual_track_update": "2018-10-04 22:47:07"
  }
}

source_id is not a tracker_id.

State batch event

These messages are coming from server if client subscribed to the state_batch events of the specific tracker that not blocked. It occurs in the next cases:

  • Immediately after subscription.
  • rate_limit period passed.

Message fields:

  • type - "event".
  • event - "state".
  • data - depends on format request parameter:
  • user_time - current time in user's timezone.

Message sample:

{
  "type": "event",
  "event": "state_batch",
  "user_time": "2018-10-17 12:51:55",
  "data": [
    {
      "source_id": 10284,
      "gps": {
        "updated": "2018-10-17 12:51:43",
        "signal_level": 100,
        "location": {
          "lat": 14.330065796228606,
          "lng": -90.99037259141691
        },
        "heading": 248,
        "speed": 0,
        "alt": 431
      },
      "connection_status": "active",
      "movement_status": "parked",
      "gsm": null,
      "last_update": "2018-10-17 12:51:46",
      "battery_level": null,
      "battery_update": null,
      "inputs": [false, false, false, false, false, false, false, false],
      "inputs_update": "2018-10-17 12:51:43",
      "outputs": [false, false, false, false, false, false, false, false],
      "outputs_update": "2018-10-17 12:51:43",
      "actual_track_update": "2018-10-04 22:47:07"
    }
  ]
}

source_id is not a tracker_id.

Compact source state

Sample:

{
  "source_id": 10284,
  "gps": {
    "updated": "2018-10-17 12:51:43",
    "signal_level": 100,
    "location": {
      "lat": 14.330065796228606,
      "lng": -90.99037259141691
    },
    "heading": 248,
    "speed": 0,
    "alt": 431
  },
  "connection_status": "active",
  "movement_status": "parked",
  "last_update": "2018-10-17 12:51:46"
}

Lifecycle event

These messages are coming from the server if client subscribed to the state events of the specific tracker. It occurs in the next cases:

  • Tracker blocked.
  • Tracker unblocked.
  • Tracker corrupted (removed).

Message fields:

  • type - "event".
  • event - "lifecycle".
  • data - required object.
    • source_id - source ID.
    • lifecycle_event - lifecycle event type. Can be "block", "unblock", or "corrupt".

Message sample:

{
  "type": "event",
  "event": "lifecycle",
  "data": {
    "source_id": 123456,
    "lifecycle_event": "block"
  }
}

Logout event

These messages are coming from server if client subscribed to any event. It occurs in the next cases:

  • User logged out.
  • User session expired (did not renew during one month).
  • Sub-user is blocked by master-user.
  • User has restored his password.
  • User has changed his password.
  • User blocked from admin panel.
  • User was corrupted (removed).

Message fields:

  • type - "event".
  • event - "logout".
  • data - "session closed".

Message sample: 

{
  "type": "event",
  "event": "logout",
  "data": "session closed"
}

Last update: October 16, 2024