Skip to Content

Salesforce Events connection in Jitterbit Studio

Introduction

A Salesforce Events connection, created using the Salesforce Events connector, establishes access to Salesforce Platform Events and Salesforce Change Data Capture Events in a Salesforce instance. Once a connection is configured, you can create instances of Salesforce Events activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Note

This connector supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Host, Username, or Consumer key in this connection requires users to re-enter the Password, Security token, Consumer secret, or Private key (depending on the selected Authentication) for the connection.

Create or edit a Salesforce Events connection

A new Salesforce Events connection is created using the Salesforce Events connector from one of these locations:

An existing Salesforce Events connection can be edited from these locations:

Configure a Salesforce Events connection

Each user interface element of the Salesforce Events connection configuration screen is described below.

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a menu listing existing variables to choose from.

  • Connection name: Enter a name to use to identify the connection. The name must be unique for each Salesforce Events connection and must not contain forward slashes / or colons :. This name is also used to identify the Salesforce Events endpoint, which refers to both a specific connection and its activities.

  • Host: Enter the login URL of the Salesforce sandbox or production organization.

  • Authentication: Select the method of authentication to use to connect to Salesforce.

    • Username-Password: (Default.) Select this option to authenticate using a Salesforce username and password:

      • Username: Enter the username associated with the Salesforce account.

      • Password: Enter the password associated with the Salesforce account.

      • Security token: Enter the security token associated with the Salesforce account.

      • Consumer key: Enter the consumer key from the Salesforce connected app (see Prerequisites).

      • Consumer secret: Enter the consumer secret from the Salesforce connected app (see Prerequisites).

      • Grant type: Enter a grant type of password.

    • Client Credentials: Select this option to authenticate using the consumer key and secret from a Salesforce external client app or connected app (machine-to-machine authentication). Salesforce requires the OAuth 2.0 client credentials flow to use your organization's My Domain URL rather than the generic login server, so set Host above to a URL such as https://exampleDomain.my.salesforce.com instead of its default value:

      • Consumer key: Enter the consumer key from a Salesforce external client app or connected app configured for the OAuth 2.0 client credentials flow. For instructions on configuring the app and obtaining this value, see 2-legged OAuth 2.0 prerequisites for Salesforce-based connectors.

      • Consumer secret: Enter the consumer secret from the same Salesforce external client app or connected app.

    • JWT Bearer: Select this option to authenticate using a self-signed JWT assertion signed with a private key (server-to-server authentication that does not require a password):

      • Username: Enter the username associated with the Salesforce account.

      • Consumer key: Enter the consumer key from a Salesforce connected app configured for the OAuth 2.0 JWT bearer flow. For more information, see Salesforce's OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration documentation.

      • Private key: Enter the private key that corresponds to the digital certificate uploaded to the Salesforce connected app, in this format:

        -----BEGIN PRIVATE KEY-----

<private key>

-----END PRIVATE KEY-----

        Replace <private key> (including the angle brackets < >) with the appropriate value. A PKCS1 private key in the format -----BEGIN RSA PRIVATE KEY----- is also supported.

  • API version: Enter the Salesforce REST API version in numeric format (54, 56, etc.). By default, this field is prepopulated with version 63.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save changes: Click to save and close the connection configuration.

  • Discard changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Salesforce Events connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Subscribe Event: Receives a platform event or a CDC event from Salesforce and is intended to be used as a source in an operation.

  • Subscribe Insert CDC Event: Receives an insert CDC event from Salesforce and is intended to be used as a source in an operation.

  • Publish Event: Publishes a platform event in Salesforce and is intended to be used as a target in an operation.

  • Subscribe Update CDC Event: Receives an update CDC event from Salesforce and is intended to be used as a source in an operation.

  • Subscribe Delete CDC Event: Receives a delete CDC event from Salesforce and is intended to be used as a source in an operation.