SessionKit DOCS
Get Started
API Reference Subscribe
WSsubscribe↑ Client → Server

Subscribe

Send this message to subscribe to real-time events for one or more sessions.

Array of session IDs to subscribe to. Filter which event types to receive. Omit to receive all events.

Payload

{
  "action": "subscribe",
  "data": {
    "sessions": ["ses_k8m2n4p6", "ses_j7l1m3o5"],
    "events": ["session.connected", "page.navigated", "session.error"]
  }
}

Response

{
  "event": "subscribed",
  "data": {
    "sessions": ["ses_k8m2n4p6", "ses_j7l1m3o5"],
    "events": ["session.connected", "page.navigated", "session.error"]
  }
}
⌘I
AI Assistant

Ask me anything about the documentation.

ESC