WebSocket real-time event stream
GET
/api/v1/ws
Upgrade to a WebSocket connection to receive real-time inbox events. The server sends JSON text frames. Clients do not need to send frames (ping/pong is handled at the protocol level).
Event types:
| type | data | |---|---| | message:new | MessageSummary object | | message:delete | { "id": "<ulid>" } | | message:read | { "id": "<ulid>", "is_read": true \| false } | | message:starred | { "id": "<ulid>", "is_starred": true \| false } | | message:tags | { "id": "<ulid>", "tags": ["tag1", "tag2"] } | | messages:clear | (no data field) |
Responses
Switching Protocols — WebSocket handshake successful