| 1 | # WebSockets |
| 2 | |
| 3 | Agent Zero WebSocket architecture is documented in |
| 4 | [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero). |
| 5 | |
| 6 | This local page is only a handoff. Keeping the full protocol guide here would |
| 7 | duplicate source-linked documentation and become stale. |
| 8 | |
| 9 | ## When You Are Working On WebSockets |
| 10 | |
| 11 | Start with the source and DeepWiki: |
| 12 | |
| 13 | - `helpers/ws.py` |
| 14 | - `helpers/ws_manager.py` |
| 15 | - `api/ws_*.py` |
| 16 | - `webui/js/websocket.js` |
| 17 | - WebSocket pages in [DeepWiki](https://deepwiki.com/agent0ai/agent-zero) |
| 18 | |
| 19 | ## Keep These Rules In Mind |
| 20 | |
| 21 | - Preserve authentication and CSRF checks. |
| 22 | - Keep payloads JSON-serializable. |
| 23 | - Prefer small, named events over large catch-all events. |
| 24 | - Test reconnects, timeouts, and duplicate deliveries. |
| 25 | - Keep user-facing behavior documented in the relevant guide, not in this |
| 26 | protocol handoff page. |
| 27 | |
| 28 | ## Related |
| 29 | |
| 30 | - [Architecture](architecture.md) |
| 31 | - [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero) |