Skip to content
masterclass Buddy
Start learning

Playwright · Class

WebSocketRoute

WebSocketRoute handles a WebSocket created by a page route. It can mock the socket or connect to the real server and intercept messages.

Last updated

Since
v1.48

Syntax

page.routeWebSocket(url, handler)
webSocketRoute.connectToServer()
webSocketRoute.onMessage(handler)
webSocketRoute.onClose(handler)
webSocketRoute.send(message)
webSocketRoute.close(options?)
webSocketRoute.protocols()
webSocketRoute.url()

In-depth API docs are only for subscribers: parameters, examples, common mistakes and interview practice.

Subscribe
  • page.routeWebSocket()
  • browserContext.routeWebSocket()
  • WebSocketRoute.close
  • WebSocketRoute.connectToServer
  • WebSocketRoute.onClose
  • WebSocketRoute.onMessage
  • WebSocketRoute.protocols
  • WebSocketRoute.send

Source: WebSocketRoute | Playwright. Checked 2026-11-03.