- Robot JavaScript SDK
- About the Robot JavaScript SDK
- Configuration Steps
Configuration Steps
Prerequisites and configuration steps for the Robot JavaScript SDK: JavaScript Add-On installation and application access setup.
This page covers the prerequisites and configuration for using the Robot JavaScript SDK in custom web applications, including setting up browser and Robot consent access, installing the SDK, and configuring the JavaScript Add-On.
Prerequisites
The following prerequisites must be met for automation projects to use the Robot JavaScript SDK:
- UiPath Robot 2026.10 installed
- The UiPath JavaScript Add-On installed on the Robot machine
Allowing access
When the UiPath Robot JavaScript Add-On is run, access must be granted for your custom application or web page to connect to the Robot. The access is handled by a two-step dialog — both steps must be confirmed to run RobotJS. Both dialogs support automation as described in the following sections.
Browser access dialog
This step refers to the browser requesting permissions to open the UiPath Assistant.
Automatically accepting the browser access dialog
The uipath-web protocol is the UiPath Robot web protocol handler. Browsers ask for permission before they open it. You can automate this dialog through your browser's enterprise policies.
Based on the browser used, different settings need to be configured. For the exact policy and value format, see the enterprise policy documentation of your browser.
Robot consent dialog
The robot consent dialog is used to allow the connection between the Robot JavaScript SDK and the Robot Executor.
Automatically accepting the robot consent dialog
The UIPATH_ROBOTJS_ALLOWLIST System Environment Variable automatically accepts the robot consent dialog.
The value is a list of origins separated by semicolons. Each origin includes the scheme, for example https://myapp.contoso.com. Add the port only if it is not the default (80 or 443).
Example:
UIPATH_ROBOTJS_ALLOWLIST=https://cloud.uipath.com;https://mydomain.com
UIPATH_ROBOTJS_ALLOWLIST=https://cloud.uipath.com;https://mydomain.com
The Robot already accepts the UiPath cloud origins by default, so you only add your own origins. For the default list, see the AllowUrlList key in Configuration files.
The Robot JavaScript SDK
This SDK provides all the necessary methods and properties you can include in your custom application or web page. It is available as an npm package with TypeScript bindings. To include it in your project:
-
Run the following command at the root of your project directory:
npm install --save @uipath/robotnpm install --save @uipath/robot
To load the SDK with a <script> tag instead, use dist/js/UiPathRobot.js from the package.
Version 1.3.3, the last one published to download.uipath.com, remains available at https://download.uipath.com/js/1.3.3/UiPathRobot.js. Newer versions are published only on npm.
Add-on settings
To configure add-on settings:
- Open the
UiPath.configfile:%ProgramFiles%\UiPathPlatform\Robot\<version>\UiPath.configfor a per-machine installation, or%LocalAppData%\Programs\UiPathPlatform\Robot\<version>\UiPath.configfor a per-user installation. For details, see Configuration files. - Add the
ListenerPortandTokenExpiryInDaysparameters to the<robotJsSettings>section. By default, the section does not contain any keys:
<robotJsSettings>
<add key="ListenerPort" value="2323" />
<add key="TokenExpiryInDays" value="30" />
</robotJsSettings>
<robotJsSettings>
<add key="ListenerPort" value="2323" />
<add key="TokenExpiryInDays" value="30" />
</robotJsSettings>
| Attribute | Description |
|---|---|
ListenerPort | The UiPath.RobotJS.ServiceHost.exe starts a HttpListener on the configured port and contains the information about other local listeners from the active user session on that system. The port value must match the one configured in the SDK Settings. The default value is 2323. |
TokenExpiryInDays | Any request coming from a new domain needs to have consent from the user to allow access of UiPath Robots from a web application. These consents are valid for the said number of days mentioned in this setting. The default value is 30. |
After you edit the file, restart the UiPath RobotJS Service service for the changes to take effect. For the steps, see Restarting robot components.