preview reference
This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint.
Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.
GET /v1/preview/live
Section titled “GET /v1/preview/live”Authentication: Public or secret app API key; customer/session proof is still required wherever the operation acts on an identity.
Request
Section titled “Request”Use the path parameters above and any query options described below.
Response
Section titled “Response”Open a WebSocket with Upgrade: websocket. A normal HTTP request receives status 426 (Expected WebSocket upgrade). The connection is scoped to the authenticated app and environment.
JSON response shape
{ error: string; message: string; }Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.
Implementation · Handler: inline route handler.