Websockets

Overview

Creates a new WebSocket request object that can be configured and used to establish a connection with a WebSocket server. This node is typically used as the starting point for initiating WebSocket-based communication in your application.

The output is a WebSocketProxy object that allows further configuration before connecting to the server.

Inputs

• URL – The WebSocket server URL to which the connection will be made. This node will only work with URLs such as: wss://example.com/socket

• WebSocket Settings – Optional settings structure to define headers and protocols.

Outputs

• Success – Returns true if the WebSocket request was created successfully.

• Out Websocket Request – The request object to be used for further setup or initiating the connection.

Overview

Initiates a connection to a WebSocket server using the provided WebSocket request object "WebSocket Proxy". This node attempts to open the connection defined in the request. If successful, the socket can be used to send and receive real-time data.

This should be called after the request has been fully configured (URL, headers, etc.).

Inputs

• Target – The WebSocket request object used to establish the connection. Must be of type WebSocket Proxy.

Outputs

• Success – Returns true if the connection to the WebSocket server was successfully established. Otherwise false.

Overview

Closes an active WebSocket connection. You can specify a closure code and an optional reason to explain the disconnection. This node should be used when the connection is no longer needed or to gracefully shut down the session.

Common use cases include clean-up on exit, handling network errors, or controlled shutdowns from the client side.

Note: A useful website that provides most of the common WebSocket closure codes along with a description of each: https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/code

Inputs

• Target – The WebSocket Proxy object representing the active connection you want to close.

• Code – Optional WebSocket close code.

• Reason – Optional string reason for the closure, which can be used for logging or diagnostics.

Outputs

• Success – Returns true if the connection was successfully closed. Otherwise false.

Overview

Sends binary data through an established WebSocket connection. This is used for transferring non-text payloads such as files or encoded assets to the server.

This node is part of the WebSocket communication system and should only be used after a successful connection is made.

Inputs

• Target – The WebSocket Proxy object representing the active connection you want to use for binary data sending.

• Binary Data – The binary payload to send.

Outputs

• Success – Returns true if the data was successfully sent to the server, otherwise false.

Overview

Sends a text-based message to the connected WebSocket server. This is used for sending JSON strings or other UTF-8 encoded data over a WebSocket connection.

This node should only be called after a successful connection has been established.

Inputs

• Target – The WebSocket Proxy object representing the active connection you want to use for string data sending.

• Data – The Json object that contains the data you wish to transmit to the server.

Outputs

• Success – Returns true if the message was successfully sent to the server, otherwise false.

Overview

Replaces the current WebSocket headers with a new set of headers. This is typically used to configure authentication tokens, custom identifiers, or other metadata before initiating a WebSocket connection.

This must be called before attempting to connect to the server.

Inputs

• Target – The WebSocket Proxy instance to apply the new headers to.

• Headers – A map of key–value pairs (as strings) representing the new headers to use in the WebSocket.

Outputs

None.

Overview

Appends new header entries to the existing WebSocket header list without replacing previously defined headers. This is useful when you want to add custom metadata or authentication fields incrementally before initiating a connection.

This node is additive. it does not overwrite the current header set.

Inputs

• Target – The WebSocket Proxy instance to append the new header to.

• Headers – A map of key–value pairs (as strings) representing the headers you want to add.

Outputs

• Success – Returns true if the headers were successfully added. Otherwise false.

Overview

Removes one header from the current WebSocket configuration using the specified key. This is useful for dynamically cleaning up or adjusting headers before attempting a connection. If the key exists in the current header map, all associated entries will be deleted.

Inputs

• Target – The WebSocket Proxy instance to remove a header from.

• Header Key – A string key identifying the header to remove. This key must match a key in the already existing headers. Otherwise the node does nothing.

Outputs

None.

Overview

Replaces the current array of protocols in the WebSocket Proxy instance with the new array of provided protocols. This configuration must be set before initiating the connection.

Inputs

• Target – The WebSocket Proxy instance to override the protocols for.

• Protocols – An array of string values representing the new protocols to include in the WebSocket handshake.

Outputs

None.

Overview

Adds a new protocol to the list of existing WebSocket protocols. WebSocket protocols help define the subprotocol to use during the connection handshake. This node can be used to append one protocol name dynamically before initiating the connection.

Note: Protocols should be added before calling the Connect to WebSocket node. Changing protocols after connection has no effect.

Inputs

• Target – The WebSocket Proxy instance to add a new protocol too.

• Protocols – An array of protocol strings to add. Each entry defines a new protocol to support in the WebSocket handshake.

Outputs

