Websockets

Websocket's

Create New WebSocket Request

Create New WebSocket Request

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. Otherwise false.

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

Connect To WebSocket

Connect To WebSocket

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, delegate binds 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.

Close WebSocket Connection

Close WebSocket Connection

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.

Send Binary Data

Send Binary Data

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.

Note: We recommend using a node Is Websocket Connected to first check if a valid connection is established between the client and the server.

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.

Send String Data

Send String Data

Overview

Sends a text-based message to the connected WebSocket server. This is used for sending JSON data to the WebSocket connection.

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

Note: Recommended node to check connection is Is Websocket Connected to first check if a valid connection is established between the client and the server.

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 send to the server.

Outputs

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

Set New Websocket Headers

Set New WebSocket Headers

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.

Note: Recommended node to check connection is Is Websocket Connected to first check if a valid connection is established between the client and 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.

Add New WebSocket Header

Add New WebSocket Header

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.

Note: Recommended node to check connection is Is Websocket Connected to first check if a valid connection is established between the client and the server.

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.

Remove WebSocket Header

Remove WebSocket Header

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.

Note: Recommended node to check connection is Is Websocket Connected to first check if a valid connection is established between the client and the server.

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 exactly a key in the already existing headers. Otherwise the node does nothing.

Outputs

None.

Set New WebSocket Protocols

Set New WebSocket Protocols

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.

Note: Recommended node to check connection is Is Websocket Connected to first check if a valid connection is established between the client and the server.

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.

Add New WebSocket Protocol

Add New WebSocket Protocol

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 protocols were successfully added to the proxy. Otherwise false.

Remove WebSocket Protocol

Remove WebSocket Protocol

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 should be added before calling the Connect to WebSocket node. Changing protocols after connection has 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.

Set New WebSocket URL

Set New WebSocket URL

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: Protocols should be added before calling the Connect to WebSocket node. Changing URL after connection has no effect.

Inputs

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

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

Outputs

None.

Set New Text Memory Limit

Set New Text Memory Limit

Overview

Adjusts the maximum UTF-8 text memory limit that can be received from the connected server on this socket. This is useful when handling larger payloads or expanding the allowed message size during WebSocket communication.

Note: If not modified, the limit defaults to 1 MB. Changing this value after the connection is established has no effect.

Inputs

  • Target – The WebSocket Proxy instance of witch the Text Memory Limit is being modified.

  • Size – The new buffer size of the memory limit you wish to recieve from a given server on the current socket.

Outputs

Success – Returns true if the text memory limit has been changed. Otherwise false.

WebSocket's Pure

Is WebSocket Connected

Is WebSocket Connected

Overview

Checks whether the WebSocket is currently connected to a 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.

WebSocket's Delegates

Delegate On Connected

WebSocket On Connected

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 delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

Inputs

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

Outputs

None.

Delegate On Closed

WebSocket On Closed

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 delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

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. Parsed into a JSON object.

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

Delegate Binary Data Sent

WebSocket Binary Data Sent

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 calling the Connect To WebSocket function, or the event may not fire correctly.

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).

Delegate On Text Sent (As Json)

On Text Sent (As Json)

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.

This delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

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 sent to the WebSocket server.

Delegate Binary Data Received

WebSocket Binary Data Received

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.

This delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

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.

Delegate On Message Received

WebSocket On Message Received

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.

This delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

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.

Delegate On Connection Error

WebSocket On Connection Error

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.

This delegate should be bound before calling the Connect To WebSocket function, or the event may not fire correctly.

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.

Last updated

Was this helpful?