# WebSocket Interfaces

<!-- BOOKSTACK-DOCUMENT-RELEASE:BEGIN -->
# WebSocket Interfaces

| Field | Value |
| --- | --- |
| Distribution | BSS — OpenSOF |
| Product | OpenSOF |
| Release | 0.15.1 |
| Deployment | `opensof.bss.dev` |
| Source | `/srv/bss/releases/OpenSOF-v0.15.0-20app` |
| Evidence | Static WebSocket extraction |
| Source fingerprint | `cda583b42f2a0d296b268ab5b174932a378c8be6fb52ffa1af14af896e990f6e` |
| Status | Generated baseline — human review required |

> **Verification boundary:** This page combines platform design guidance with static evidence from the release. It does not prove that every detected interface is enabled, reachable, secure, or operational in the deployed environment.

## Candidate endpoints

| Endpoint | Evidence | Source |
| --- | --- | --- |
| `[invalid URL]` | url | `tests/raspbot_agent_smoke_test.py` |
| `wss://.../` | url | `OPENLVC-DEMO.md` |
| `wss://relay.example/` | url | `tests/openeyes_smoke_test.py` |
| `wss://relay.example/ws/raspbot` | url | `open-eyes/index.html` |
| `wss://relay.example/ws/raspbot` | url | `public/open-eyes/index.html` |
| `wss://relay.example/ws/raspbot` | url | `tests/openeyes_smoke_test.py` |
| `wss://your-relay/ws/raspbot` | url | `README-OPENEYES.md` |
| `wss://your-relay/ws/raspbot` | url | `drivers/raspbot-openeyes.env.example` |

## Required session contract

- URL/base path and whether TLS (`wss`) is mandatory.
- Authentication handshake, role/asset authorization and reconnect token behavior.
- Message envelope, schema/version, ordering, sequence numbers and timestamps.
- Heartbeat, idle timeout, reconnect/backoff and resume behavior.
- Maximum message/rate, binary/media framing and backpressure/drop policy.
- Nginx upgrade headers, proxy timeout and public-to-backend mapping.

## Browser verification

```text
Open developer tools → Network → WS
Confirm HTTP 101 upgrade, authenticated session, expected message flow,
heartbeat/reconnect behavior, and no credential leakage in URL/query strings.
```
<!-- BOOKSTACK-DOCUMENT-RELEASE:END -->

---

## Maintainer Notes

<!-- BOOKSTACK-DOCUMENT-RELEASE:NOTES-BEGIN -->
Add human-reviewed deployment notes, corrections, decisions, screenshots, and links here. Content outside the generated block is preserved on future runs.
<!-- BOOKSTACK-DOCUMENT-RELEASE:NOTES-END -->