# addEventListener

#### addEventListener

Listens for events sent from the scene. Used to receive events from Interactions that have "Send event" as their action.

#### **Signature**

```typescript
addEventListener(eventName: string, callback: (value: any) => void): Promise<void>
```

#### **Parameters**

<table><thead><tr><th width="187.57421875">Parameter</th><th width="121.1328125">Type</th><th width="109.17578125">Required</th><th>Description</th></tr></thead><tbody><tr><td>eventName</td><td>string</td><td>Yes</td><td>Name of the event to listen for</td></tr><tr><td>callback</td><td>function</td><td>Yes</td><td>Function called when event is received</td></tr></tbody></table>

#### **Returns**

`Promise<void>`

#### **Usage**

```javascript
await api.addEventListener("product_clicked", (value) => {
  console.log("Product clicked, value:", value);
});
```

#### **How it works**<br>

1. In Studio, create an Interaction with action **Send event** and specify event name
2. The trigger can be any available Studio trigger (On click, Mouse enter, On load, etc.)
3. When triggered, your callback receives the value of a Variable with the same name as the event

If no Variable with the event name exists, the callback receives `undefined`.

#### **Notes**

* Event name must match the name specified in Studio's "Send event" action
* Multiple listeners can be added for the same event
* Use `removeEventListener()` to stop listening


---

# 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://help.vectary.com/api/model-api/api-reference/addeventlistener.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.
