# Socket Event

{% hint style="info" %}
Disponível somente no canal **Widget**
{% endhint %}

Útil para customizações, como por exemplo exibir um menu de opções que dependa de dados de um usuário logado.

```javascript
[
    {
        "name": "socket_event",
        "parameters": {
            "event": "myEvent",
            "payload": {
                "param1": "value",
                "param2": "<? $context_var ?>"
            }
        },
        "result_variable": "event_response"
    }
]
```

## Atributos

* **name:** socket\_event
* **parameters:**
  * **event:** nome do evento que será disparado.
  * **payload:** dados que serão enviados para o evento. Quaisquer dados podem ser enviados para serem tratados posteriormente no frontend.
* **result\_variable:** variável de contexto que receberá o resultado da emissão do evento. Em caso de sucesso, essa variável conterá o seguinte JSON:

  ```javascript
  {
    "code": 200,
    "event": "show_context",
    "status": "ok"
  }
  ```

## Exemplo

Disparo do evento no builder (action):

```javascript
[
    {
        "name": "socket_event",
        "parameters": {
            "event": "sendData",
            "payload": {
                "name": "Marcos Duarte"
            }
        },
        "result_variable": "event_response"
    }
]
```

Listener do evento declarado no `<body>` do widget:

```markup
<script type="text/javascript">
    socket.on('sendData', function(payload) {
        console.log(payload);
    });
</script>
```

Ao emitir o evento, no console do browser será exibido os dados recebidos:

```javascript
{"name": "Marcos Duarte"}
```


---

# 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.altu.d1.cx/build/assistentes/builder/componentes/actions/socket_event.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.
