> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# swmlUserEvent

> Send a custom user event through SWML for real-time UI updates.

[functionresult]: /docs/server-sdks/reference/typescript/agents/function-result

Send a custom user event through SWML. Events are delivered to connected
clients in real time, commonly used to drive UI updates in interactive
applications (e.g., updating a scoreboard, dealing cards, showing status).

## **Parameters**

**`eventData`** `Record<string, unknown>` — required

Object containing the event payload. Include a `"type"` key to help
clients distinguish between different event types.

---

## **Returns**

[`FunctionResult`][functionresult] -- `this`, for chaining.

## **Example**

```typescript {4}
import { FunctionResult } from '@signalwire/sdk';

const result = new FunctionResult()
  .swmlUserEvent({ type: 'order_placed', orderId: '12345' });
```

> Send a custom user event through SWML for real-time UI updates.