This processor acts as a WebSocket client endpoint to interact with a remote WebSocket server. It is capable of receiving messages from a websocket server and it transfers them to downstream relationships according to the received message types.

The processor may have an incoming relationship, in which case flowfile attributes are passed down to its WebSocket Client Service. This can be used to fine-tune the connection configuration (url and headers for example). For example "dynamic.url = currentValue" flowfile attribute can be referenced in the WebSocket Client Service with the ${dynamic.url} expression.

You can define custom websocket headers in the incoming flowfile as additional attributes. The attribute key shall start with "header." and continue with they header key. For example: "header.Authorization". The attribute value will be the corresponding header value. If a new flowfile is passed to the processor, the previous sessions will be closed, and any data being sent will be aborted.

  1. header.Autorization | Basic base64UserNamePassWord
  2. header.Content-Type | application, audio, example

For multiple header values provide a comma separated list.