WebDriver BiDi modules

List of modules

bluetooth module

The bluetooth module contains commands for automating Bluetooth device interactions.

browser module

The browser module contains commands for managing the browser, including client windows, user contexts, and download behavior.

browsingContext module

The browsingContext module contains commands and events for managing browsing contexts.

emulation module

The emulation module contains commands for overriding the behavior of certain Web APIs, such as the Geolocation API and the Screen Orientation API, to simulate different environments.

input module

The input module contains commands for simulating user input actions.

log module

The log module provides an event for monitoring browser log entries, including console API output and unhandled JavaScript errors.

network module

The network module contains commands and events related to network requests.

permissions module

The permissions module contains commands for managing browser permissions.

script module

The script module contains commands and events for executing JavaScript and managing script realms in the browser.

session module

The session module contains commands for managing the lifecycle and event subscriptions of a WebDriver BiDi session.

storage module

The storage module contains commands and events related to storage.

userAgentClientHints module

The userAgentClientHints module contains commands for overriding user agent client hints.

webExtension module

The webExtension module contains commands for managing browser extensions.

Commands

A command is an asynchronous operation sent from the client to the browser. Each command message you send to the browser has three fields:

• id: A number you assign to the command. Unlike HTTP where each request waits for a response, a WebSocket connection can have multiple commands in flight at the same time and responses may arrive out of order. The id lets you match each response to the command that triggered it.
• method: The command to run, in the form module_name.command_name.
• params: An object with any additional information the command needs. Some commands require no parameters, but an empty params object ({}) must still be sent.

For example, to create a new session, you would send the session.new command as follows:

{
  "id": 1,
  "method": "session.new",
  "params": {}
}

Each command results in either a success response containing a result field or an error response containing an error field. The structure of result is specific to each command.

All commands except session.new and session.status require an active WebDriver BiDi session.

Events

An event is a notification sent by the browser to the client when something of interest occurs. To receive events, the client must first subscribe to them using the session.subscribe command.

The client can subscribe to a specific event or to all events in a module. For example, subscribing to "browsingContext.contextCreated" subscribes the client to that single event, while subscribing to "browsingContext" subscribes the client to every event in the browsingContext module.

Every event notification you receive from the browser has three fields:

• type: Always "event".
• method: The event name, in the form module_name.event_name.
• params: An object containing the event-specific data. The structure of params is specific to each event.

The following is a sample event message sent by the browser when the client is subscribed to log.entryAdded and a console message is logged (some fields have been omitted for brevity):

{
  "type": "event",
  "method": "log.entryAdded",
  "params": {
    "type": "console",
    "level": "info",
    "text": "Hello world",
    "timestamp": 1657282076037,
    "method": "log"
  }
}

Browser compatibility

See also

• WebDriver BiDi web client