# On WebSocket Receive

## Overview

![The On WebSocket Receive Node.](https://1553081948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU990HLHWA30dTfELtDUK%2Fuploads%2Fgit-blob-95ef9c5f5bfbdd127581c07c865c95a394b66a4c%2Fonwebsocketreceivenode20241.png?alt=media)

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**](https://docs.incari.com/incari-studio/modules/project-settings/websocket).

**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**](https://docs.incari.com/incari-studio/toolbox/overview). Please refer to the [**Plugins Editor**](https://docs.incari.com/incari-studio/modules/plugins) to find out more information.

[**Scope**](https://docs.incari.com/incari-studio/overview#scopes): **Project**, **Scene**.

## Attributes

![The On WebSocket Receive Node Attributes.](https://1553081948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU990HLHWA30dTfELtDUK%2Fuploads%2Fgit-blob-6dea2134e5101eb3dbff0adc8a9fd29d5ab93850%2Fonwebsocketreceiveatts.png?alt=media)

| 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**](https://docs.incari.com/incari-studio/modules/project-settings/websocket).                  |

## 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**](https://docs.incari.com/incari-studio/toolbox/communication/websocket/events/onwebsocketerror)
* [**On WebSocket Start**](https://docs.incari.com/incari-studio/toolbox/communication/websocket/events/onwebsocketstart)
* [**On WebSocket Stop**](https://docs.incari.com/incari-studio/toolbox/communication/websocket/events/onwebsocketstop)
