1. Connect to a WebSocket Server
Use the workflow action “Connect WebSocket” and configure:
• Server URL → wss://your-server.com/socket
• Subprotocols (optional) → CSV list, e.g. json,auth
• Auto-connect → yes/no
• Reconnect delay (ms) → e.g. 3000
• Heartbeat (optional) → message + interval in ms
• Send on open (optional) → string or JSON payload

The plugin then establishes a WebSocket connection and exposes connection state to Bubble.

⸻

2. Send Messages

Use the actions:
• Send String → sends text as-is
• Send JSON → safely validates + stringifies JSON

If the connection is not ready, messages are queued and sent automatically after reconnection.

⸻

3. Handle Incoming Messages

The plugin triggers the Bubble event “Message” whenever data arrives.

The following states update automatically:
• last_message → raw text message
• last_json → pretty-formatted JSON (if parseable)
• message_count → running count of messages
• last_event → “message”, “open”, “error”, “close”
• last_error → last error string
• ready_state → WebSocket readyState 0–3

Use these states in workflows, repeating groups, or logic flows.

⸻

4. Monitor Connection State

These states update in real time:
• connected → true/false
• ready_state → 0=connecting, 1=open, 2=closing, 3=closed
• last_event → lifecycle event string
• last_error → error or close reason

You can condition workflows based on connection stability or failures.

⸻

5. Automatically Reconnect (Optional)

If auto_connect is enabled and reconnect_ms > 0:

The plugin will:
1. Detect the socket closing
2. Wait the specified number of milliseconds
3. Reconnect automatically
4. Re-send queued messages

This creates a self-healing connection suitable for production applications.

⸻

6. Close the Connection

Use “Close WebSocket” to immediately terminate the connection.