FiveM Integration

Auto-register your FiveM server with CDE CAD. No authentication required — the server is matched to an existing community automatically.

Request Body

Community Matching Priority

The server is matched to a community using the following priority order:

1. discordId — Matches against the community's Discord guild ID (most reliable).
2. license — Matches against a previously registered FiveM license.
3. serverName — Matches against a known server name.

Response

{
  "success": true,
  "communityId": "abc123def456",
  "communityName": "My RP Community",
  "apiKey": "fvm_a1b2c3d4..."
}

Lua Example

PerformHttpRequest('https://cdecad.com/api/fivem/register', function(statusCode, response, headers)
    if statusCode == 200 then
        local data = json.decode(response)
        if data.success then
            print('[CDE CAD] Registered! Community: ' .. data.communityName)
            print('[CDE CAD] API Key: ' .. data.apiKey)
            -- Store the API key for future requests
            Config.ApiKey = data.apiKey
            Config.CommunityID = data.communityId
        end
    else
        print('[CDE CAD] Registration failed: ' .. tostring(statusCode))
    end
end, 'POST', json.encode({
    serverName  = GetConvar('sv_hostname', 'Unknown'),
    license     = GetConvar('sv_licenseKey', ''),
    discordId   = '1200664516858495056',
    ip          = GetConvar('web_baseUrl', '127.0.0.1'),
    port        = GetConvarInt('sv_port', 30120),
    maxPlayers  = GetConvarInt('sv_maxClients', 32)
}), {
    ['Content-Type'] = 'application/json'
})

Send periodic heartbeats to keep your server marked as online in CDE CAD.

Request Body

Response

{
  "success": true
}

Lua Example

-- Send heartbeat every 60 seconds
Citizen.CreateThread(function()
    while true do
        Citizen.Wait(60000)

        PerformHttpRequest(Config.CadUrl .. '/api/fivem/heartbeat', function(statusCode, response, headers)
            if statusCode == 200 then
                print('[CDE CAD] Heartbeat sent successfully')
            else
                print('[CDE CAD] Heartbeat failed: ' .. tostring(statusCode))
            end
        end, 'POST', json.encode({
            playerCount = #GetPlayers(),
            serverInfo  = {
                license = GetConvar('sv_licenseKey', '')
            }
        }), {
            ['Content-Type'] = 'application/json',
            ['x-api-key']    = Config.ApiKey
        })
    end
end)

Create a new 911 call from your FiveM server. The call appears on the dispatch board in real time.

Request Body

Response (201 Created)

{
  "success": true,
  "_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "incidentNumber": "911-20240601-0042",
  "message": "911 call created successfully"
}

Lua Example

function Send911Call(callType, location, description, callerName)
    local playerPed = PlayerPedId()
    local coords    = GetEntityCoords(playerPed)
    local street, _  = GetStreetNameAtCoord(coords.x, coords.y, coords.z)
    local streetName = GetStreetNameFromHashKey(street)

    local payload = json.encode({
        callType    = callType,
        location    = location or streetName,
        callerName  = callerName or GetPlayerName(PlayerId()),
        serverName  = Config.ServerName,
        description = description or '',
        coordinates = {
            x = coords.x,
            y = coords.y,
            z = coords.z
        },
        postal      = GetNearestPostal(coords),  -- your postal resource
        communityId = Config.CommunityID
    })

    PerformHttpRequest(Config.CadUrl .. '/api/fivem/911', function(statusCode, response, headers)
        if statusCode == 201 then
            local data = json.decode(response)
            print('[CDE CAD] 911 call created: ' .. data.incidentNumber)
        else
            print('[CDE CAD] 911 call failed: ' .. tostring(statusCode))
            -- Fallback: try x-payload header for Cloudflare compatibility
            if statusCode == 400 then
                PerformHttpRequest(Config.CadUrl .. '/api/fivem/911', function(sc, res, hdr)
                    if sc == 201 then
                        print('[CDE CAD] 911 call created via x-payload fallback')
                    end
                end, 'POST', '', {
                    ['Content-Type'] = 'application/json',
                    ['x-api-key']    = Config.ApiKey,
                    ['x-payload']    = Base64Encode(payload)
                })
            end
        end
    end, 'POST', payload, {
        ['Content-Type'] = 'application/json',
        ['x-api-key']    = Config.ApiKey
    })
end

Legacy alias for the 911 call endpoint. Accepts the same body and returns the same response. Provided for backward compatibility.

