Set up the Salesforce spoke

task brazil Updated Mar 12, 2026 13 min read setup-sf-spk.md
Raw file servicenow.com

Integrate your Salesforce account with your ServiceNow instance. Create a custom OAuth application in Salesforce and authenticate requests from ServiceNow.

Before you begin

  • Request an Integration Hub subscription
  • Activate the Salesforce spoke
  • Role required: admin.

Note: Two spoke setup procedures are outlined here. Perform one of the procedures as per your requirement.

Note: Don't delete the default connection alias record. This can result in an unexpected behavior. Configure your connection using the default connection alias.

Configure a connection for Salesforce spoke

Add and configure a Salesforce connection to authenticate ServiceNow requests in Salesforce spoke.

Before you begin

Role required: admin

Procedure

  1. Navigate to Process Automation > Workflow Studio.

  2. Select Integrations.

  3. Select the Connections tab.

  4. Use the search box to find the Salesforce connection alias.

  5. Select View Details.[Omitted image "salesforce-spoke-conn-templt.png"] Alt text: Connection template for Salesforce spoke

  6. Configure the Salesforce connection.

    1. Add or edit a connection.

      • To set up an existing connection, select Configure or Edit.
      • To create and configure a new connection, select Add Connection. Note: To support multiple connections through a spoke, see Supporting multiple connections.

    2. On the configuration form, fill in the fields.

Field

Description

Connection Name

Name to uniquely identify the connection. For example, Salesforce.

Connection URL (Instance URL)

URL to make a connection to Salesforce. Use this format: https://<organization_name>.my.salesforce.com.

Grant Type

OAuth grant type for authentication. Select one of the following options: - Authorization Code

  • Client Credentials

OAuth Client ID

Client ID generated in Salesforce for OAuth authentication.

OAuth Client Secret

Client Secret generated in Salesforce for OAuth authentication.

OAuth Redirect URL

URL where Salesforce redirects after successful authentication. Use this format: https://<instance_name>.service-now.com/oauth_redirect.do.
3. Select **Save and Get OAuth Token**.

Result

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

Create an external client app in Salesforce

Create an external client app in your Salesforce account to enable OAuth 2.0 authentication with the Salesforce spoke.

Before you begin

  • Salesforce account
  • Role required: Salesforce admin

About this task

See the Create an External Client App documentation for instructions on creating and configuring external client apps.

Procedure

  1. Select Create an External Client App in your Salesforce account.

  2. Configure the external client app to enable your Salesforce application to share data with your ServiceNow instance.

    1. Select Enable OAuth Settings and configure the authentication settings.

    2. To set up the spoke using a JWT signing key, select Use Digital Signatures and upload a Java KeyStore (JKS) certificate.

    3. Select the OAuth scopes:

Grant Type

OAuth scopes

Authorization Code
  • Access and manage your data (api)
  • Perform requests on your behalf at any time (refresh_token, offline_access)

Client Credentials

Access and manage your data (api)
4. Specify ServiceNow instance URL in **Callback URL** in this format: `https://.service-now.com/oauth_redirect.do` 
5.  Set these values under **OAuth Policies** on the Edit Policies page:

    |Field|Value|
    |-----|-----|
    |Permitted Users|Admin approved users are pre-authorized|
    |IP Restrictions|Relax IP Restrictions|

6.  Configure user provisioning for the external client app according to your requirements.

  1. Record the values of Consumer Key and Consumer Secret.

    Note:

    • Assign profile and permission set according to your requirements.
    • In OAuth app IP restrictions, specify OAuth policies to confirm that the external client app works like a default app.

Result

The external client app is created in Salesforce.

Option 1: Set up the Salesforce spoke using OAuth authorization template

Integrate your Salesforce account with your ServiceNow instance. Create a custom OAuth application in Salesforce and authenticate requests from ServiceNow using OAuth authorization template.

Before you begin

Procedure

  1. Log in to Salesforce.

    You can also switch from the Lightning UI.

  2. Select the setup icon [Omitted image "gear-icon.png"] Alt text: Gear icon and then select Setup.

  3. Search for and select  OAuth and OpenID Connect Settings  in the setup page search bar.

  4. Enable Allow Authorization Code and Credentials Flows.

  5. Search for and select App Manager in the setup page search bar.

  6. On the App Manager page, select New External Client App to create an external client application.

  7. On the form, fill in the fields.

Field

Description

Basic Information

External Client App Name

Name of your application.

API Name

Name of the API. This field is automatically populated.

Contact Email

The email address that you want to associate with the application.

Distribution State

The scope of distribution of the application.Select Local as the distribution state.

Contact Phone

The phone number that you want to associate with the application.

Info URL

The URL of the web page with more information about your application.

Logo URL

The URL of your logo image that is displayed with the connected application.

Icon URL

The URL of the icon for the connected application.

Description

Description of the application.

API (Enable OAuth Settings)

Enable OAuth

Option to enable OAuth settings.Select this option to enable the OAuth settings.

Callback URL

