Skip to main content

How to Connect Salesforce to Rupert

Complete Step-by-Step Guide to creating an external app in Salesforce

Sylvan Team avatar
Written by Sylvan Team
Updated this week

This guide walks you through connecting your Salesforce instance to Rupert. You'll need to set up an External Client App in Salesforce first.
โ€‹

The connection setup has three main parts:

1. Create a dedicated Salesforce user for Rupert

2. Set up an External Client App in Salesforce

3. Connect to Rupert using your credentials
โ€‹

๐Ÿ—จ๏ธ Before you begin

Make sure you've received a certificate file from the Sylvan (Rupert) team.

Required Permissions

You'll need:

  • Admin access to your Salesforce instance

  • Permission to create External Client Apps

  • Access to create users and assign permissions


Step 1: Create a Salesforce User for Rupert

Create a user that will act on Rupert's behalf.

  1. In Salesforce Setup, navigate to Users

  2. Click New User

  3. Create a user with a name like "Rupert Integration User"

  4. Assign these permissions:

    1. API Enabled

    2. View All Users

    3. View All Data

    4. Modify All Data


Step 2: Create an External Client App

  1. Log in to your Salesforce account and navigate to the Setup menu.
    โ€‹

2. In the Quick Find box, search for "External client App Manager" and select it from the results.

3. Click the "New External Client App" button.

4. Enter basic information:

  • Client app name: Enter a name for your external app.

  • API Name: Auto-populates (you can leave as-is).

  • Provide a contact email address.

  • Distribution State: Select Packaged

5. Configure OAuth Settings

  • Scroll down and expend the API section then, check the "Enable OAuth" checkbox.

  • Set the callback URL to sfdc://oauth/restapi/success

  • Select the following OAuth scopes:

    1. Access content resources (content)

    2. Access unique user identifiers (openid)

    3. Full access (full)

    4. Manage user data via APIs (api)

    5. Perform requests at any time (refresh_token, offline_access)

  • Flow Enablement

    1. Check Enable Client Credentials Flow

    2. Check the "Use digital signatures" checkbox and upload the certificate issued by Rupert.

    3. Click "Create"

6. Configure App Policies
โ€‹

  • Under the "Policies" tab click the "Edit" button

  • Choose who can access and use the application and/or permissions sets (for example your CSM groups):
    โ€‹

OAuth Policies section

  • Under permitted Users, select the "Admin approved users are pre-authorized" option.

image.png


โ€‹
App Authorization

  • Check the "Refresh token is valid until revoked" option

image.png

10. Click "Save"

That's it!

You've now created an external app in Salesforce.


Step 3: Connecting Your App to Rupert

Navigate to Rupertโ€™s Manage Sources or Connections tab and select the Salesforce connection.

Source Name

Enter a source name. This can be any name you choose for the connection.

Customer Key and Customer Secret

To find the key and secret:


1. Navigate to the Settings tab

2. Under OAuth settings

  • Click the Customer Key and Secret button
    โ€‹

  • Here you can find the Customer key and Customer secret which are needed for the integration between Rupert and Salesforce. Copy and paste them in Rupert's connection page.

Instance URL

To locate your Instance URL, click your profile icon, copy the instance, and paste it into the connection page.


Did this answer your question?