Receive heartbeat from external device

POST

/heartbeat

Receive heartbeat from external devices to maintain operational status.

External Device Integration:

External devices POST status to keep operational flag active

Auto-registers new devices on first heartbeat

Device marked offline if no heartbeat within timeout (default: 5 minutes)

Use Cases:

Temperature sensors reporting metrics

Security cameras sending status

Kiosks sending health checks

Request Fields:

serialNumber (required): Unique device identifier

operational (optional): Device health status (default: true)

friendlyName (optional): Device name (used on first registration)

properties (optional): Device-specific metrics (JSON)

Auto-Registration:

First heartbeat from unknown serialNumber creates device record

Subsequent heartbeats update health status and properties

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Heartbeat received successfully

Body

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Temperature sensor heartbeatSecurity camera heartbeat

curl --location --request POST '/heartbeat' \
--header 'Content-Type: application/json' \
--data-raw '{
    "serialNumber": "sensor-001-abc123",
    "operational": true,
    "friendlyName": "Warehouse Temperature Sensor",
    "properties": {
        "temperature_c": 22.5,
        "humidity_percent": 45,
        "battery_percent": 85
    }
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Heartbeat received"
}

Modified at 2026-02-20 22:56:40

Get bank type with associations

Locker