Skip to main content
POST
/
lobbies
/
{id}
/
heartbeat
Send a heartbeat signal for a player in a lobby
curl --request POST \
  --url https://api.scale.computeflow.cloud/lobbies/{id}/heartbeat \
  --header 'Content-Type: application/json' \
  --data '{
  "playerId": "player123"
}'
{
  "success": true,
  "timestamp": "2023-11-07T05:31:56Z",
  "playerId": "<string>"
}

Path Parameters

​
id
string
required

Lobby ID

Query Parameters

​
name
string
required

Name of the lobby configuration this lobby belongs to

Body

application/json
​
playerId
string
required

ID of the player sending the heartbeat

Example:

"player123"

Response

Heartbeat recorded successfully

​
success
boolean
​
timestamp
string<date-time>
​
playerId
string
⌘I