URL of the OAuth provider that users are redirected to after authentication. Enter https://*instance*.service-now.com/oauth_redirect.do, where <instance> is the name of your ServiceNow instance.

OAuth Scopes

OAuth scopes that determine the amount of access that is granted to an access token. When the grant type is Authorization Code, use:

  • Manage user data via APIs (api)
  • Perform requests at any time (refresh_token, offline_access) When the grant type is Client Credentials, use Manage user data via APIs (api).

Flow Enablement

Enable Client Credentials Flow

Select this option when the grant type is Client Credentials.

Security

Require Secret for Web Server Flow

The option to implement the Require Secret for Web Server Flow in your external client app or connected app settings.- If the grant type is Authorization Code, select this option.

  • If the grant type is Client Credentials, clear this option.

Require Secret for Refresh Token Flow

The option in your external client app or connected app while implementing the refresh token flow using a server-side callback handler.- If the grant type is Authorization Code, select this option.

  • If the grant type is Client Credentials, clear this option.

Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows

If this field is selected by default, clear the Require Secret for Web Server Flow and Require Secret for Refresh Token Flow options.Note: Enable Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows.
8. Select **Create**. 
The application registration is complete and you're redirected to the Manage External Client Apps page.

  1. Verify and edit the policies for the registered application by selecting Edit.

  2. In the OAuth Policies section, verify that the Permitted Users field is set to Admin approved users are pre-authorized for the ServiceNow application.

    Note: Admin-approved users who are preauthorized enable any users with the corresponding profile or permission set to access the application without prior authorization. For more information, see Pre-Authorize User App Access Through Connected App Policies.

  3. In the App Policies section, select either the profile of the integration user or the profile of the user that you want to use for the integration.

  4. If you have selected the Enable Client Credentials Flow option, then in the OAuth Flows and External Client App Enhancements section, select Enable Client Credentials Flow and enter either the username or email address of the integration user that you want to use for the integration profile.

  5. In the App Authorization section, verify that the Refresh token policy field is set to Refresh token is valid until revoked and the IP Relaxation field is set to Relax IP restrictions.

  6. Select Save.

  7. Retrieve OAuth credentials.

    1. Navigate to Settings > OAuth Settings and then select Consumer Key and Secret.

      The Salesforce login page opens in a new window.

    2. Enter your credentials to log in to Salesforce.

    3. Copy the Consumer Key and Consumer Secret and save them in a secure location for later use.

Option 2: Set up the Salesforce spoke using JWT signing key

Integrate your Salesforce account with your ServiceNow instance. Create a custom OAuth application in Salesforce and authenticate requests from ServiceNow using JWT signing key.

Before you begin

Attach a Java Key Store certificate to the Salesforce spoke

Enable the JSON Web Token (JWT) Bearer Grant token authentication by attaching a valid Java KeyStore (JKS) certificate to the Salesforce spoke.

Before you begin

  • Valid Java KeyStore certificate
  • Role required: admin

Procedure

  1. Navigate to All > System Definition > Certificates.

  2. Click New.

  3. On the form, fill in the fields.

    Field Description
    Name Name to uniquely identify the record. For example, Salesforce Certificate.
    Expiration notification Option to send a notification when the certificate is about to expire.
    Notify on expiration Users that are notified when the certificate expires.
    Warn in days to expire Number of days to send a notification before the certificate expires.
    Active Option to actively use the certificate.
    Format Certificate format. The instance supports the PEM and DER formats.
    Type Type of certificate. Select Java Key Store.
    Valid from Date from which the certificate is valid.
    Expires Date on which the certificate expires.
    Expires in days Number of days until the certificate expires.
    Key store password Password associated with the certificate.
    Short description Summary about the certificate.
    PEM Certificate Contents of the X509 certificate.

  4. Click the attachments icon ([Omitted image "attachments-icon.png"] Alt text: Attachments icon) and attach a JKS certificate.

  5. Click Validate Stores/Certificates.

Result

The JKS certificate is created and attached to the Salesforce spoke.

Create a JWT signing key for the Salesforce spoke

Create a JSON Web Token (JWT) signing key to assign to your Java KeyStore certificate.

Before you begin

Role required: admin

Procedure

  1. Navigate to All > System OAuth > JWT Keys.

  2. Click New.

  3. On the form, fill in the fields.

    Field Description
    Name Name to uniquely identify the JWT signing key. For example, Salesforce JWT Keys.
    Signing Keystore Valid JKS certificate attached in the previous task. For example, Salesforce Certificate.
    Key Id Key ID to identify which key is used when multiple keys are used to sign tokens.
    Application Application scope that contains this record. Select Salesforce spoke.
    Signing Algorithm Algorithm to sign with the JWT key.
    Signing Key Password Password associated with the signing key.
    Active Option to actively use the certificate.

  4. Click Submit.

Result

The JWT key is created and assigned to the JKS certificate.

Create a JWT provider for the Salesforce spoke

Add a JSON Web Token (JWT) provider to your ServiceNow instance.

Before you begin

Role required: admin