Trigger a panic alert for an officer. This emits a panic-button WebSocket event to all connected dispatchers and officers in the community.

Request Body

WebSocket Event Emitted

When a panic is triggered, a panic-button event is emitted to the community's WebSocket room containing the officer name, location, coordinates, and timestamp.

Response

{
  "success": true,
  "message": "Panic alert triggered successfully"
}

Lua Example

function TriggerPanic(officerName, officerId)
    local playerPed  = PlayerPedId()
    local coords     = GetEntityCoords(playerPed)
    local street, _  = GetStreetNameAtCoord(coords.x, coords.y, coords.z)
    local streetName = GetStreetNameFromHashKey(street)

    PerformHttpRequest(Config.CadUrl .. '/api/fivem/panic', function(statusCode, response, headers)
        if statusCode == 200 then
            local data = json.decode(response)
            print('[CDE CAD] Panic triggered: ' .. data.message)
        else
            print('[CDE CAD] Panic failed: ' .. tostring(statusCode))
        end
    end, 'POST', json.encode({
        officerName = officerName,
        officerId   = officerId or 'UNKNOWN',
        location    = streetName,
        serverName  = Config.ServerName,
        postal      = GetNearestPostal(coords),
        coordinates = {
            x = coords.x,
            y = coords.y,
            z = coords.z
        },
        communityId = Config.CommunityID
    }), {
        ['Content-Type'] = 'application/json',
        ['x-api-key']    = Config.ApiKey
    })
end

-- Keybind example: F9 to trigger panic
RegisterKeyMapping('panic_button', 'CAD Panic Button', 'keyboard', 'F9')
RegisterCommand('panic_button', function()
    local name = GetPlayerName(PlayerId())
    TriggerPanic(name, Config.OfficerId)
end, false)

Update a unit's location on the live dispatch map. Send this periodically (every 5-10 seconds) for each active unit.

Request Body

Response

{
  "success": true,
  "message": "Location updated",
  "unitId": "unit_1a2b3c",
  "coordinates": {
      "x": -432.15,
      "y": -29.87
  },
  "postal": "342"
}

Lua Example

-- Send location updates for on-duty officers every 5 seconds
Citizen.CreateThread(function()
    while true do
        Citizen.Wait(5000)

        if isOnDuty then
            local playerPed = PlayerPedId()
            local coords    = GetEntityCoords(playerPed)
            local heading   = GetEntityHeading(playerPed)

            PerformHttpRequest(Config.CADEndpoint, function(statusCode, response, headers)
                if statusCode ~= 200 then
                    print('[LiveMap] Update failed: ' .. tostring(statusCode))
                end
            end, 'POST', json.encode({
                unitId      = Config.UnitId or GetPlayerServerId(PlayerId()),
                unitName    = Config.UnitName or GetPlayerName(PlayerId()),
                x           = coords.x,
                y           = coords.y,
                z           = coords.z,
                heading     = heading,
                job         = PlayerJob or 'police',
                status      = DutyStatus or 'available',
                postal      = GetNearestPostal(coords),
                communityId = Config.CommunityID
            }), {
                ['Content-Type'] = 'application/json',
                ['X-API-Key']    = Config.APIKey
            })
        end
    end
end)

Retrieve all active unit locations for a community. Useful for building custom map displays or checking which units are being tracked.

Query Parameters

Response

[
  {
    "unitId": "unit_1a2b3c",
    "unitName": "1-Adam-12",
    "x": -432.15,
    "y": -29.87,
    "z": 39.12,
    "heading": 180.5,
    "job": "police",
    "status": "available",
    "postal": "342",
    "lastUpdate": "2024-06-01T12:34:56.789Z"
  },
  {
    "unitId": "unit_4d5e6f",
    "unitName": "Medic-3",
    "x": 310.22,
    "y": -590.88,
    "z": 43.29,
    "heading": 90.0,
    "job": "ems",
    "status": "en-route",
    "postal": "128",
    "lastUpdate": "2024-06-01T12:34:52.123Z"
  }
]

Create or update a civilian record from FiveM. If a civilian with the same SSN exists, it will be updated; otherwise, a new record is created.

Request Body

Send the full civilian data object. Fields may include:

Lua Example

