Plugins System API · Selenium IDE

The System API is the most basic API which Selenium IDE provides. It is not prefixed and can be called with /.

Opening Selenium IDE

If the extension is installed, a request could be made by a plugin to open Selenium IDE.

{
  openSeleniumIDEIfClosed: true
}

`GET /health`

Used for plugin health checks, see Plugin Health Checks.

`POST /register`

Used to register your plugin with Selenium IDE, this way the IDE knows of your plugin's existence, see registering the plugin.

`POST /log`

Used for system logs, meaning when the user can filter by system logs group.
Logs that explain plugin usage, or status should be logged here.

{
  uri: "/log",
  verb: "post"
  type: "log type", // error, warn, undefined
  message: "your log message goes here"
}

type - log type, undefined is an info log, while error will appear red, and warn will appear orange.
message - string message, any links will be automatically linkified.

Returns

Returns true if the log was added.

`GET /project`

Fetches the id and name of the currently loaded project.

{
  id: "auto-generated-project-id",
  name: "your-project-name"
}

`POST /project`

Loads a project into the IDE, as if the user opened it, if the user has unsaved changes a dialog will ask him before doing so.

{
  project: JSON parsed side file
}

`POST /control`

Start a connection from another chrome extension. When this connection is accepted by the user, Selenium IDE restarts and registers the caller, and the extension takes exclusive control of Selenium IDE until user closes Selenium IDE or another connection is accepted. When this mode is on, the save to computer functionality gets overwritten by sending the side file to the extension controlling Selenium IDE.

The payload of this call is identical to the payload of POST /register call.

`POST /close`

When Selenium IDE is controlled by another chrome extension, the controller extension can use this API to close the IDE window. If user have any unsaved changes, it will prompt user to whether give up the changes or ignore the close. No payload is needed.