Skip to main content

WebSocket

Version: 1.26.0

Connect to a WebSocket (ws/wss) Server.

Agent configuration​

The following describes the supported agent configuration attributes:

Attribute

Description

Value type

Required

connectURL

WebSocket connection URL (ws/wss); this is used as the base URL for all requests that go through this agent

HTTP URL

Y

connectHeaders

Headers to be added to the initial connection request

Multivalued Text Map

N

connectSubscriptions

List of subscriptions that should be made when the protocol connects to the WebSocket server

WebSocket Subscription[]

N

WebSocket Subscriptions​

The subscription attribute allows a set of subscriptions to be made when the connection is first established, these subscriptions are executed in the order they appear in the list/array. A subscription can be a WebSocket subscription or a HTTP subscription (a simple HTTP request), this covers most real world WebSocket server use cases, as this is a publish-subscribe protocol you quite often need to specify what you want to subscribe to when you connect.

For attributes linked to this agent, the following describes the supported agent link fields which are in addition to the standard Agent Link fields:

Field

Description

Value type

Required

type

Agent type

Text (Must be WebsocketAgentLink)

Y

websocketSubscriptions

List of subscriptions that should be made when this attribute is linked to the agent

WebSocket Subscription[]

N

License notice: OpenRemote documentation attribution