function SyncCharacterToCAD(charData)
    PerformHttpRequest(Config.CadUrl .. '/api/civilian/fivem-sync-character', function(statusCode, response, headers)
        if statusCode == 200 or statusCode == 201 then
            local data = json.decode(response)
            print('[CDE CAD] Character synced: ' .. charData.firstName .. ' ' .. charData.lastName)
        else
            print('[CDE CAD] Character sync failed: ' .. tostring(statusCode))
        end
    end, 'POST', json.encode({
        firstName   = charData.firstName,
        lastName    = charData.lastName,
        ssn         = charData.ssn,
        dateOfBirth = charData.dob,
        gender      = charData.gender,
        race        = charData.race,
        address     = charData.address,
        phone       = charData.phone,
        occupation  = charData.job,
        communityId = Config.CommunityID
    }), {
        ['Content-Type'] = 'application/json',
        ['x-api-key']    = Config.ApiKey
    })
end

Look up a civilian record by their SSN. Returns the full civilian profile if found.

Path Parameters

Lua Example

function LookupCivilian(ssn)
    PerformHttpRequest(Config.CadUrl .. '/api/civilian/fivem-civilian/' .. ssn, function(statusCode, response, headers)
        if statusCode == 200 then
            local civilian = json.decode(response)
            print('[CDE CAD] Found: ' .. civilian.firstName .. ' ' .. civilian.lastName)
            -- Use civilian data in-game
        elseif statusCode == 404 then
            print('[CDE CAD] No civilian found with SSN: ' .. ssn)
        end
    end, 'GET', '', {
        ['x-api-key'] = Config.ApiKey
    })
end

Look up a vehicle record by its license plate. Returns the full vehicle profile including registered owner information.

Path Parameters

Lua Example

function LookupVehicle(plate)
    PerformHttpRequest(Config.CadUrl .. '/api/civilian/fivem-vehicle/' .. plate, function(statusCode, response, headers)
        if statusCode == 200 then
            local vehicle = json.decode(response)
            print('[CDE CAD] Vehicle: ' .. vehicle.make .. ' ' .. vehicle.model)
            print('[CDE CAD] Owner: ' .. vehicle.ownerName)
        elseif statusCode == 404 then
            print('[CDE CAD] No vehicle found with plate: ' .. plate)
        end
    end, 'GET', '', {
        ['x-api-key'] = Config.ApiKey
    })
end

Register a vehicle from FiveM into the CAD database. Links the vehicle to an existing civilian record.

Lua Example

function RegisterVehicleInCAD(vehicleData)
    PerformHttpRequest(Config.CadUrl .. '/api/civilian/fivem-register-vehicle', function(statusCode, response, headers)
        if statusCode == 200 or statusCode == 201 then
            local data = json.decode(response)
            print('[CDE CAD] Vehicle registered: ' .. vehicleData.plate)
        else
            print('[CDE CAD] Vehicle registration failed: ' .. tostring(statusCode))
        end
    end, 'POST', json.encode(vehicleData), {
        ['Content-Type'] = 'application/json',
        ['x-api-key']    = Config.ApiKey
    })
end

Delete a civilian character record by SSN. This permanently removes the character from the CAD database.

Path Parameters

Lua Example

function DeleteCharacterFromCAD(ssn)
    PerformHttpRequest(Config.CadUrl .. '/api/civilian/fivem-delete-character/' .. ssn, function(statusCode, response, headers)
        if statusCode == 200 then
            print('[CDE CAD] Character deleted: ' .. ssn)
        else
            print('[CDE CAD] Delete failed: ' .. tostring(statusCode))
        end
    end, 'DELETE', '', {
        ['x-api-key'] = Config.ApiKey
    })
end

Retrieve the current FiveM integration settings for a community.

Path Parameters

Response

{
  "fivemServerIP": "123.45.67.89",
  "fivemServerPort": 30120,
  "enableAutoPlateReader": true,
  "enablePanicButton": true,
  "enable911Integration": true,
  "enableTrafficStops": false,
  "enableStatusUpdates": true,
  "webhookUrl": "https://discord.com/api/webhooks/..."
}

Update FiveM integration settings for a community.

Request Body

Response

{
  "success": true,
  "message": "FiveM settings updated"
}

Generate a new FiveM API key for the community. The previous key is invalidated. The full key is returned only once in the response — store it securely.

Response

{
  "success": true,
  "apiKey": "fvm_a1b2c3d4e5f6...full_64_hex_characters"
}

Test the connection to your FiveM server from CDE CAD. Uses a 5-second timeout to verify the server is reachable.

Request Body

Response (Success)

{
  "success": true,
  "message": "Connection successful",
  "responseTime": 45
}

Response (Timeout)

{
  "success": false,
  "message": "Connection timed out after 5000ms"
}