add docs for websocket.client module

This commit is contained in:
Joel Wetzell
2026-05-13 19:17:19 -05:00
parent 6936b7f46d
commit dd5cb5bfa2
3 changed files with 34 additions and 0 deletions
@@ -0,0 +1,21 @@
---
title: WebSocket Client
sidebar:
label: Client
order: 1
---
The `websocket.client` module opens a websocket connection to the specified URL. This module supports both text and binary websocket messages.
- **type**: `websocket.client`
- **params**:
- **url**: the full url to connect to (`wss://echo.websocket.org`)
### Example
Connect to the example WS server at `echo.websocket.org`.
```yaml
- id: websocket
type: websocket.client
params:
url: "wss://echo.websocket.org"
```