Datasource: WebSocket Client
Use WebSocket Client when you need bidirectional or continuous message ingestion from systems that expose WebSocket endpoints.
This datasource maintains a WebSocket connection and forwards each message as a workflow event.
Best Use Cases
- Real-time event buses with WebSocket transport
- Streaming app telemetry
- Event-driven integrations where polling is too slow
Configuration Fields
| Field | Required | Type | Default | Purpose |
|---|---|---|---|---|
url | Yes | string | - | WebSocket endpoint (ws:// or wss://) |
authType | No | select | none | Authentication mode |
headerName | Conditional | string | - | Header key when authType=header |
headerValue | Conditional | password | - | Header value when authType=header |
reconnectDelay | No | number | 5 | Reconnect delay in seconds |
How to Configure Correctly
- Select WebSocket Client datasource type.
- Enter
urlwith proper scheme (wss://in production). - Configure auth header fields when required.
- Set reconnect delay based on endpoint stability.
- Save, activate, and inspect first message events.
Example Config
{
"url": "wss://stream.example.com/events",
"authType": "header",
"headerName": "Authorization",
"headerValue": "Bearer <token>",
"reconnectDelay": 5
}
Reliability Guidance
- Prefer
wss://with valid certificates - Keep reconnect delay non-zero to prevent rapid reconnect loops
- Add message validation node immediately after trigger
Common Problems
- Connection refusal: wrong URL/protocol or blocked network path
- Auth failures: wrong header name/value format
- Message parse errors: inconsistent payload format from upstream
Related Pages
- Continue with Datasource - HTTP Event Stream for long-lived HTTP alternatives.
- Continue with Workflows for message normalization and routing.
