Skip to content
TLGPSDocumentation

Developer documentation

Gateway / V1

Heartbeat

Gateway V1 connections, subscriptions and supported updates.

Gateway connections are long-lived and may remain open for extended periods of time.

To verify that both the client and the gateway remain reachable, the Fleet Management Gateway implements a heartbeat mechanism.

Clients should periodically send a ping message.

The gateway responds with a corresponding pong message containing the current gateway timestamp.

Failure to maintain heartbeat traffic may result in the connection being closed by the gateway.

Heartbeat Interval

The Fleet Management Gateway continuously monitors authenticated connections.

Clients should periodically send ping messages throughout the lifetime of the connection.

If no heartbeat is received within the configured idle timeout, the gateway closes the connection.

The default configuration is:

Setting Default
Idle timeout 120 seconds
Recommended ping interval 30–60 seconds

Applications should send heartbeat messages more frequently than the configured timeout.


Ping

Clients send a heartbeat request using the following message.

{
    "type": "ping",
    "data": {}
}

Pong

The gateway responds with:

{
    "type": "pong",
    "timestamp": "2026-06-30T19:38:34+02:00",
    "data": {}
}

The returned timestamp represents the Fleet Management server time.


Heartbeat Notes

  • Heartbeats verify that both endpoints remain connected.
  • Heartbeat messages do not require any subscription.
  • Heartbeat messages contain no telemetry.
  • Clients should continue sending heartbeat requests for the lifetime of the connection.
  • The gateway may terminate idle or unresponsive connections.

Closing Connection

Close Reasons

Reason Description
heartbeat_timeout Client stopped sending heartbeats
duplicate_authentication Client attempted to authenticate an authenticated connection
server_shutdown Gateway is shutting down
maintenance Gateway is entering maintenance
unauthorized Authentication timed out or bounded authorization is no longer valid
protocol_violation Gateway closed the connection for a protocol violation

Public documentation · authorized integration access required

Engineering-maintained documentation. Examples use synthetic data and placeholder credentials.

Back to top