WebSocket Events

Real-time event reference for CDE CAD using Socket.io. Subscribe to calls, unit locations, panic alerts, BOLOs, and announcements.

Connection & Rooms

Connect to the CDE CAD Socket.io server and join a community room to start receiving events. Each community operates as an isolated room identified by its communityId.

Connecting with socket.io-client

import { io } from "socket.io-client";

const socket = io("wss://cdecad.com", {
  transports: ["websocket"],
  auth: {
    token: "your-jwt-token-here"
  }
});

socket.on("connect", () => {
  console.log("Connected:", socket.id);

  // Join a community room
  socket.emit("join-community", "64a1b2c3d4e5f6a7b8c9d0e1");
});

socket.on("connect_error", (err) => {
  console.error("Connection failed:", err.message);
});

Call Events

These events are emitted by the server whenever a dispatch call is created, updated, or deleted. All call events are broadcast to the relevant community room.

// Example payload
{
  "_id": "64f1a2b3c4d5e6f7a8b9c0d1",
  "incidentNumber": "INC-2024-001542",
  "callType": "Robbery",
  "location": "245 Vespucci Blvd",
  "caller": "John Doe",
  "description": "Armed robbery in progress at convenience store",
  "priority": "1",
  "timestamp": "2024-09-15T22:30:00.000Z"
}

// Example payload
{
  "callId": "64f1a2b3c4d5e6f7a8b9c0d1",
  "assignedUnits": ["unit-101", "unit-204"],
  "note": {
    "text": "Suspect fled on foot heading northbound",
    "addedBy": "Dispatcher_Smith",
    "addedAt": "2024-09-15T22:35:00.000Z"
  }
}

911 Specific Events

These events are specific to 911 emergency calls routed through the dispatch system, including map marker data and alert triggers.

// Payload: Array of active 911 call objects
[
  {
    "_id": "64f1a2b3c4d5e6f7a8b9c0d1",
    "incidentNumber": "INC-2024-001542",
    "callType": "Robbery",
    "location": "245 Vespucci Blvd",
    "status": "active",
    "priority": "1",
    "assignedUnits": [...],
    ...
  },
  ...
]

Unit & Location Events

Events for tracking unit positions, status changes, and online/offline state. Location data uses raw GTA V world coordinates.

// Example payload
{
  "unitId": "officer-42",
  "unitName": "1-Adam-12",
  "x": -1037.58,
  "y": -2738.21,
  "z": 13.76,
  "lat": 33.9425,
  "lng": -118.408,
  "heading": 245.3,
  "job": "police",
  "status": "10-8",
  "postal": "274",
  "communityId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "timestamp": "2024-09-15T22:30:00.000Z",
  "lastUpdate": "2024-09-15T22:30:00.000Z"
}

// Payload: Object map of unit locations
{
  "officer-42": {
    "unitId": "officer-42",
    "unitName": "1-Adam-12",
    "x": -1037.58,
    "y": -2738.21,
    "z": 13.76,
    "heading": 245.3,
    "status": "10-8",
    "postal": "274",
    "timestamp": "2024-09-15T22:30:00.000Z"
  },
  "officer-77": {
    "unitId": "officer-77",
    "unitName": "2-Lincoln-30",
    ...
  }
}

Request Events

Client-to-server events used to request current state. The server responds with the corresponding data event.

Unit Assignment Events

Events related to assigning and removing units from active calls.

Alert Events

High-priority events for panic buttons, BOLOs, and community announcements. These events require immediate client-side handling.

// Example payload
{
  "officerName": "Officer Martinez",
  "officerId": "officer-42",
  "location": "Strawberry Ave & Capital Blvd",
  "postal": "342",
  "coordinates": { "x": 243.7, "y": -1529.3, "z": 29.2 },
  "communityId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "communityName": "San Andreas State RP",
  "serverName": "SASRP Main",
  "timestamp": "2024-09-15T22:45:00.000Z",
  "source": "fivem"
}

// Example payload
{
  "_id": "64f1a2b3c4d5e6f7a8b9c0d2",
  "title": "Server Maintenance Notice",
  "message": "The CAD system will undergo maintenance tonight at 02:00 UTC.",
  "priority": "warning",
  "communityId": "64a1b2c3d4e5f6a7b8c9d0e1",
  "createdByName": "Admin_Jones",
  "expiresAt": "2024-09-16T06:00:00.000Z"
}

Complete JavaScript Client Example

