# WebSocket

### Introduction

The **WebSocket** **Nodes** provide a means for the user to perform several actions within the *WebSocket* messaging protocol. *WebSocket* is a communication protocol that provides full-duplex, bidirectional communication channels over a single *TCP* connection. More information can be found [here](https://en.wikipedia.org/wiki/WebSocket). To use the **WebSocket Nodes** in **Incari**, the user needs to locate the [**WebSocket Attributes**](/incari-studio/2023.2/modules/project-settings/websocket.md) in **Project Settings** and add a `Connection`.

This form of **Communication** in **Incari** is available as a plugin and is enabled as default. However, in the case that it is disabled in the **Plugins Editor**, it will not appear in the **Project Settings** and render the **WebSocket Nodes** unavailable. Please refer to the [**Plugins Editor**](/incari-studio/2023.2/modules/plugins.md) to find out more information.

### WebSocket Guideline

These are the guidelines for incorporating **WebSocket Communication** into a **Project**.

* To properly start a connection, see the [**General Guideline**](/incari-studio/2023.2/toolbox/communication.md#general-guideline) on the Communications Introduction page.
* Once the connection has been established, there are several **Nodes** that cover important functions of **WebSocket Communication**.
  * [**On WebSocket Error**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketerror.md) executes when an error is received.
  * [**On WebSocket Receive**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketreceive.md) executes when a **WebSocket** message is received.
  * [**WebSocket Client Send Packet**](/incari-studio/2023.2/toolbox/communication/websocket/websocketsend.md) sends a **WebSocket** message.
* To properly stop a connection, see the [**General Guideline**](/incari-studio/2023.2/toolbox/communication.md#general-guideline) on the Communications Introduction page.

### Contents

* [**Events**](/incari-studio/2023.2/toolbox/communication/websocket/events.md)
  * [**On WebSocket Error**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketerror.md)
  * [**On WebSocket Receive**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketreceive.md)
  * [**On WebSocket Start**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketstart.md)
  * [**On WebSocket Stop**](/incari-studio/2023.2/toolbox/communication/websocket/events/onwebsocketstop.md)
* [**WebSocket Client Send**](/incari-studio/2023.2/toolbox/communication/websocket/websocketsend.md)
* [**WebSocket Client Start**](/incari-studio/2023.2/toolbox/communication/websocket/websocketstart.md)
* [**WebSocket Client Stop**](/incari-studio/2023.2/toolbox/communication/websocket/websocketstop.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.incari.com/incari-studio/2023.2/toolbox/communication/websocket.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.