Selenium Capabilities in webmate
This page lists the most important capabilities for Selenium tests in webmate. Capabilities configure the test environment, e.g., the browser, platform, project, and webmate-specific test metadata.
appium:appPackage, and set the capabilities browserName and browserVersion accordingly.The following table documents the common Selenium and webmate capabilities. You can also send standard WebDriver capabilities, browser-specific capabilities, and vendor-prefixed custom capabilities when they are supported by the selected browser or Selenium client.
The capabilities wm:apikey, browserName, browserVersion, and platformName are mandatory.
If you are using an older API key of the format “c1e3effb-xxx-xxx-xxx-xxx”, wm:email is also required.
To generate capabilities for your test, you can also use the Capability Configurator
.
webmate uses the requested browser capabilities to prepare the matching browser environment dynamically where supported. Legacy browser templates are not the documented path for new Selenium web tests.
Use a current W3C-compatible Selenium client. Selenium 3 is no longer supported for new webmate browser sessions.
| Capability | Type / Example Value | Default | Description |
|---|---|---|---|
browserName | “firefox” | Type of browser | |
wm:browserlanguage | “de” | Specifies the user language configured in the browser. If omitted, webmate does not enforce language settings. | |
browserVersion | “126” (a string!) | Browser version | |
platformName | “WINDOWS_11_64” | OS type and version | |
wm:apikey | “xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=” | Your API key in webmate | |
wm:autoScreenshots | boolean | false | If true, screenshots are automatically taken on NavigateTo, Click, SendKeys, and TakeScreenshot and associated with the test. |
wm:basicauthdata | {"basic_auth_domain": "www.examplepage.org", "basic_auth_username": "testuser", "basic_auth_password": "supergeheim"} | No basic auth | Contains parameters required for basic authentication. Implies wm:useproxy = true. |
wm:capabilitySet | “chrome-latest” | Name of a predefined capability set (see /web-testing/capability-sets/). Capability sets contain frequently used capability combinations, e.g., for the latest chrome on mac. | |
wm:email | “xxx@xxx.com” | Your login name (email address) in webmate | |
wm:model | “Pixel 4” | Mobile device model (in case of mobile browser test) | |
wm:name | string | “Unnamed Selenium Test” | Test name shown in test lab. If not set |
wm:project | “7c4f09fd-xxx-xxx-xxx-xxx” | Default project of organization | Id of project where the test is executed |
wm:sessions | string | Name or id of a webmate test session. If a session with the given name already exists, the test with be associated with that session, otherwise a new session will be created for this test. | |
wm:slot | device slot id (UUID) | Specifies the device slot where the test device is deployed in. If there is already a suitable device deployed in the given slot, this device is used, otherwise the request is queued. If no slot is specified, webmate chooses a compatible slot in the given project. | |
wm:tags | “sprint=42, tag2” | Comma-separated list of tags to be associated with the test. If a tag contains an “=”, the tag will be interpreted as key-value pair. | |
wm:useproxy | boolean | false | If true, a proxy is deployed (needed for some use cases) |
Additional Capabilities
Additional W3C WebDriver capabilities, browser-specific options, and vendor-prefixed custom capabilities can be included in your session request.
Use the following guidelines:
- Keep browser and platform selection explicit with
browserName,browserVersion, andplatformName. - Use the
wm:namespace only for webmate-specific capabilities. - Use browser or vendor namespaces for custom capabilities, for example
goog:chromeOptionsor another documented vendor prefix. - Do not rely on unsupported capabilities being applied silently. If a capability affects test behavior, verify it with a small test run.
Blocked capabilities may appear in a block list in our documentation.
You might also want to have a look at the latest published W3C WebDriver Draft (opens in a new tab) .