• Success – Returns true if the protocol(s) were successfully added to the proxy. Otherwise false.

Overview

Removes all instances of a specific protocol from the WebSocket protocol list. This is useful for dynamically cleaning or updating the list of supported subprotocols before initiating the WebSocket connection.

Note: Protocols can only be modified before the connection is established. Once the connection is active, protocol changes have no effect.

Inputs

• Target – The WebSocket Proxy instance to remove all instances of a protocol.

• Protocol to Remove – The name of the protocol (as a string) that should be removed from the array.

Outputs

None.

Overview

Replaces the current WebSocket connection URL with a new one. This node is typically used when you want to reconfigure or repoint a WebSocket request to a different server before attempting a connection.

Note: Changing the URL must be done before establishing the WebSocket connection. Once connected, URL changes will not apply.

Inputs

• Target – The WebSocket Proxy instance of witch the URL is being modified.

• New URL – The new WebSocket URL (as a string) to assign. Must follow valid WebSocket formats like ws:// or wss://.

Outputs

None.

Overview

Checks whether the WebSocket is currently connected to a remote server. This is a simple status-check node that returns a Boolean result, allowing you to verify the active state of the WebSocket connection before attempting further operations like sending or receiving data.

Inputs

• Target – The WebSocket Proxy instance you wish to check if its currently connected to a server.

Outputs

• Is Connected – Returns true if the WebSocket is actively connected to a server, false otherwise.

Overview

Binds a custom event to the OnConnected delegate of a WebSocket Proxy instance. This event is triggered when the WebSocket connection is successfully established with the server.

This node should be used before calling the Connect To WebSocket function, or the event may not fire.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

None.

Overview

Binds a custom event to the OnClosed delegate of a WebSocket Proxy instance. This event is triggered when the WebSocket connection is closed, either by the client or the server.

The bound event provides details about the closure, including status code, reason, and whether the connection was cleanly closed. This event should be bound before initiating the connection to ensure the event is captured.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Status Code – The WebSocket close code that describes why the connection was terminated.

• Reason – A human-readable reason string, why the connection was closed. Provided by the remote server.

• Was Clean – A Boolean indicating whether the connection was closed cleanly (true) or abruptly (false).

Overview

Binds a custom event to the Binary Data Sent delegate of a WebSocket Proxy instance. This event is triggered whenever binary data is successfully sent through the WebSocket connection.

The bound event provides access to the exact binary payload, the size of the data sent, and the remaining bytes queued for transmission (if any). Use this to track upload status or perform post-send actions.

This delegate should be bound before sending binary data to ensure the event is captured properly.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Binary Data – The actual binary payload that was sent.

• Binary Size – The size (in bytes) of the sent binary data.

• Bytes Remaining – The number of bytes still pending transmission (useful for chunked or large data sends).

Overview

Binds a custom event to the On Text Sent delegate of a WebSocket Proxy instance. This event is triggered whenever a string-based message is successfully sent over the WebSocket connection.

Use this to confirm message delivery or track/log text data that was sent. The event provides the full text payload sent to the server.

Ensure this binding is established before sending text data to capture the event properly.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Data Sent – The full string as a Json object that was transmitted to the WebSocket server.

Overview

Binds a custom event to the Binary Data Received delegate of a WebSocket Proxy instance. This event is triggered whenever binary data is received from the WebSocket server.

Use this to handle incoming binary payloads, such as files, byte-encoded objects, or custom binary protocols. If the message is received in parts (fragments), the final fragment will be marked accordingly.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Binary Data – The raw byte array received from the server.

• Binary Size – The total size (in bytes) of the received data.

• Is Last Fragment – Boolean indicating whether this chunk is the final part of a fragmented message.

Overview

Binds a custom event to the On Message Received delegate of a WebSocket Proxy instance. This event is triggered when a complete UTF-8 text message is received from the WebSocket server, and is automatically parsed into a valid JSON object for further JSON manipulation.

This is useful for applications that communicate using JSON, plain text, or other string-based protocols over WebSocket.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Message Received – A JSON object containing the full content of the received text message.

Overview

Binds a custom event to the On Connection Error delegate of a WebSocket Proxy instance. This event is triggered if the WebSocket fails to connect to the server due to issues like an invalid URL, network failure, timeout, or server-side rejection. Use this node to catch and handle connection problems.

Ensure this binding is established before Receiving connection error warnings to capture the event properly.

Inputs

• Target – The WebSocket Proxy instance you wish to bind the event from.

Outputs

• Error – Automatically parsed string into a JSON object describing the cause of the connection failure.