Skip to Content

Salesforce Events prerequisites

Introduction

This page describes the prerequisites of the Salesforce Events connector.

To use the Salesforce Events connector, these prerequisites must be met:

Configure a Salesforce connected app

A Salesforce connected app must be be configured as described below.

To create a new custom app in the Salesforce instance, follow these steps using the Salesforce Lightning UI:

  1. Navigate to Platform Tools > Apps > App Manager.

  2. Click New Connected App in the top right:

    Salesforce new connected app annotated

  3. Set up a connected app with a configuration similar to that shown below. Certain fields that are important for use with the Salesforce Events connector are identified and described below.

    Salesforce new connected app configuration annotated

    • In Basic Information, provide a Connected App Name that does not contain any spaces, such as JitterbitHarmonySalesforceEventsApp. The API Name field will become autopopulated.
    • In API (Enable OAuth Settings), select Enable OAuth Settings. Additional fields become available to configure:
      • Callback URL: Enter https://jitterbit.com/callback/oauth/connector.
      • Selected OAuth Scopes: Add Full access (full) to the Selected OAuth Scopes.
  4. Click Save and follow the prompt to continue. The Manage Connected Apps screen displays, where you can obtain the consumer key and consumer secret.

Obtain the consumer key and consumer secret

To obtain the consumer key and consumer secret in an existing app, follow these steps using the Salesforce Lightning UI:

  1. Go to Manage Connected Apps for the existing app.

  2. In API (Enable OAuth Settings), click Manage Consumer Details:

    Salesforce new connected app manage consumer details annotated

  3. The Consumer Key and Consumer Secret are displayed. Retain these for use in configuring the Salesforce Events connection.

    Salesforce new connected app consumer details annotated

Select the entities that generate events

To configure events to be generated, follow these steps using the Salesforce Lightning UI:

  1. Go to Setup. This can be accessed from the gear icon in the top right:

    Salesforce setup

  2. Navigate to Platform Tools > Integrations > Change Data Capture.

  3. On the Change Data Capture screen, select the entities (objects) for which you want events to be generated and add them to Selected Entities.

    Salesforce Events

    Important

    When using the Salesforce Events connector, if you try to enable events associated with an object that has not been selected here, a permissions error will be returned.