Salesforce Connector (Source and Sink) for Confluent Platform

The Salesforce Connector integrates Salesforce.com with Apache Kafka® now includes both a sink connector and a source connector.

The Salesforce Source connector provides the capability to capture changes from Salesforce.com by way of Salesforce Streaming API PushTopics or Salesforce Enterprise Messaging Platform Events. PushTopics provide the ability to subscribe to create, update, delete, and undelete events related to Salesforce Objects (SObjects). Platform Events are user defined publish/subscribe events. CDC provides a way to monitor Salesforce records.

Note

The connector dynamically creates PushTopics if needed when the connector is launched. However, Platform Events must be pre-defined and published in Salesforce. More information on defining platform events and publishing platform events is available at Salesforce.com.

The Salesforce Sink connector provides the ability to consume Kafka topics and perform the corresponding create, update, delete, and upsert operations on Salesforce SObjects and publishing Platform Events.

Note

The Salesforce SObjects sink connector requires the Kafka records to have the same structure and format as the records output by the PushTopic source connector. Similarly, the Platform Events sink connector requires the Kafka records to have the same structure and format as the records output by the Platform Events source connector.

Install the Salesforce Connector

You can install this connector by using the instructions or you can manually download the ZIP file.

Install the connector using Confluent Hub

Prerequisite

Confluent Hub Client must be installed. This is installed by default with Confluent Enterprise.

Navigate to your Confluent Platform installation directory and run the following command to install the latest (latest) connector version. The connector must be installed on every machine where Connect will run.

confluent-hub install confluentinc/kafka-connect-salesforce:latest

You can install a specific version by replacing latest with a version number. For example:

confluent-hub install confluentinc/kafka-connect-salesforce:1.2.0

Install the connector manually

Download and extract the ZIP file for your connector and then follow the manual connector installation instructions.

License

You can use this connector for a 30-day trial period without a license key.

After 30 days, you must purchase a connector subscription which includes Confluent enterprise license keys to subscribers, along with enterprise-level support for Confluent Platform and your connectors. If you are a subscriber, you can contact Confluent Support at support@confluent.io for more information.

For license properties, see Confluent Platform license and for information about the license topic, see:

• Salesforce Platform Event Source connector license topic configuration
• Salesforce Platform Events Sink connector license topic configuration
• Salesforce Push Topic Source connector license topic configuration
• Salesforce SObject Sink connector license topic configuration
• Salesforce CDC Source connector license topic configuration

Configuration Properties

Refer to the specific Salesforce connector document for configuration properties.

For an example of how to get Kafka Connect connected to Confluent Cloud, see Connect Self-Managed Kafka Connect to Confluent Cloud.