Subscribe WebSocket Event

The Subscribe WebSocket Event command (Command Type: 11) establishes a WebSocket subscription by overriding specific WebSocket events on an existing instance in the browser’s window object.

Command Type

Command Type ID: 11

Parameters

Parameter	Type	Description	Required
instance	string	Path to the WebSocket instance in the browser’s `window` object	Yes
name	string	A unique identifier for this WebSocket listener	Yes
timeout	number	Timeout in milliseconds	Yes
initialMessage	string	A message to send immediately after subscribing	No
methodsToOverride	Array of string	WebSocket methods to override. Possible values: `"onmessage"`, `"onerror"`, `"onclose"`, `"send"`	No

Usage Examples

{
  "command": "subscribe-websocket-event",
  "params": {
    "instance": "app.liveSocket",
    "name": "oddsListener",
    "timeout": 60000
  }
}

{
  "command": "subscribe-websocket-event",
  "params": {
    "instance": "window.feedSocket",
    "name": "feedListener",
    "timeout": 30000,
    "methodsToOverride": ["onmessage"],
    "initialMessage": "{\"type\":\"subscribe\",\"channel\":\"live\"}"
  }
}

Listen - Listen to DOM events
Observe Property - Monitor window property changes
WebSocket - Direct WebSocket connection (no browser context)

Run Custom Code Observe Property

Quick Start

Commands Glossary

Subscribe WebSocket Event

Command Type

Parameters

Usage Examples

​Command Type

​Parameters

​Usage Examples

​Subscribe to a Page’s WebSocket

​Subscribe and Override onMessage

​Related Commands

Command Type

Parameters

Usage Examples

Subscribe to a Page’s WebSocket

Subscribe and Override onMessage

Related Commands