Open a realtime connection

Opens a temporary pre-authorized public realtime websocket connection URL for RFC 085 ProductEvent delivery. API keys are validated only on this HTTP route; the websocket uses the returned temporary ticket URL and the ando.realtime.v1 subprotocol.

Request body

Example request

{
  "subscriptions": [
    {
      "target": {
        "id": "01jzn7e61x3a7v9h2r7t2m3q4p"
      }
    }
  ]
}

Response

Opened temporary realtime connection.

approximate_connection_time_secondsnumber nullable required

Approximate maximum connection lifetime in seconds. Resume near a cursor deadline can shorten it.

connection_idstring required

Realtime connection identifier.

expires_atstring date-time required

Timestamp when the returned connection URL expires if unused. Resume near a cursor deadline can shorten the normal URL lifetime.

expires_in_secondsinteger required

Seconds until the returned connection URL expires if unused, capped by any resume-cursor deadline.

heartbeat_interval_secondsinteger required

Recommended heartbeat interval for the socket.

protocol'ando.realtime.v1' required

Required websocket subprotocol.

resume_supportedboolean required

Whether bounded resume is supported for this connection.

resume_cursorstring required

Safe cursor for the connection's initial ledger floor. Persist it before opening the websocket, then replace it only after the server confirms an ordered acknowledgement or sends a planned-disconnect checkpoint.

urlstring required

Temporary pre-authorized websocket URL. Treat the ticket query parameter as secret.

Example response

{
  "connection_id": "01jzn7e61x3a7v9h2r7t2m3q4p",
  "expires_at": "2026-05-14T08:00:00.000Z",
  "subscriptions": [
    {
      "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
      "target": {
        "id": "01jzn7e61x3a7v9h2r7t2m3q4p"
      }
    }
  ]
}