# openWebSocket

Canonical ID: `network.openSocket`.

```text
openWebSocket(url, options)
```

Opens a wss:// text WebSocket and returns an opaque handle. Declare webSockets and the corresponding https:// origin, then grant it. Uses GET without a body; authentication and headers follow httpRequest. No compression. One stream/socket per host.

Returns a Map with `ok`, `status`, `value` and `error`. Check `ok` before using `value`; denial or an unavailable host is a structured failure.

Requires Creator Pro or its technical trial for IDE/CLI run and build. Available on desktop, CLI and supported native exports; not in the public playground. Source remains editable in Learner. Generated apps have no Pliro licence check.

## Call example

See the [advanced application guide](../guides/advanced-applications.md) for declarations, explicit host permissions and complete examples. This call assumes the required permissions; `handle` means the `value` from a successful open operation.

```text
openWebSocket("wss://api.example.com/events", {})
```

[Built-ins](README.md)