# realtimeUrl

WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.

Canonical: https://grid.syidax.com/docs/options/realtimeUrl/

<a id="meaning"></a>

## What does this API do?

WebSocket URL for remote collaboration. When omitted, collaboration is limited to a same-page/process demo scope.

API for Pro features: Real-time collaboration (existing Pro grade retained)

<a id="contract"></a>

## Exact input and result types

```typescript
realtimeUrl: string
```

| Item | Value |
| --- | --- |
| JavaScript name | realtimeUrl |
| HTML attribute | realtime-url |
| Default | undefined |
| Input type | string |

<a id="usage"></a>

## Usage flow

Set this on a property of the Grid element. In HTML, you can also use the realtime-url attribute. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

<a id="recipes"></a>

## Feature explanations and examples

- [Real-time collaboration](https://grid.syidax.com/docs/features/collaboration.md) — Collaboration shares edits, cursors, and presence among users in the same room. A room name alone does not automatically connect devices over the internet.