WebSocket Client

Supported pipeline types:

  • Data Collector

  • Data Collector Edge
The WebSocket Client origin reads data from a WebSocket server endpoint. Use the origin to read data from a WebSocket resource URL. The origin can also send responses back to the origin system when used in a microservice pipeline. For information about supported versions, see Supported Systems and VersionsSupported Systems and Versions in the Data Collector documentation.

When the pipeline starts, the WebSocket Client origin opens a connection to the WebSocket server endpoint and optionally sends an initial message to the server. The WebSocket server then pushes data to the WebSocket Client origin. The origin creates and sends a batch as soon as the data arrives. The size of each batch varies, based on the size of the data sent by the server endpoint. When the pipeline stops, the origin closes the connection to the endpoint.

When you configure the WebSocket Client origin, you define the resource URL and headers to use for the requests. You configure whether the origin uses no authentication or basic authentication to connect to the WebSocket server endpoint.

When you want the origin to send responses back to the origin system as part of a microservice pipeline, you configure the data format and other characteristics of the responses.

You can also configure SSL/TLS properties, including default transport protocols and cipher suites.

Tip: Data Collector provides two WebSocket origins to address different needs. For a quick comparison chart to help you choose the right one, see Comparing WebSocket Origins.