> For the complete documentation index, see [llms.txt](https://docs.incari.com/incari-studio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.incari.com/incari-studio/toolbox/communication/socketio.md).

# Socket.IO

## Introduction

The **Socket.IO** **Nodes** provide a means for the user to perform several actions within the *Socket.IO* communications protocol. *Socket.IO* is related to *WebSocket* and allows for bidirectional communication between servers and web clients using **Socket.IO** events. More information can be found in the official [*Socket.IO* documentation.](https://socket.io/docs/v4/) To use the **Socket.IO Nodes** in **Incari**, the user needs to locate the [**Socket.IO Attributes**](/incari-studio/modules/project-settings/socketio.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 **Socket.IO Nodes** unavailable. Please refer to the [**Plugins Editor**](/incari-studio/modules/plugins/communication/socketiomanager.md) to find out more information.

## Socket.IO Guideline

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

* To properly start a connection, see the [**General Guideline**](/incari-studio/toolbox/communication.md#general-guideline) on the Communication Introduction page.
* Once the connection has been established, there are several **Nodes** that cover important functions of **Socket.IO Communication**.
  * [**Socket.IO Send**](/incari-studio/toolbox/communication/socketio/socketiosend.md) sends a **Socket.IO** event's `Message` through the established connection.
  * [**On Socket.IO Receive**](/incari-studio/toolbox/communication/socketio/events/onsocketioreceive.md) executes once a **Socket.IO** event's `Message` is received.
* To properly stop a connection, see the [**General Guideline**](/incari-studio/toolbox/communication.md#general-guideline) on the Communications Introduction page.

## Contents

* [**Events**](/incari-studio/toolbox/communication/socketio/events.md)
  * [**On Socket.IO Error**](/incari-studio/toolbox/communication/socketio/events/onsocketioerror.md)
  * [**On Socket.IO Receive**](/incari-studio/toolbox/communication/socketio/events/onsocketioreceive.md)
  * [**On Socket.IO Start**](/incari-studio/toolbox/communication/socketio/events/onsocketiostart.md)
  * [**On Socket.IO Stop**](https://github.com/cgi-studio-gmbh/incari-doc/blob/2025.1/toolbox/communication/socketio/events/onsocketiounsubscribe.md)
* [**Socket.IO Send**](/incari-studio/toolbox/communication/socketio/socketiosend.md)
* [**Socket.IO Start**](/incari-studio/toolbox/communication/socketio/socketiostart.md)
* [**Socket.IO Stop**](/incari-studio/toolbox/communication/socketio/socketiostop.md)
* [**Socket.IO Subscribe**](/incari-studio/toolbox/communication/socketio/socketiosubscribe.md)
* [**Socket.IO Unsubscribe**](/incari-studio/toolbox/communication/socketio/socketiounsubscribe.md)