Skip to main content

Config

You must enter the following settings when configuring this source: If using OAuth based authentication: If using Password based authentication: Optional settings:

How to get your client_id, client_secret, and refresh_token

Find your client_id and client_secret

  1. Sign into your Salesforce account.
  2. Create a Connected App and Enable OAuth Settings for API Integration by following this Salesforce documentation.
    1. Use the following URL as the callback URL: https://login.salesforce.com/services/oauth2/success
  3. When you are at the step to choose which OAuth Scopes to authorize, you must give your Connected App at least these 2 scopes:
    1. Manage (api)
    2. Perform requests at any time (refresh_token)
  4. After you created a Connected App, go to your Setup and click on the Home tab.
  5. On the left sidebar under the Platform tools > Apps > App Manager, click on App Manager.
  6. Find the row that contains the app you just created. On the furthest right column, click the dropdown caret icon and click View.
  7. Under the API (Enable OAuth Settings) section, find the subsection labeled Consumer Key and Secret and click the button Manage Consumer Details.
  8. A new page will open, displaying your Consumer Key (which is your client_id) and Consumer Secret (which is your client_secret).

Authorize your Connected App

  1. Construct a URL with the following format: https://[your_salesforce_domain].my.salesforce.com/services/oauth2/authorize?client_id=[client_id]&redirect_uri=https://login.salesforce.com/services/oauth2/success&response_type=code
  1. Open that URL in a browser.
  2. Authorize your Connected App to have API access to your Salesforce account.
  3. Once you authorize, you’ll be redirect to a URL like this: https://login.salesforce.com/services/oauth2/success?code=[code].
  4. Note the value of the code URL parameter, it’ll be used to get a refresh_token.

Get a refresh_token

Open a terminal and make the following POST request:
Change the following URL parameters to match your credentials: Once you execute the above CURL command successfully, you’ll receive a response that could look like this:
Take note of the refresh_token, it’ll be used when you configure this source.

Additional resources in case you get lost


Schema

The available schema depends on the objects in your Salesforce account. Some example schema can include the following (depending on your account):
  • AIApplication
  • AIApplicationConfig
  • AIInsightAction
  • AIInsightFeedback
  • AIInsightReason
  • AIInsightValue
  • AIPredictionEvent
  • AIRecordInsight
  • AcceptedEventRelation
  • Account
  • WorkTypeFeed
  • WorkTypeGroup
  • WorkTypeGroupFeed
  • WorkTypeGroupHistory
  • WorkTypeGroupMember
  • WorkTypeGroupMemberFeed
  • WorkTypeGroupMemberHistory
  • WorkTypeGroupShare
  • WorkTypeHistory
  • WorkTypeShare
  • and more…