Salesforce Knowledge Base Connector

  • Updated

Get Enterprise AI+

Do you want access to this new feature? Contact your Zingtree Account Manager or our Support Team.

Zingtree's AI Knowledge Search is powered by your knowledge articles. To configure the search, first connect your knowledge base(s) to the application. In just a few steps, we make it simple to connect to standard knowledge bases, including Salesforce Knowledge (Lightning).


After establishing the connection to your knowledge base, you can select which articles to import into your AI Knowledge Search, creating new experiences for your users.

 

Set up Steps

  1. Create a Connected App in Salesforce
  2. Provide Connector Details in Zingtree
  3. Select Categories 
  4. Import the pages and blog posts into Zingtree

 

What You’ll Need

  • Salesforce Instance URL
  • Login URL
  • Connected App Consumer Key
  • Username

Configuration

Create Connected App

The first step is to create and configure a connected app in your Salesforce organization.  

  • Login to your Salesforce account.
  • From Setup, enter Apps in the Quick Find box, and select App Manager.
  • Click New Connected App.


Enter Basic Information

  1. Connected App Name - Enter a name for the connected app (ex. Zingtree API Connector), which displays in the App Manager and on its App Launcher tile. The connected app name must be unique within your org.
  2. API Name - Enter an API name used when referring to your app from a program (ex. Zingtree_API_Connector). 

It defaults to a version of the name without spaces. Please note that only letters, numbers, and underscores are allowed, so if the original app name contains any other characters, edit the default name.

  1. Contact Email  - Enter a contact email for Salesforce to use in case we want to contact you or your support team. 

API (Enable OAuth Settings)

Now that you’ve entered the basic information, you can move on to the next step where you will enable OAuth settings.  See the example settings listed below.  

  1. Enable OAuth Settings - In the API (Enable OAuth Settings) area of the page, select Enable OAuth Settings.
  2. Callback URL  -Enter the callback URL (endpoint) that Salesforce calls back to your application during OAuth.
  3. Authorization  - For the JWT OAuth flow, select Use Digital Signatures. If the app uses a certificate, click Choose File, and select the certificate on your system to upload for the JWT OAuth flow.
  4. OAuth Scopes  - Select the OAuth scopes to apply to the connected app. OAuth scopes define permissions for the connected app, which are granted as tokens after the app is authorized.
  5. Require Secrets for Web Server Flow- Select “Require Secret” for the Web Server Flow to require the app’s client secret in exchange for an access token.
  6. Require Secrets for Refresh Token - Select Require Secret for Refresh Token Flow to require the app’s client secret in the authorization request of a refresh token and hybrid refresh token flow.
  7. Save - Save Connected App.  Note: Once the connected app is saved, the changes may take a few minutes to take place.

Example Settings

SETTING VALUE
Enable OAuth Settings True
Callback URL https://zingree.com/salesforce/callback
Use digital signatures server.crt (provided by zingtree)
Selected OAuth Scopes

1. Manage user data via APIs (api)

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

Require Secret for Web Server Flow True
Require Secret for Refresh Token Flow True

 

 

Consumer Key

The next step is to produce a Consumer Key (Client ID). 

To produce the Consumer Key, click on Manage Consumer Details from the Enable OAuth Setting settings. This will trigger the verification code flow.  Once the code has been provided the consumer key details are shown below. 

Important Make note of the Consumer Key and save it. This will need to be shared with Zingtree to finalize the connector's configuration.

 

 

 

Manage Connected App

The final step in enabling the Connected App is to set permissions.  

  • From Setup, enter “Apps” in the Quick Find box, and select Manage Connected Apps.
  • Click on the Zingtree API Connector Connected App.
  • From Setup on the Zingtree API Connector, you will set Permitted Users to Admin-approved users are pre-authorized on the app’s OAuth Policies.  

Note If the connected app policy is set to Admin-approved users are pre-authorized, Zingtree is enabled to use profiles and permission sets.

  • Save the connected App OAuth Policies
  • Use Profiles or Permission Sets based on the current policies. 
  • Profiles: Click on Manage Profiles and choose the administrator profile, ex: "System Administrator"

When this is complete, come back to Zingtree to continue to set up your connection.  

 

Set Up your Connector

To connect your knowledge base to Zingtree:

  1. Log in and navigate to the Apps & Integrations section.
  2. Select External Sources in the left navigation.

Note If "External Sources" is not visible, your organization may not be enabled for AI Knowledge Search. Please reach out to your Zingtree Account Manager.

On this page, choose the Salesforce Icon or the + Add Source button.

 

The next step, Connector Details, involves entering key information about the connector so that a proper connection can be made to Salesforce and that your Connector is well described in the application for future identification.  

The required configuration for the Salesforce connector includes:

  • Name
  • Description
  • Connector URL (ex. https://example.my.salesforce.com/services/data/v58.0)
  • Login URL (ex. https://login.salesforce.com
  • Client ID (This is the Consumer Key you saved earlier during the Salesforce setup above).
  • Username
  • Language
  • Content Details Columns
  • Tags Columns 

 

Choose Categories

The final step is selecting articles to import into Zingtree by choosing the Categories. These articles will be refreshed every 24 hours to keep your search updated. 

After configuring the knowledge articles for import, click Save Settings. Your connection is now ready for use in building Search widgets in Zingtree. To build search widgets using this connector go to Knowledge Search > Add Search Widget.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Didn't find what you need?

Our friendly customer support team is here to help

Submit a Ticket

Looking for help or advice?

Reach out to our knowledgeable community of users.

Zingtree Community