Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Set up the ServiceNow Remote Instance spoke

Integrate the local and remote ServiceNow instances by creating an OAuth API endpoint in the remote ServiceNow instance to authenticate requests.

Before you begin

  • Request an Integration Hub subscription.
  • Activate the ServiceNow Remote Instance spoke in remote and local ServiceNow instances.

    Note: The terms remote instance and local instance are used in these contexts:

    • Local instance: This is the ServiceNow instance from which the communication is initiated and established.
    • Remote instance: This is the ServiceNow instance with which the local instance communicates.
    • Role required: admin.

    Note: Admin role is required to only set up the spoke.

    To use the spoke, you can either have the admin role or have only the required minimum permissions to access data in the required ServiceNow tables along with the import_transformer role. Do not assign elevated privilege roles to users of this spoke unless needed. This practice ensures controlled access to data.

    The integration users must have the flow_operator and other required roles to access the table they want to interact with. Also, they need roles to access the Table [sys_db_object] and Dictionary Entry [sys_dictionary] tables to show dynamic options such as, table names and fields in a table.

Register remote ServiceNow instance as an OAuth provider

Register remote ServiceNow instance as an OAuth provider so that the local ServiceNow instance can request OAuth 2.0 tokens.

Before you begin

  • In the remote ServiceNow instance:
    • Create an OAuth API endpoint for external clients. In Redirect URL, specify the URL of the local ServiceNow instance in this format: https://<instance-name>.service-now.com/oauth_redirect.do. For more information, see Create an endpoint for clients to access the instance.
    • Copy and record the values of Client ID and Client Secret.
  • Role required: admin

Procedure

  1. Navigate to All > System OAuth > Application Registry.

  2. Open for the record, RemoteSpoke.

  3. On the form, fill these values.

  1. Right-click the form header, and click Save.

Create Credential record for the remote ServiceNow instance

Create credential record for the remote ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential alias uses these credentials to authorize actions.

Before you begin

Role required: admin.

Note: You must perform this task in a local ServiceNow instance.

Procedure

  1. Navigate to All > Connections & Credentials > Credentials.

  2. Click New.

    The system displays the message What type of Credentials would you like to create?.

  3. Select OAuth 2.0 Credentials.

  4. On the form, fill in the fields.

FieldDescription
Client IDClient ID created in the remote ServiceNow instance.
Client SecretClient Secret created in the remote ServiceNow instance.
Authorization URLURL of the remote ServiceNow instance in this format: `https://.service-now.com/oauth_auth.do`.
Token URLURL of the remote ServiceNow instance in this format: `https://.service-now.com/oauth_token.do`.
Redirect URLURL of the local ServiceNow instance in this format: `https://.service-now.com/oauth_redirect.do`.
Default Grant TypeGrant type used to establish the token. Select Authorization Code.
Refresh Token LifespanTime, in seconds, that the refresh token is valid. The default time is 8,640,0000 seconds.
PKCE requiredOption to enable public clients to require PKCE for an authorization.Note: You can use only Authorization Code as the Default Grant type when PKCE is enabled.
ApplicationApplication scope that contains this record.
Accessible fromApplication scope that this registry is accessible from.
ActiveOption to actively use the application registry.
FieldValue required
NameName to uniquely identify the record. For example, Remote Credentials.
ActiveOption to actively use the credential record.
OAuth Entity ProfileOAuth profile created during the registration of the remote ServiceNow instance as an OAuth provider. For example, select RemoteSpoke default_profile.
OrderOrder that the credentials are used. For example, enter 100.
  • Right-click the form header and click Submit.

  • To generate the OAuth token, click the Get OAuth Token related link.

    Create Connection record for the remote ServiceNow instance

    Create Connection record for your remote ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential aliases use these connections to perform actions.

    Before you begin

    Role required: admin.

    Note: You must perform this task in a local ServiceNow instance.

    Procedure

    1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.

    2. Open the alias record, ServiceNowRemoteInstance.

    3. From the Connections tab, click New.

    4. On the form, fill in the fields.

    1. Click Submit.

    Create Credential record for the local ServiceNow instance

    Create credential record for the local ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential alias uses these credentials to authorize actions.

    Before you begin

    Role required: admin.

    Note: You must perform this task in a local ServiceNow instance.

    Procedure

    1. Navigate to All > Connections & Credentials > Credentials.

    2. Click New.

      The system displays the message What type of Credentials would you like to create?.

    3. Select Basic Auth Credentials.

    4. On the form, fill in the fields.

    FieldValue required
    NameName to uniquely identify the record. For example, `Remote Connection`.
    CredentialCredential record created for remote ServiceNow instance. For example, Remote Credentials.
    Connection aliasAlias record associated with this connection.
    URL builderNote: Do not select the check box.
    Connection URLURL of the remote ServiceNow instance. For example, `https://.service-now.com/`.
    ActiveOption to actively use the connection.
    DomainDomain that the action or activity runs in.
    FieldValue required
    NameName to uniquely identify the record. For example, Local Credentials.
    UsernameUsername to log in to the local ServiceNow instance.
    PasswordPassword to log in to the local ServiceNow instance.
    ActiveOption to actively use the credential record.
  • Right-click the form header and click Submit.

    Create Connection record for the local ServiceNow instance

    Create Connection record for your local ServiceNow instance. The ServiceNow Remote Instance spoke connection and credential aliases use these connections to perform actions.

    Before you begin

    Role required: admin.

    Note: You must perform this task in a local ServiceNow instance.

    Procedure

    1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.

    2. Open the alias record, ServiceNowRemoteInstanceLocalAlias.

    3. From the Connections tab, click New.

    4. On the form, fill in the fields.

      FieldValue required
      NameName to uniquely identify the record. For example, Local Connection.
      CredentialCredential record created for local ServiceNow instance. For example, Local Credentials.
      Connection aliasAlias record associated with this connection.
      Connection URLURL of the local ServiceNow instance. For example, https://<local-instance-name>.service-now.com/.
      ActiveOption to actively use the connection.
      DomainDomain that the action or activity runs in.
    5. Click Submit.

    sndocs is an independent community mirror and is not affiliated with or endorsed by ServiceNow.

    ServiceNow, the ServiceNow logo, Now, and other ServiceNow marks are trademarks and/or registered trademarks of ServiceNow, Inc., in the United States and/or other countries. Other company and product names may be trademarks of the respective companies with which they are associated.

    © 2026 ServiceNow, Inc. All rights reserved.

    Documentation content is redistributed under the Apache License 2.0 from the ServiceNowDocs repository.