Procedure

  1. Navigate to All > System OAuth > JWT Providers.

  2. Click New.

  3. On the form, fill in the fields.

    Field Description
    Name Name to uniquely identify the JWT provider. For example, Salesforce JWT Provider.
    Expiry Interval (sec) Number, in seconds, to set the lifespan of JWT provider tokens.
    Signing Configuration JWT signing key from the previous step. For example, Salesforce JWT Keys.

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

    The Standard Claims and Custom Claims related lists are displayed.

  5. In the Standard Claims related list, enter values for iss, sub, and aud.

    See OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration in Salesforce Trailblazer forum documentation for instructions.

  6. Click Update.

Result

The JWT provider is added to your ServiceNow instance.

Register Salesforce as an OAuth Provider

Use the information generated during Salesforce connected app configuration to register Salesforce as an OAuth provider and enable the instance to request OAuth 2.0 tokens.

Before you begin

Role required: admin

Procedure

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

  2. Click New.

    The system displays the message What kind of OAuth application?

  3. Select Connect to a third party OAuth Provider.

    The system displays a blank Application Registries form.

  4. On the form, fill in the fields.

Field

Value required

Name

Name to uniquely identify the record. For example, enter Salesforce OAuth.

Client ID

Consumer key that you generated during the Salesforce connected app configuration.

Client Secret

Consumer secret that you generated during the Salesforce connected app configuration.

OAuth API Script

Optional script to customize the request and response.

Default Grant type

Grant type used to establish the token. Select JWT Bearer.

Refresh Token Lifespan

Time, in seconds, that the refresh token is valid. The default time is 8,640,0000 seconds.

PKCE required

Option 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.

Application

Application scope that contains this record. Select Salesforce.

Accessible from

Application scope that this registry is accessible from.

Active

Option to actively use the application registry.

Authorization URL

This field should be left blank.

Token URL

OAuth server token endpoint.- For production instance, enter https://login.salesforce.com/services/oauth2/token.

  • For sandbox instance, enter https://test.salesforce.com/services/oauth2/token

Token Revocation URL

This field should be left blank.

Redirect URL

This field should be left blank.
5. Right-click the form header, and click **Save**. 
-   The system validates the OAuth credentials and populates the **Redirect URL** field.
-   The system populates **OAuth Entity Profile** with **Grant Type** as **JWT Bearer**. For example, **OAuth Entity Profile** is created with default **Name**, **Salesforce JWT provider default\_profile** .

  1. Copy the value from the Redirect URL field.

  2. Click Update.

  3. Log in to your Salesforce account to edit the configuration of your connected app.

    See the Salesforce Trailblazer forum documentation for instructions.

  4. Paste the Redirect URL value into the Callback URL of your Salesforce connected app.

    For example, paste https://<instance-name>.service-now.com/oauth_redirect.do.

Result

The instance can request OAuth 2.0 tokens for the Salesforce spoke.

Note: When an OAuth token expires, the spoke automatically regenerates a new token in most cases. If a token expires and is not regenerated, a user with the admin role can regenerate the spoke OAuth token.

Create credential records for the Salesforce spoke

Create Credential records for the Salesforce connected app that you created. The Salesforce spoke connection and credential alias use these credentials to authorize actions.

Before you begin

Role required: admin

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.

    The pop-up window displays a blank OAuth 2.0 Credentials form.

  4. On the form, fill in the fields.

    Field Value required
    Name Name to uniquely identify the record. For example, enter Salesforce Credentials.
    Active Option to actively use the credential record.
    OAuth Entity Profile OAuth profile that you created when you registered the Salesforce connected app as an OAuth provider. For example, select Salesforce OAuth default_profile.
    Applies to MID Servers that can use this credential. For example, select All MID Servers.
    Order Order to apply this credential. For example, enter 100.

  5. Save the record.

  6. Click the Get OAuth Token related link to generate the OAuth token.

Result

The credential record for the Salesforce spoke is created.

Create connection records for the Salesforce spoke

Create connection records for your Salesforce account. The Salesforce spoke connection and credential alias use these connections to perform actions in Salesforce.

Before you begin

Role required: admin

Procedure

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

  2. Open for the record for Salesforce.

  3. On the Connections tab, click New.

    The system displays a blank HTTP(s) Connection form.

  4. Enter these values.

Field

Value required

Name

Name to uniquely identify the connection record. For example, enter Salesforce Connection.

Credential

Credential record you that created for Salesforce. For example, select Salesforce Credentials.

Connection alias

Alias record associated with this connection.

URL builder

Note: Do not select the check box.

Connection URL

Base URL to connect to your Salesforce instance. For example, https://<instance-name>.salesforce.com.

Use MID server

Option to use a MID Server. If you select this check box, define the fields in the Advanced MID Server Configuration related list.

Active

Option to actively use the connection.

Domain

Domain that the action or activity runs in.
5. Right-click the form header and click **Save**.
  1. Ensure that api_version is set v48.0 in the Attributes related list.

Result

The Salesforce spoke is set up and integrated with the ServiceNow instance.

Search documentation
Search document titles and file paths on the brazil branch