A full working example using socket.io-client v4 that connects, joins a community, and listens for calls, unit updates, and panic alerts.

import { io } from "socket.io-client";

// ── Configuration ────────────────────────────────────────
const SOCKET_URL   = "wss://cdecad.com";
const JWT_TOKEN    = "your-jwt-token";
const COMMUNITY_ID = "64a1b2c3d4e5f6a7b8c9d0e1";

// ── Connect ──────────────────────────────────────────────
const socket = io(SOCKET_URL, {
  transports: ["websocket"],
  auth: { token: JWT_TOKEN },
  reconnection: true,
  reconnectionAttempts: 10,
  reconnectionDelay: 2000
});

// ── Connection Lifecycle ─────────────────────────────────
socket.on("connect", () => {
  console.log("[WS] Connected:", socket.id);

  // Join the community room
  socket.emit("join-community", COMMUNITY_ID);

  // Request current state
  socket.emit("request-locations", { communityId: COMMUNITY_ID });
  socket.emit("request-911-calls", { communityId: COMMUNITY_ID });
});

socket.on("disconnect", (reason) => {
  console.warn("[WS] Disconnected:", reason);
});

socket.on("connect_error", (err) => {
  console.error("[WS] Connection error:", err.message);
});

// ── Call Events ──────────────────────────────────────────
socket.on("new-911-call", (call) => {
  console.log("[CALL] New 911 call:", call.incidentNumber, call.callType);
  console.log("  Location:", call.location);
  console.log("  Priority:", call.priority);
  // Add to dispatch board UI...
});

socket.on("callUpdated", (call) => {
  console.log("[CALL] Updated:", call.incidentNumber);
  // Refresh call card in UI...
});

socket.on("call-deleted", (data) => {
  console.log("[CALL] Deleted:", data.incidentNumber, "by", data.deletedBy);
  // Remove from dispatch board...
});

socket.on("call-note-added", (data) => {
  console.log("[CALL] Note on", data.callId, ":", data.note.text);
  // Append note to call detail view...
});

// ── 911 Alerts ───────────────────────────────────────────
socket.on("911Alert", (alert) => {
  console.log("[911] ALERT:", alert.callType, "at", alert.location);
  playAlertSound(alert.priority);
  showNotification(alert);
});

socket.on("current911Calls", (calls) => {
  console.log("[911] Received", calls.length, "active calls");
  // Populate dispatch board with current calls...
});

// ── Unit Locations ───────────────────────────────────────
socket.on("unitLocationUpdate", (unit) => {
  console.log("[UNIT]", unit.unitName, "at", unit.x, unit.y, unit.z);
  // Update map marker...
});

socket.on("unitLocationRemoved", (data) => {
  console.log("[UNIT] Offline:", data.unitName);
  // Remove marker from map...
});

socket.on("unit-auto-offline", (data) => {
  console.log("[UNIT] Auto-offline:", data.callSign, "-", data.reason);
});

socket.on("currentLocations", (locations) => {
  console.log("[UNIT] Received", Object.keys(locations).length, "locations");
  // Initialize all map markers...
});

// ── Panic Button ─────────────────────────────────────────
socket.on("panic-button", (panic) => {
  console.error("[PANIC]", panic.officerName, "at", panic.location);
  console.error("  Postal:", panic.postal, "Source:", panic.source);

  // Trigger urgent UI alert
  showPanicOverlay(panic);
  playPanicAlarm();
  flashMapMarker(panic.coordinates);
});

// ── BOLOs & Announcements ────────────────────────────────
socket.on("new-bolo", (bolo) => {
  console.log("[BOLO] New BOLO received:", bolo);
  // Display BOLO notification...
});

socket.on("new-announcement", (announcement) => {
  console.log("[ANNOUNCE]", announcement.title, "-", announcement.priority);
  // Show announcement banner...
});

socket.on("announcement-removed", (data) => {
  console.log("[ANNOUNCE] Removed:", data.id);
  // Remove announcement banner...
});

// ── Cleanup on page unload ───────────────────────────────
window.addEventListener("beforeunload", () => {
  socket.emit("leave-community", COMMUNITY_ID);
  socket.disconnect();
});

// ── Helper functions (implement per your UI framework) ───
function playAlertSound(priority) { /* ... */ }
function playPanicAlarm() { /* ... */ }
function showNotification(alert) { /* ... */ }
function showPanicOverlay(panic) { /* ... */ }
function flashMapMarker(coords) { /* ... */ }

Event Quick Reference