# On WebSocket Receive

## Overview

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

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

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

## Attributes

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

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