WebSocket Stream
Create or update a recurring WebSocket stream connector
Custom Streaming + One-shot
Create or update a recurring WebSocket stream connector. Connects to a WebSocket endpoint and continuously streams messages to Kafka.
Technical details
Authentication ▾
Contact us for setup details.
Ingestion ▾
Mode: Streaming + One-shot
Tools exposed (2) ▾
upsert_bento_stream_websocket
Create or update a recurring WebSocket stream connector. Connects to a WebSocket endpoint and continuously streams messages to Kafka.
ws/sample_websocket
Connect to a WebSocket endpoint and collect sample messages. Use this to explore what data a stream provides before creating a recurring connector.
Inputs ▾
upsert_bento_stream_websocket
| Name | Type | Required | Description |
|---|---|---|---|
| dashboardId | string | no | Target dashboard/initiative ID. Omit to use the current dashboard. |
| url | string | yes | WebSocket URL (ws:// or wss://). |
| openMessages | string[] | no | Messages to send on connection (subscription/auth payloads). Each string sent as a text frame. |
| openMessageType | string | no | Type of open messages. Default: 'text'. text binary |
| headers | object | no | Headers for the WebSocket handshake. |
Nested schema for headersNo inputs. | |||
| recordPath | string | no | Dot path to extract from each message JSON. |
| connectorId | string | no | If provided, updates the existing connector instead of creating a new one. |
| description | string | no | Human-readable description of what this connector monitors. |
| idExpression | string | no | Optional Bloblang expression for the Firestore document ID. Provide this when the source has a stable unique field. |
| tlsEnabled | boolean | no | Enable TLS for the WebSocket connection. Default: false. |
| tlsSkipVerify | boolean | no | Skip TLS certificate verification. Default: false. |
ws/sample_websocket
| Name | Type | Required | Description |
|---|---|---|---|
| dashboardId | string | no | Target dashboard/initiative ID. Omit to use the current dashboard. |
| url | string | yes | WebSocket URL (ws:// or wss://). |
| openMessages | string[] | no | Messages to send on connection (subscription/auth payloads). Each string sent as a text frame. |
| headers | object | no | Headers for the WebSocket handshake. |
Nested schema for headersNo inputs. | |||
| maxMessages | number | no | Max messages to collect. Default: 10. |
| maxDurationMs | number | no | Max listen time in milliseconds. Default: 10000. |
| recordPath | string | no | Dot path to extract from each message JSON, e.g. 'data' or 'payload.records'. |
| filter_paths | string[] | no | Optional glob paths to reduce the response returned to the model. |