> 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/2024.1/toolbox/communication/websocket/events/onwebsocketreceive.md).

# On WebSocket Receive

## Overview

![The On WebSocket Receive Node.](/files/tr4Og3KvJsSKP8XZwWDM)

The **On WebSocket Receive Node** is an **Event Listener Node** that is triggered if the *Websocket* connection received a message during any action for the selected configuration, which was established in the [**Project Settings**](/incari-studio/2024.1/modules/project-settings/websocket.md).

**WebSocket 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 **On WebSocket Receive** will not show up in the [**Toolbox**](/incari-studio/2024.1/toolbox/overview.md). Please refer to the [**Plugins Editor**](/incari-studio/2024.1/modules/plugins.md) to find out more information.

[**Scope**](/incari-studio/2024.1/toolbox/overview.md#scopes): **Project**, **Scene**.

## Attributes

![The On WebSocket Receive Node Attributes.](/files/56PtTLytTmU4SC7JHrtA)

| Attribute       | Type         | Description                                                                                                                                                                                               |
| --------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Is Binary`     | **Bool**     | A boolean which allows the user to choose whether the returned message is in **String** or binary format. If it is toggled on (*true*), it will be **Binary**. If off (*false*), it will be a **String**. |
| `Configuration` | **Dropdown** | The identifying connection name that will be used, which is one that was set up in the [**Project Settings**](/incari-studio/2024.1/modules/project-settings/websocket.md).                               |

## Outputs

| Output             | Type                   | Description                                                                                                                            |
| ------------------ | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| *Pulse Output* (►) | **Pulse**              | A standard **Output Pulse**, to move onto the next **Node** along the **Logic Branch**, once this **Node** has finished its execution. |
| `Message`          | **String** or **Bool** | The message data in **String** format, unless `Is Binary` was set to true (resulting in a message in **Binary** format).               |

## See Also

* [**On WebSocket Error**](/incari-studio/2024.1/toolbox/communication/websocket/events/onwebsocketerror.md)
* [**On WebSocket Start**](/incari-studio/2024.1/toolbox/communication/websocket/events/onwebsocketstart.md)
* [**On WebSocket Stop**](/incari-studio/2024.1/toolbox/communication/websocket/events/onwebsocketstop.md)