Protocols and formats

WebSocket

Text or binary frames. A common format is JSON: { "tenant": "...", "channel": "...", "payload": "..." }. Subscribe and control messages use the same transport. Exact message types and frame layout depend on your deployment; ask your operator or see the API docs.

gRPC

Request/response and stream definitions are in the project’s proto file: common/proto/perimeter.proto. Use gRPC reflection (e.g. with grpcurl) to discover services and methods, or import the proto to generate client code.

REST

JSON request and response bodies. All token endpoints are under /v1/. See REST API and the server’s OpenAPI (Swagger) docs at /swagger-ui for the full schema.

Tokens

Access tokens are strings like AT_<token_id>_<secret>. They are created via the REST API (POST /v1/get-token) and passed when opening a WebSocket (via Authorization header or Sec-WebSocket-Protocol subprotocol) or gRPC connection (via metadata). See Tokens.

Errors

For typical authentication/permission failures and common disconnect reasons, see Error codes.