Skip to main content
POST
Heartbeat a session
Updates last_activity_at on an ACTIVE session so idle cleanup does not reclaim it. Send it periodically while your integration is running; the WebSocket ping/pong covers connection-level liveness, while this REST heartbeat covers account-level activity tracking.
Returns { "message": "Heartbeat received", "sessionId", "status" }. Fails with SESSION_NOT_ACTIVE once the session leaves ACTIVE.

Authorizations

x-api-key
string
header
required

FaceMode API key (fm_...).

Path Parameters

id
string<uuid>
required

Session ID (UUID).

Response

Heartbeat received.

message
string
Example:

"Heartbeat received"

sessionId
string<uuid>
status
enum<string>

Session lifecycle state. New sessions start ACTIVE; ended sessions are terminal.

Available options:
IDLE,
ACTIVE,
ENDED