Transport
BranchKey needs a way to tell your client "an aggregation is ready to download". It supports two mechanisms for that notification, and you choose one when you create the client:
- WebSocket (recommended) — runs over the same host and port as the REST API
(
https/ port 443), so it needs no extra firewall rules. This is the default in the client template. - RabbitMQ (legacy) — AMQPS on port 5671. Fully supported, but requires an additional outbound port. Prefer WebSocket for new integrations.
Either way you read notifications the same way — from client.queue — so your training loop does
not change when you switch transports.
| WebSocket | RabbitMQ | |
|---|---|---|
| Config | use_websocket=True | use_websocket=False (default) |
| Port | 443 (HTTPS/WSS) | 5671 (AMQPS) |
| Extra firewall rules | none | outbound 5671 |
| Status | Recommended | Legacy |