---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Set up the UiPath spoke

# Set up the UiPath spoke {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes to read  
Integrate the ServiceNow instance with your UiPath account to authenticate ServiceNow requests.

## Before you begin

* Request an Integration Hub subscription.
* Activate the UiPath spoke.
* Role required: admin.
{#conf-alias-uipath__ul_l2l_mph_gfb}

## About this task

You can set up the UiPath spoke using OAuth authentication or API key as per your requirement.

* See [Option 1: Using OAuth authentication](https://www.servicenow.com/docs/EN5qeRy5X_XDGGXTVH_kdQ#uipath-opt2 "Integrate the ServiceNow instance with your UiPath account using OAuth to authenticate ServiceNow requests.") to set up the UiPath spoke using OAuth authentication.
  * This authentication is available from UiPath spoke v2.2.1.
  * You can't use MID Server if you set up the spoke using OAuth authentication.
  {#conf-alias-uipath__ul_sqb_31j_q5b}
* See [Option 2: Using API key](https://www.servicenow.com/docs/EN5qeRy5X_XDGGXTVH_kdQ#uipath-opt1 "Integrate the ServiceNow instance with your UiPath account using API key to authenticate ServiceNow requests.") to set up the UiPath spoke using API key.
{#conf-alias-uipath__ul_zxr_b1j_q5b}

## Option 1: Using OAuth authentication {#ariaid-title2}

Integrate the ServiceNow instance with your UiPath account using OAuth to authenticate ServiceNow
requests.

### Before you begin

Role required: admin  
Note:  
* This authentication is available from UiPath spoke v2.2.1.
* You can't use MID Server if you set up the spoke using OAuth authentication.
{#uipath-opt2__uipath-spk-note}

### Procedure

1. Register an application in your UiPath account.
   1. Log in to your UiPath account as an admin.
   2. Navigate to AdminExternal Applications.
   3. Click + Add Application.
   4. On the form, fill these values.  
      {#uipath-opt2__table_nc5_4kg_q5b__entry__2}

      | Field | Description |
      |-|-|
      | Application Name | Name of the OAuth application. |
      | Application Type | Type of OAuth application. Select Confidential application. |
      | Resources | Required resource and scopes. 1. Click + Add Scopes. 2. Select Orchestrator API Access from the Resource list. 3. Select these application scopes: * OR.Robots.Read * OR.Robots.Write * OR.Jobs.Read * OR.Jobs.Write * OR.Machines.Read * OR.Execution.Read * OR.Queues.Read * OR.Queues.Write * OR.Folders.Read {#uipath-opt2__ul_v4w_jlg_q5b} 4. Click Save. {#uipath-opt2__ol_sdp_glg_q5b} |
      | Redirect URL | ServiceNow instance redirect URL in this format: <kbd class="ph userinput">https://&lt;ServiceNow-instance&gt;.service-now.com/oauth_redirect.do</kbd> |
      [ ]

      {#uipath-opt2__table_nc5_4kg_q5b}
   5. Click Add.  
      The application is registered and values of App ID and App Secret are displayed.
   6. Copy and record the values of app ID and app secret.
   {#uipath-opt2__substeps_sts_3kg_q5b}
2. In your ServiceNow instance, configure the required connection and credential alias.
   1. Log in to your ServiceNow instance as an admin.
   2. Navigate to AllConnections \& CredentialsConnection \& Credential Aliases.
   3. Open the record for UiPath.
   4. For Configuration Template, select UiPath Configuration Template - OAuth Client Credentials.
   5. Click the Create New Connection \& Credential related link.
   6. On the form, fill these fields.  
      {#uipath-opt2__table_v1z_x5f_q5b__entry__2}{#uipath-opt2__uipath-dep}

      | Field | Description |
      |-|-|
      | Connection information ||
      | Name | Name to identify the OAuth application registry record. |
      | Connection URL | Connection URL in this format: <kbd class="ph userinput">https://{base_url}/{organization_name}/{tenant-name}/orchestrator_</kbd>. This URL depends on the type of UiPath deployment. |
      | Credential information ||
      | Name | Name to identify the credential record. |
      | Token URL | Location of the token endpoint that the instance uses to retrieve and refresh tokens. This URL depends on the type of UiPath deployment. |
      | OAuth Client ID | App ID you had copied after registering application in your UiPath account. |
      | OAuth Client Secret | App secret you had copied after registering application in your UiPath account. |
      | OAuth Redirect URL | ServiceNow instance redirect URL in this format: <kbd class="ph userinput">https://&lt;ServiceNow-instance&gt;.service-now.com/oauth_redirect.do</kbd>. |
      [Table 1. Create Connection and Credential form]

      {#uipath-opt2__table_v1z_x5f_q5b}
   7. Click Create.
   8. Click Submit.  
      Connection and credential records are created.
   9. Open the UiPath Connection record, from the Connections tab.
   10. Select a value for the Orchestrator Feature Enabled field.
   {#uipath-opt2__substeps_sb2_fng_q5b}

### Result

The Connection and Credential alias is configured and the UiPath spoke is set up using OAuth authentication.

## Option 2: Using API key {#ariaid-title3}

Integrate the ServiceNow instance with your UiPath account using API key to authenticate ServiceNow
requests.

### Before you begin

Role required: admin

### Procedure

1. From your UiPath cloud account, obtain the values of the required API refresh tokens.  
   Note:  
   These steps are applicable to UiPath cloud account.
   1. Log in to your UiPath account as an admin.
   2. Navigate to PreferencesPrivacy \& Security.
   3. For the required tenant, click View API access.  
      The values of User Key, Organization ID, Tenant Name, and Client ID are displayed.
   4. Copy and record these values.
   {#uipath-opt1__substeps_ycj_ycg_q5b}
2. In your ServiceNow instance, configure the required connection and credential alias.
   1. Log in to your ServiceNow instance as an admin.
   2. Navigate to AllConnections \& CredentialsConnection \& Credential Aliases.
   3. Open the record for UiPath.
   4. For Configuration Template, select UiPath Configuration Template - UiPath Cloud or UiPath Configuration Template - Private/Public Cloud as per your requirement.
   5. Click the Create New Connection \& Credential related link.
   6. On the form, fill these fields.  
      * If you have selected UiPath Configuration Template - UiPath Cloud for Configuration Template, fill these fields.  
        Note:  
        This option is applicable if you are using UiPath cloud account.
        {#uipath-opt1__table_nry_c2v_wkb__entry__2}

        | Field | Description |
        |-|-|
        | Connection Name | Name to identify the connection record. For example, <kbd class="ph userinput">UiPath Connection</kbd>. |
        | Connection URL | Connection URL in this format: <kbd class="ph userinput">https://platform.uipath.com/&lt;account-logical-name&gt;/&lt;instance-logical-name&gt;</kbd> |
        | Credential Name | Name to identify the credential record. For example, <kbd class="ph userinput">UiPath Credential</kbd>. |
        | Token URL | Location of the token endpoint that the instance uses to retrieve and refresh tokens. For example, <kbd class="ph userinput">https://account.uipath.com/oauth/token</kbd>. |
        | Client Id | Value of client ID you had copied from the UiPath Orchestrator application. |
        | Account Logical Name | Organization ID you had copied from the UiPath Orchestrator application. |
        | Tenant Logical Name | Tenant name you had copied from the UiPath Orchestrator application. |
        | User Key | User key you had copied from the UiPath Orchestrator application. |
        [Table 2. Create Connection and Credential form]

        {#uipath-opt1__table_nry_c2v_wkb}
      * If you have selected UiPath Configuration Template - Private/Public Cloud for Configuration Template, fill these fields.{#uipath-opt1__table_gky_yfv_wkb__entry__2}

        | Field | Description |
        |-|-|
        | Connection Name | Name to identify the connection record. For example, <kbd class="ph userinput">UiPath Connection</kbd>. |
        | Connection URL | UiPath instance URL. |
        | Credential Name | Name to identify the credential record. For example, <kbd class="ph userinput">UiPath Credential</kbd>. |
        | Token URL | Location of the token endpoint that the instance uses to retrieve and refresh tokens in this format: <kbd class="ph userinput">http://&lt;instance-URL&gt;/api/account/authenticate</kbd> |
        | Tenant Name | Tenant logical name. |
        | Username or email | Username or email address to authenticate the UiPath Orchestrator API. |
        | Password | Associated password. |
        [Table 3. Create Connection and Credential form]

        {#uipath-opt1__table_gky_yfv_wkb}

      {#uipath-opt1__ul_mkq_ydv_wkb}  
      Note:  
      * You must enable Use MID server option in the connection record and create a SSL certificate from a trusted authority for on-prem support.
      * The MID Server users must have the sn_uipath_spoke.uipath_admin role.{#uipath-opt1__mid-uipath-role}
      {#uipath-opt1__ul_pmt_ztg_q5b}
   7. Click Create.
   8. Click Submit.  
      Connection and credential records are created.
   9. Open the UiPath Connection record, from the Connections tab.
   10. Select a value for the Orchestrator Feature Enabled field.
   {#uipath-opt1__substeps_uc4_ddg_q5b}
{#uipath-opt1__steps_a35_2sf_q5b}

### Result

The Connection and Credential alias is configured and the UiPath spoke is set up using API key.

## Configure a connection for the UiPath spoke {#ariaid-title4}

Configure a connection to your UiPath account. The UiPath spoke connection and credential aliases use these connections to perform actions in UiPath.

### Before you begin

Role required: admin.

### Procedure

1. Navigate to AllProcess AutomationWorkflow Studio.
2. Click the Integrations tab.
3. Under Connections, toggle and enable the Outbound connections.
4. Locate the alias for UiPath and click View Details.  
   * To configure the default connection and credential alias record that is shipped along with the UiPath spoke, click View Details.

   * To manage more than one UiPath spoke connection records, you should create a new child alias record by clicking Add Connection. For more information about using multiple connections, see [Supporting multiple connections](https://www.servicenow.com/docs/D9pGgVwvfvFrzWX3lknyWg "Support several connections to a single integration provider. Select connections for flows, subflows, and actions directly from a flow.").

   {#uipath-conctn-config__ul_8b6_c74_ba4}

   If you are configuring the spoke for the first time, click Configure. Otherwise, click Edit.

5. On the form, fill in these fields:  
   {#uipath-conctn-config__table_7cc_737_c9b__entry__2}

   | Field | Value required |
   |-|-|
   | Connection Information ||
   | Connection Name | Name to identify the UiPath connection record. Default value: <kbd class="ph userinput">UiPath</kbd>. |
   | Connection URL | URL of your UiPath instance in this format: <kbd class="ph userinput">https://&lt;instance-url&gt;</kbd>. Replace <kbd class="ph userinput">&lt;instance-url&gt;</kbd> with the URL of your UiPath instance. |
   | Credential Information ||
   | Credential Name | Name to identify the UiPath credential record. Default value: <kbd class="ph userinput">UiPath Credential</kbd>. |
   | Token URL | URL to fetch the authentication token from, in this format: <kbd class="ph userinput">http://&lt;instance-url&gt;/api/account/authenticate</kbd>. Replace <kbd class="ph userinput">&lt;instance-url&gt;</kbd> with the URL of your UiPath instance. |
   | Tenant Name | Name of the UiPath tenant. Default value: <kbd class="ph userinput">Default</kbd>. |
   | Username or email | Username or email address of the UiPath account used for outbound authentication. |
   | Password | Password of the UiPath account used for outbound authentication. |
   [ ]

   {#uipath-conctn-config__table_7cc_737_c9b}

6. Click Save.
{#uipath-conctn-config__steps_a2d_741_42b}

### Result

The UiPath spoke connection is configured and ready to be used.

*[\>]: and then