If you wish to add a Salesforce knowledge base using the Agent Assist Configuration feature, please read the guidelines below to learn how to obtain the required data and authorizations in Salesforce.
- Granting Authorization to Access Salesforce Data
- Adding the Required Data
Granting Authorization to Access Salesforce Data
Two items are needed for Agent Assist to be able to access the data of a specific Salesforce instance:
- A Connected App;
- A user with a profile with permissions to read the data and to use the created app.
Creating a Connected App
To be able to connect Agent Assist to a Salesforce knowledge base, you need to provide a client key and secret so that you can obtain an OAuth token.
To get those items, first, you need to create a connected app with the necessary information:
- Go to your Salesforce instance, e.g., https://<your_domain>.lightning.force.com/lightning/setup/
- Then, go to Apps > App Manager.
- In the top-right corner, click on New Connected App.
- Give the app a name (e.g., Agent Assist) and enter your email address.
- Check the “Enable OAuth Settings” checkbox (in the API section) and fill in all the required information:
- The “Callback URL” is not needed, but since the field cannot be left empty, please enter https://login.salesforce.com/services/oauth2/callback
- In “Selected OAuth scopes”, choose Access and manage your data (api).
6. Click Save when you’re done.
- After creating the connected app, the Consumer Key and Secret should be displayed.
- To check this information later, go to Apps > App Manager.
- Then, click on the arrow on the connected app you want to check and click View.
- The Consumer Key corresponds to the Client ID and the Consumer Secret corresponds to the Client Secret fields needed by Agent Assist Configuration.
- Please make sure you save both keys in a safe location.
Creating an Authorized User Profile
After creating the connected app, a user profile should be created for Agent Assist. To do so, please follow these steps:
- Go to Administration > Users > Profiles and click on New Profile.
- In the “Existing Profile” drop-down, select Read-Only and choose the “Profile Name” you wish to use.
- While creating the new profile, the goal is to give it only the permissions needed to use the REST API, to read from the Knowledge Bases, and to use the Agent Assist App:
- In “Connected App Access”, check the box next to the name of the app created for Agent Assist.
- In “Administrative Permissions”, uncheck all boxes except the one next to “API Enabled” (note that some boxes may be impossible to uncheck; leave those as they are).
- In “General User Permissions”, uncheck all uncheckable options.
- In “Standard Object Permissions”, uncheck all uncheckable options.
- In “Knowledge Base Permissions”, select the checkbox in the “Read” column.
- Select the profile created before as the Agent Assist user, by following these steps:
Note: If there is no user for Agent Assist, please create one.
- Click on Edit next to the Agent Assist user.
- In "Profile", select the created profile.
- Go to Apps > App Manager.
- Then, click on the arrow next to the Agent Assist App and click on Manage.
- On the app’s management page, click Edit Policies.
- In “OAuth Policies”, change the “Permitted Users” value to Admin approved users are pre-authorized.
- Click Save.
Adding the Required Data
In the “Connection Settings” section of the Salesforce knowledge base, please fill out the mandatory fields by following these guidelines:
URL: The URL corresponds to the Salesforce instance URL from which you want to extract data. Usually, it has this format: https://<company-domain>.salesforce.com; https://<company-domain>.my.salesforce.com
- Username: The username of an account authorized to access both the articles and the Salesforce API. More information on how to do that can be found in the section “Creating an Authorized User Profile”.
- Security Token:
- Please add a combination of the user’s password and their security token in the format <password><security token> (e.g., for the password “abc” and the security token “123”, please enter “abc123” in the field).
- The security token is needed to access the Salesforce API. To obtain a Salesforce security token, if you do not have one saved already, please follow these steps:
- Go to Settings.
- Under “My Personal Information”, select Reset My Security Token and click on Reset Security Token. You should receive the token via e-mail.
- Login URL: This is the Salesforce URL used to obtain the login token. It is https://login.salesforce.com/ in production instances and https://test.salesforce.com in sandbox/test instances.
- Client ID: This corresponds to the Salesforce Connected App consumer key. More information can be found in the section “Creating a Connected App”.
- Client Secret: Here you need to enter the Salesforce Connected App consumer secret. More information can be found in the section “Creating a Connected App”.
- Grant Type: This is the grant type used to obtain Access Tokens. Currently, the only allowed value is “password”.
For additional support, please contact your Customer Success Manager or firstname.lastname@example.org