# Salesforce SObject Sink Connector for Confluent Cloud The fully managed Salesforce SObject Sink connector for Confluent Cloud performs CRUD operations (create, update, delete, and insert) on Salesforce SObject using data available from Apache Kafka® topics. This connector can be thought of as the inverse of the Salesforce PushTopic Source connector because it can operate on data created from the Salesforce PushTopic Source connector. For example, there are two Salesforce.com organizations or Instances: Instance A and Instance B. A data engineer wants to synchronize Salesforce Lead objects from Instance A to Instance B. The engineer can configure and deploy the PushTopic Source connector to stream a Salesforce Lead from Instance A into a single Kafka topic, while the SObject Sink connector is configured to stream a Lead from the Kafka topic into Instance B. Depending upon the configuration, all changes to Lead SObject may be synchronized across organizations. #### NOTE * This Quick Start is for the fully managed Confluent Cloud connector. If you are installing the connector locally for Confluent Platform, see [Salesforce SObject Sink Connector for Confluent Platform](https://docs.confluent.io/kafka-connectors/salesforce/current/sobjects_sink/index.html). * If you require private networking for fully managed connectors, make sure to set up the proper networking beforehand. For more information, see [Manage Networking for Confluent Cloud Connectors](networking/internet-resource.md#clusters-connect-cloud). * The connector supports Salesforce up to API version 65.0. ## Features The Salesforce SObject Sink connector provides the following features: * **At least once delivery**: This connector guarantees that records from the Kafka topic are delivered at least once. * **Supports multiple tasks**: The connector supports running one or more tasks. More tasks may improve performance (that is, consumer lag is reduced with multiple tasks running). * **Automatically creates topics**: The following three topics are automatically created when the connector starts: - Success topic - Error topic - [Dead letter queue (DLQ) topic](dead-letter-queue.md#ccloud-dlq-topics) The suffix for each topic name is the connector’s logical ID. In the example below, there are the three connector topics and one pre-existing Kafka topic named pageviews.  If the records sent to the topic are not in the correct format, or if important fields are missing in the record, the errors are recorded in the error topic, and the connector continues to run. * **Supported data formats**: The connector supports Avro, JSON Schema (JSON-SR), and Protobuf input Kafka record value formats. [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use these Schema Registry-based formats. * **Supports Client Credentials flow**: The connector supports authentication using the Client Credentials flow that enables connecting to Salesforce without exposing the user credentials. To use `CLIENT_CREDENTIALS` grant type, you must enable the Client Credentials flow in your connected Salesforce application and assign an integration user. * **Supports OAuth 2.0 Authorization Code grant flow (BYOA)**: The connector supports authentication using the OAuth 2.0 Authorization Code grant flow with your own connected application or external client application (bring your own app), which helps you connect to Salesforce without exposing user credentials. To use the `OAUTH2_AUTH_CODE_BYOA` grant type, provide your application’s consumer key and consumer secret, then complete the authorization by clicking **Connect with Salesforce**. A shared application is not supported. * **Supports Salesforce External Client Apps (ECA)**: This connector supports Salesforce External Client Apps when using the `JWT_BEARER`, `OAUTH2_AUTH_CODE_BYOA`, or `CLIENT_CREDENTIALS` grant type. * **Supports Multiple SObjects**: The connector supports multiple SObjects (up to 5) in a single connector instance. You can select the number of SObjects to write to and configure them individually. You must configure the topics properly such that a single topic doesn’t contain the records for multiple SObjects and each selected topic must be mapped to some SObject. You must provide the SObject name and comma separated list of associated topics along with other configurations for each SObject. * **Supports batching**: The connector supports batching using the Collections API, including “All or None” processing. When “All or None” is set to `true`, entire batch fails if any record fails. When `false`, individual records can fail within a batch. Batches are created based on the operation type, object type and external field ID. For more information, see [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties). * **Tombstone records**: The connector supports configuring the behavior for tombstone records (Ignore, Fail, or Delete). If batching is enabled, deletion of tombstone records takes place after batch is processed to avoid inconsistencies. For more information, see [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties). * **Configurable null field handling**: The connector supports customizing how null field values are written to Salesforce using the `ignore.null.fields` property. When set to `true`, the connector ignores null fields and Salesforce retains the existing value of those fields. When set to `false` (the default), the connector sends null fields to Salesforce, clearing the corresponding field by setting it to `null`. This configuration applies to both batched and non-batched scenarios. For more information, see [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties). * **Supports Salesforce relationship fields**: The connector supports Salesforce relationship fields. For more information, see [Salesforce relationship fields](#salesforce-relationship-fields-sobject-sink). * **Client-side encryption (CSFLE and CSPE) support**: The connector supports CSFLE and CSPE for sensitive data. For more information about CSFLE or CSPE setup, see the [connector configuration](#cc-salesforce-sobjects-sink-connection). For more information and examples to use with the Confluent Cloud API for Connect, see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section. ## Salesforce relationship fields The connector supports Salesforce relationship fields, that allows you to integrate external data fields within Salesforce sObjects, enhancing data aggregation and business processes. This is useful for populating Lookup relationships using values from external systems (External IDs). #### NOTE This connector does not currently support polymorphic fields. ### Prerequisites - A Salesforce lookup field must already exist on your target sObject (for example, `RelatedAccount__c` pointing to the `Account` object). - The related object must have an indexed field or an External ID field (for example, `External_Account_ID__c`) to facilitate the relationship mapping. ### Process relationship fields Follow the steps below to process Salesforce relationship fields in your connector: #### Enable relationship field When you configure a sink connector, you must enable relationship field support. In your connector configuration, set the following parameters to `false`: * `"skip.object1.relationship.fields": "false"` * `"salesforce.object1.ignore.reference.fields": "false"` **Sample Configuration**: Below is a sample configuration for a sink connector targeting a custom object (`RelationshipDemo__c`) ```json { "config": { "topics": "RelationshipDemoTopic", "schema.context.name": "default", "input.data.format": "AVRO", "connector.class": "SalesforceSObjectSink", "name": "SalesforceSObjectSinkConnector_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "********************", "kafka.api.secret": "***********************", "salesforce.enable.batching": "false", "salesforce.grant.type": "CLIENT_CREDENTIALS", "salesforce.instance": "https://login.salesforce.com", "salesforce.consumer.key": "*************************************************************************************", "salesforce.consumer.secret": "****************************************************************", "salesforce.object.num": "1", "salesforce.object1": "RelationshipDemo__c", "salesforce.object1.override.event.type": "false", "salesforce.object1.sink.operation": "insert", "salesforce.object1.ignore.reference.fields": "false", "skip.object1.relationship.fields": "false", "salesforce.object1.use.custom.id.field": "false", "connection.timeout": "30000", "behavior.on.api.errors": "ignore", "request.max.retries.time.ms": "30000", "behavior.on.null.record": "fail", "max.poll.interval.ms": "300000", "max.poll.records": "500", "tasks.max": "1", "value.converter.value.schema.id.deserializer": "io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer", "value.converter.reference.subject.name.strategy": "DefaultReferenceSubjectNameStrategy", "errors.tolerance": "all", "value.converter.ignore.default.for.nullables": "false", "key.converter.key.schema.id.deserializer": "io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer", "value.converter.decimal.format": "BASE64", "value.converter.value.subject.name.strategy": "TopicNameStrategy", "key.converter.key.subject.name.strategy": "TopicNameStrategy", "auto.restart.on.user.error": "true" } } ``` #### Associated Avro schema for sink topic To use a relationship field, the Avro schema for the sink topic must define the relationship object (`RelatedAccount__r`) and the specific external field used for the lookup. In the schema below, `RelatedAccount__r` is used to resolve and populate the `RelatedAccount__c` field in Salesforce. The relationship field, `RelatedAccount__r`, is controlled by the external ID field, `External_Account_ID__c`. **Avro Schema:** The following schema defines the structure for the `RelationshipDemo__c` sink topic ```json { "connect.name": "io.confluent.salesforce.RelationshipDemo__c", "fields": [ { "name": "Id", "type": { "connect.doc": "Unique identifier for the object.", "type": "string" } }, { "default": null, "name": "OwnerId", "type": [ "null", "string" ] }, { "default": null, "name": "IsDeleted", "type": [ "null", "boolean" ] }, { "default": null, "name": "Name", "type": [ "null", "string" ] }, { "default": null, "name": "CreatedDate", "type": [ "null", { "connect.name": "org.apache.kafka.connect.data.Timestamp", "connect.version": 1, "logicalType": "timestamp-millis", "type": "long" } ] }, { "default": null, "name": "CreatedById", "type": [ "null", "string" ] }, { "default": null, "name": "LastModifiedDate", "type": [ "null", { "connect.name": "org.apache.kafka.connect.data.Timestamp", "connect.version": 1, "logicalType": "timestamp-millis", "type": "long" } ] }, { "default": null, "name": "LastModifiedById", "type": [ "null", "string" ] }, { "default": null, "name": "SystemModstamp", "type": [ "null", { "connect.name": "org.apache.kafka.connect.data.Timestamp", "connect.version": 1, "logicalType": "timestamp-millis", "type": "long" } ] }, { "default": null, "name": "LastViewedDate", "type": [ "null", { "connect.name": "org.apache.kafka.connect.data.Timestamp", "connect.version": 1, "logicalType": "timestamp-millis", "type": "long" } ] }, { "default": null, "name": "LastReferencedDate", "type": [ "null", { "connect.name": "org.apache.kafka.connect.data.Timestamp", "connect.version": 1, "logicalType": "timestamp-millis", "type": "long" } ] }, { "name": "RelatedAccount__r", "type": { "connect.name": "RelatedAccount__r", "fields": [ { "default": null, "name": "External_Account_ID__c", "type": [ "null", "string" ] } ], "name": "RelatedAccount__r", "type": "record" } }, { "default": null, "name": "_ObjectType", "type": [ "null", "string" ] }, { "default": null, "name": "_EventType", "type": [ "null", "string" ] } ], "name": "RelationshipDemo__c", "namespace": "io.confluent.salesforce", "type": "record" } ``` #### Sample sink record When sending records to the sink connector for `RelationshipDemo__c`, use the relationship field (`RelatedAccount__r`) to specify the external ID of the related record. ```json { "Id": "a00gL00000P85iUQAW", "OwnerId": { "string": "005gL000005tlt3QAA" }, "IsDeleted": { "boolean": false }, "Name": { "string": "DemoEntity" }, "CreatedDate": { "long": 1761736099000 }, "CreatedById": { "string": "005gL000005tlt3QAA" }, "LastModifiedDate": { "long": 1761736099000 }, "LastModifiedById": { "string": "005gL000005tlt3QAA" }, "SystemModstamp": { "long": 1761736099000 }, "LastViewedDate": null, "LastReferencedDate": null, "RelatedAccount__r": { "External_Account_ID__c": { "string": "123456" } }, "_ObjectType": { "string": "RelationshipDemo__c" }, "_EventType": { "string": "created" } } ``` Upon processing this record, a new `RelationshipDemo` sObject named `DemoEntity` is created. The connector automatically populates the `RelatedAccount__c` field with the `accountId` of the `DemoAccount` that matches the `External_Account_ID__c` value of `123456`. ### Common Issues and Resolutions | Issue | Potential Cause | Resolution | |---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Cannot specify both an external ID reference RelatedAccount__r and a salesforce id, RelatedAccount__c` | The record or schema includes both the lookup field (`__c`) and the relationship reference (`__r`). Salesforce requires only one identifier for sink operations. | Ensure the record schema uses only one field type. If source data is mixed, route different field types to separate topics for processing. | | `Field name provided, Name is not an External ID or indexed field for Account` | The field used to define the relationship is not an indexed or External ID field. | Use an indexed or External ID field when referencing relationships. Note that `idLookup` fields are only supported if the referenced field is the same object type as the parent; otherwise, use a field explicitly marked as an **External Id**. | ### **Auto-create missing parent records for relationship fields** By default, if the connector writes a child record whose parent record does not yet exist in Salesforce, Salesforce rejects the record. Whenever possible, avoid this by ensuring the parent record already exists in Salesforce before the connector sends the child record, for example, by ordering or staging the data upstream in your source system. When you cannot guarantee that order, that is, when a child record might reach Salesforce before its parent exists, you can configure a staging field together with a `before insert` Apex trigger. With this setup, Salesforce creates the missing parent record automatically and links the child record to it as the record is inserted. **Why a direct reference fails** A relationship field (`__r`) links a child record to a parent using the parent’s External ID. Salesforce resolves that reference in its API layer, before the record reaches the database. For example: ```json "RelatedAccount__r": { "External_Account_ID__c": "12345" } ``` If the referenced parent, `Account 12345` in this example, does not exist, the API layer rejects the record with `INVALID_FIELD` before it ever reaches the database. Because the record never reaches the database, any Apex trigger that could have created the parent never runs. **How the trigger creates the parent record** To avoid that validation failure, send the parent’s External ID in a plain text field instead of in the relationship field. This extra text field is a phantom field (a staging field). It carries no business meaning and exists only to move the External ID past the API layer’s validation. Salesforce does not validate a plain text field against the parent object, so the record passes API layer validation and reaches the database. From there, a `before insert` trigger reads that text field, creates the parent record if it does not already exist, and populates the real lookup field with the new parent’s Salesforce record ID before the record is saved. A lookup field requires an 18-character Salesforce record ID rather than text, so the trigger must resolve the External ID to that record ID before the record is saved. **Salesforce setup** On the child object (example: `RelationshipDemo__c`): * `RelatedAccount__c`: the lookup to the parent `Account` (the real relationship field). * `relationValue__c`: a Text (255-character) staging field that carries the parent’s External ID. This field has no business meaning of its own. Its only purpose is to pass the External ID to the trigger. * Your own data fields, for example `Name` (Text) and `ObjectNum__c` (Number). On the parent object (`Account`): * `External_Account_ID__c`: an indexed, unique External ID field. This workaround does not require relationship field support to be enabled. Because the External ID travels in a plain text field, `skip.objectN.relationship.fields` and `salesforce.objectN.ignore.reference.fields` can stay at their default values. **Record** For each child record, put the parent’s External ID in the staging field (`relationValue__c`) and leave the lookup field (`RelatedAccount__c`) empty. The trigger populates the lookup field. You can either omit the lookup field from the schema or include it with a null value. Both approaches work. #### IMPORTANT Do not send the `RelatedAccount__r` relationship object in the same record. That form is resolved in the API layer and fails before the trigger can run, which is the reason for the staging field. Any other reference field you include (for example, `OwnerId`) must carry a valid record ID or be left out of the schema entirely. The connector forwards null values, and Salesforce rejects a null reference field. ```json { "type": "record", "name": "RelationshipDemo__c", "namespace": "io.confluent.salesforce", "fields": [ { "name": "ObjectNum__c", "type": "double" }, { "name": "Name", "type": "string" }, { "name": "relationValue__c", "type": "string" } ] } ``` ```json { "ObjectNum__c": 123, "Name": "Global Nexus", "relationValue__c": "12345" } { "ObjectNum__c": 124, "Name": "Test Entity Two", "relationValue__c": "99988" } ``` **Apex trigger (for reference)** The following trigger runs only for SObject Sink transactions. For each batch, it reads the External IDs from the staging field, looks up which parent records already exist, and creates the ones that are missing. If two batches try to create the same parent record at the same time, the trigger re-queries for the record that the other batch committed instead of failing. It then links each child record to its parent, or fails the child record if its parent genuinely could not be created. ```java trigger RelationshipDemoTrigger on RelationshipDemo__c (before insert) { // 1. Run only for SObject Sink transactions. Allow Apex tests so the trigger is covered. if (System.Request.getCurrent().getQuiddity() != System.Quiddity.SYNCHRONOUS && !Test.isRunningTest()) { return; } // 2. Collect parent External IDs from the staging field. Set accountExtIds = new Set(); for (RelationshipDemo__c demo : Trigger.new) { if (String.isNotBlank(demo.relationValue__c) && demo.RelatedAccount__c == null) { accountExtIds.add(demo.relationValue__c); } } if (accountExtIds.isEmpty()) return; // 3. Find which parents already exist (single query). A lookup field needs a real // 18-character record Id, so resolve each External ID to its Account Id here. Map accountsByExtId = new Map(); for (Account acc : [SELECT Id, External_Account_ID__c FROM Account WHERE External_Account_ID__c IN :accountExtIds]) { accountsByExtId.put(acc.External_Account_ID__c, acc.Id); } // 4. Build placeholder parents for External IDs that do not exist yet. Map newAccounts = new Map(); for (String extId : accountExtIds) { if (!accountsByExtId.containsKey(extId)) { newAccounts.put(extId, new Account( External_Account_ID__c = extId, Name = ('Mock - ' + extId + ' - ' + System.now().getTime()).left(255), Description = 'Auto-generated via SObject Sink' )); } } // 5. Insert placeholders with partial success, and classify any failures: // - row lock / duplicate: a parallel batch is creating the same parent // (transient) -> recover by re-querying. // - any other error (for example, a validation rule): permanent -> fail the child. Set lockedExtIds = new Set(); Map failedExtIds = new Map(); if (!newAccounts.isEmpty()) { List toInsert = newAccounts.values(); Database.SaveResult[] results = Database.insert(toInsert, false); for (Integer i = 0; i < results.size(); i++) { Account acc = toInsert[i]; if (results[i].isSuccess()) { accountsByExtId.put(acc.External_Account_ID__c, results[i].getId()); } else { Database.Error err = results[i].getErrors()[0]; if (err.getStatusCode() == StatusCode.UNABLE_TO_LOCK_ROW || err.getStatusCode() == StatusCode.DUPLICATE_VALUE) { lockedExtIds.add(acc.External_Account_ID__c); } else { failedExtIds.put(acc.External_Account_ID__c, err.getMessage()); } } } } // 6. Re-query the locked ones: the winning batch has likely committed the parent. // Remove any we recover so lockedExtIds holds only those still unresolved. if (!lockedExtIds.isEmpty()) { for (Account acc : [SELECT Id, External_Account_ID__c FROM Account WHERE External_Account_ID__c IN :lockedExtIds]) { accountsByExtId.put(acc.External_Account_ID__c, acc.Id); lockedExtIds.remove(acc.External_Account_ID__c); } } // 7. Link each child, or decide how to fail it. for (RelationshipDemo__c demo : Trigger.new) { String extId = demo.relationValue__c; if (String.isBlank(extId) || demo.RelatedAccount__c != null) continue; if (accountsByExtId.containsKey(extId)) { // Parent resolved: link the child. demo.RelatedAccount__c = accountsByExtId.get(extId); } else if (failedExtIds.containsKey(extId)) { // Parent could not be created (permanent): fail this row visibly. demo.addError('Could not create parent Account for External ID ' + extId + ': ' + failedExtIds.get(extId)); } else if (lockedExtIds.contains(extId)) { // Transient lock: a competing batch has not committed yet. Insert the child // unlinked (orphan) and reconcile later rather than rejecting valid data. } } } ``` The guard clause restricts the logic to synchronous API transactions (and Apex tests), which is how this connector’s writes run. Unlike the Bulk API guard, `SYNCHRONOUS` also matches other synchronous API clients writing to the same object, so scope the trigger to objects the connector owns. All queries and DML run once per batch (bulkified) to stay within Salesforce governor limits. The last block encodes the intended failure policy: a row whose parent failed to be created for a real reason (for example, a validation rule) is failed with `addError()`, while a row blocked only by a transient lock from a competing batch is inserted unlinked and reconciled later, so valid data is never rejected over a temporary lock. ## Limitations Be sure to review the following information. * For connector limitations, see [Salesforce SObject Sink Connector](limits.md#salesforce-sobjects-sink-limits) limitations. * If you plan to use one or more Single Message Transformations (SMTs), see [SMT Limitations](single-message-transforms.md#cc-single-message-transforms-limitations). ## Set up Salesforce authentication #### IMPORTANT In accordance with the Salesforce Winter ‘27 release, Confluent will deprecate the OAuth 2.0 username-password flow (`salesforce.grant.type=PASSWORD`) for Salesforce connectors effective September 15, 2026. Update your connector configurations to use another supported auth grant type. Salesforce connectors authenticate with Salesforce through a connected application or External Client App (ECA). A connected application is a metadata object in Salesforce that defines the protocol (OAuth), the permissions (scopes), and the security policies (for example, IP relaxation and user authorization) for an external application. The consumer key (client ID) and consumer secret (client secret) that you enter in the connector configuration are the credentials of this connected application. The connector supports the following OAuth 2.0 grant types. You select the grant type using the `salesforce.grant.type` configuration property. - `CLIENT_CREDENTIALS`: The connector authenticates with only the consumer key and consumer secret of the connected application. User credentials are not transmitted. - `JWT_BEARER`: The connector authenticates with a JSON Web Token (JWT) signed with a private key. - `OAUTH2_AUTH_CODE_BYOA`: The connector uses the OAuth 2.0 authorization code flow with an application you create and own in your Salesforce org (bring your own application, or BYOA). Confluent Cloud stores a refresh token issued during a one-time browser authorization and uses it to obtain access tokens at runtime. ### Client Credentials flow The OAuth 2.0 Client Credentials flow enables the connector to connect to Salesforce without exposing user credentials. Salesforce requires an execution user (the **Run As** user) for this flow. If no Run As user is defined in the connected application policies, authentication fails with an `invalid_grant` or `no client credentials user enabled` error. #### Configure Salesforce Complete the following steps in Salesforce before you create the connector. 1. Enable the client credentials flow: 1. If you don’t already have a connected application for the connector, enable connected app creation first. Navigate to **Setup > External Client App Settings** and enable **Allow creation of connected apps**. This setting is hidden by default in new Salesforce organizations. 2. Navigate to **Setup > App Manager**. 3. Locate the connected application used for the connector, click the drop-down arrow, and select **Edit**. 4. Under **API (Enable OAuth Settings)**, select **Enable Client Credentials Flow**. This option is often disabled by default for older applications. 5. Save the application definition. 2. Assign the execution user: 1. Navigate to **Setup > Manage Connected Apps**, which is distinct from **App Manager**. 2. Click the name of the connected application. 3. Click **Edit Policies**. 4. Scroll to the **Client Credentials Flow** section. 5. In **Run As**, click the search icon and select the dedicated integration user (for example, `integration.user@example.com`). The Run As user must have the **API Enabled** permission and enough rights to access the objects the connector reads from or writes to. #### Configure the connector Set the following authentication properties in the connector configuration. | Configuration property | Value | Notes | |------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| | `salesforce.grant.type` | `CLIENT_CREDENTIALS` | Select this grant type explicitly. | | `salesforce.consumer.key` | Consumer key of the connected application. | Also called the client ID. | | `salesforce.consumer.secret` | Consumer secret of the connected application. | Also called the client secret. | | `salesforce.instance` | `https://.my.salesforce.com` | You must use your My Domain URL. The default value
`https://login.salesforce.com` does not work for this grant type. | | `salesforce.username` | Not used. | The execution user is defined in Salesforce. | | `salesforce.password` | Not used. | The execution user is defined in Salesforce. | The client credentials flow requires your My Domain URL, for example, `https://.my.salesforce.com`, in the `salesforce.instance` property. When a client credentials request is sent to the generic `https://login.salesforce.com` endpoint, the Salesforce global router might fail to identify the tenant-specific policies required to look up the Run As user mapping, and authentication fails. ### JWT Bearer flow The OAuth 2.0 JWT bearer flow establishes trust through public-key cryptography and is the recommended authentication method for production environments. The connector signs a JWT with its private key, identifying the Salesforce user in the `sub` (subject) claim. Salesforce validates the signature using the public certificate uploaded to the connected application and issues an access token. The flow requires no interactive login or password, and is not affected by password expiration policies. #### Configure JWT Bearer Complete the following steps to configure the JWT bearer flow. 1. **Generate a private key and certificate**: Generate a private key and a self-signed certificate using OpenSSL. The following example sets the certificate validity to 3,650 days (10 years) to reduce maintenance overhead. ```bash openssl req -newkey rsa:2048 -nodes -keyout private.key -x509 \ -days 3650 -out public.crt ``` The command generates the following files: - `private.key`: The private key the connector uses to sign the JWT. - `public.crt`: The public certificate you upload to Salesforce. 2. **Create the Java keystore (JKS)**: The connector requires the private key in a JKS container and cannot read the raw PEM files directly. 1. Convert the certificate and private key to PKCS12 format: ```bash openssl pkcs12 -export -in public.crt -inkey private.key \ -out keystore.p12 -name salesforce-cert ``` You are prompted to create an export password. This password becomes the keystore password used in the connector configuration. 2. Import the PKCS12 file into a JKS keystore: ```bash keytool -importkeystore -srckeystore keystore.p12 \ -srcstoretype pkcs12 -destkeystore salesforce.jks \ -deststoretype JKS ``` Upload the resulting `salesforce.jks` file when you configure the connector. #### Configure the Salesforce connected application Complete the following steps in Salesforce before you create the connector. 1. If you don’t already have a connected application for the connector, enable connected app creation first. Navigate to **Setup > External Client App Settings** and enable **Allow creation of connected apps**. This setting is hidden by default in new Salesforce organizations. 2. Navigate to **Setup > App Manager** and edit the connected application used for the connector. 3. Under **API (Enable OAuth Settings)**, select **Use digital signatures**, click **Choose File**, and upload the `public.crt` file. 4. Ensure the `api`, `refresh_token`, and `offline_access` OAuth scopes are selected. 5. Pre-authorize users. Navigate to **Setup > Manage Connected Apps**, click **Edit Policies**, and change **Permitted Users** to **Admin approved users are pre-authorized**. The JWT Bearer flow is automated, and the connector cannot approve a consent screen, so you must be pre-authorized. 6. Assign profiles. In **Manage Connected Apps**, scroll to **Profiles** (or **Permission Sets**) and add the profile of the integration user, for example, a custom integration profile. #### Configure the connector Set the following authentication properties in the connector configuration. | Configuration property | Value | Notes | |------------------------------------|--------------------------------------------|----------------------------------------------------------------------------------------------| | `salesforce.grant.type` | `JWT_BEARER` | Select this grant type explicitly. | | `salesforce.consumer.key` | Consumer key of the connected application. | Also called the client ID. | | `salesforce.username` | Username of the integration user | Sets the `sub` claim of the JWT. The username must match a user
in the assigned profile. | | `salesforce.jwt.keystore.file` | The `salesforce.jks` file | Upload the file when you configure the connector. | | `salesforce.jwt.keystore.password` | Keystore password | The export password set during the PKCS12 conversion. | | `salesforce.instance` | `https://.my.salesforce.com` | Use your My Domain URL for best results. | | `salesforce.password` | Not used | Not required for this grant type. | | `salesforce.consumer.secret` | Not used | The signed JWT replaces the consumer secret. | ### Authorization Code flow (Bring your own application) The OAuth 2.0 authorization code flow (also called the web server flow) lets the connector access Salesforce on behalf of a user without storing the user’s password. In the bring your own application (BYOA) model, you create and own the application in your Salesforce org, authorize the connector once in a browser, and Salesforce issues a refresh token that Confluent Cloud stores and uses to obtain access tokens automatically. As of Salesforce Spring ‘26, create an ECA instead of a new connected application; existing connected applications continue to work. #### Configure the Salesforce application Complete the following steps in Salesforce before you create the connector. 1. Enable OAuth and set the callback URL: 1. Navigate to **Setup > App Manager** to edit an existing connected application, or **Setup > External Client App Manager > New External Client App** to create a new application. 2. Under **API (Enable OAuth Settings)**, select **Enable OAuth Settings**. 3. In **Callback URL**, enter `https://confluent.cloud/api/connect/oauth/callback`. 2. Select the OAuth scopes: 1. **Manage user data via APIs** (`api`). 2. **Perform requests at any time** (`refresh_token`, `offline_access`). 3. Enable the web server flow. For an ECA, under **Flow Enablement**, select **Enable Authorization Code and Credentials Flow**. 4. Set the OAuth security policies: 1. Select **Require Secret for Web Server Flow**. 2. Select **Require Secret for Refresh Token Flow**. 3. Disable **Require Proof Key for Code Exchange (PKCE)**. 4. Disable **Enable Refresh Token Rotation**. Rotation would invalidate the token and the connector would require manual re-authorization. 5. Configure the refresh token policy so the token does not expire immediately. Preferably set the refresh token policy to **Valid Until Revoked** to avoid manual re-authorization on token expiry. #### Configure the connector Set the following authentication properties in the connector configuration. | Configuration property | Value | Notes | |------------------------------|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------| | `salesforce.grant.type` | `OAUTH2_AUTH_CODE_BYOA` | Select this grant type explicitly. | | `salesforce.consumer.key` | Consumer key of the application. | Also called the client ID. | | `salesforce.consumer.secret` | Consumer secret of the application. | Also called the client secret. | | `salesforce.instance` | `https://login.salesforce.com` (production) or
`https://test.salesforce.com` (sandbox). | Using your My Domain URL is recommended, but the default URLs
also work. | #### Authorize the connector Click **Connect with Salesforce**, then complete the Salesforce login and consent prompt. Salesforce redirects back to Confluent Cloud, which stores the refresh token. You can then continue and launch the connector. ### Troubleshoot authentication errors The following table lists common authentication errors and how to resolve them. | Error | Grant type | Probable cause | Resolution | |-------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `invalid_grant` | `CLIENT_CREDENTIALS` | No Run As user is defined for the connected application. | Define the execution user in the connected application policies. | | `invalid_grant` | `CLIENT_CREDENTIALS` | Wrong instance URL. | Set `salesforce.instance` to your My Domain URL. | | `invalid_app_access` | `CLIENT_CREDENTIALS` | The user is not admin-approved to access the connected application. | In **Manage Connected Apps**, open the connected application, click
**Manage Profiles**, and add the profile of the integration user. | | `invalid_client` | All grant types | Wrong consumer key or consumer secret. | Verify the consumer key and consumer secret. Check for trailing
spaces. | | `invalid_grant: audience is invalid` | `JWT_BEARER` | Wrong audience in the JWT claim. | Ensure `salesforce.instance` matches the audience Salesforce
expects, which is typically your My Domain URL. | | `ConnectException: Connection refused` | All grant types | The network blocks the connection. | Check firewall and proxy settings, and verify that the Salesforce
URL is reachable. | | `400 Bad Request` | `CLIENT_CREDENTIALS` | The Client Credentials flow is disabled for the connected application. | In **App Manager**, edit the connected application and select **Enable
Client Credentials Flow**. | | `Job creation failed` | All grant types | The integration user has insufficient permissions. | Grant the integration user the **API Enabled** permission and
create and read permissions on the target objects. | | `invalid_grant` (“expired access/refresh token”) | `OAUTH2_AUTH_CODE_BYOA` | The refresh token expired, was revoked, or was rotated. | Manually re-authorize with **Connect with Salesforce**, and
preferably set the refresh token policy to **Valid Until Revoked**
and disable refresh token rotation. | | `invalid_grant` (“expired access/refresh token”) on a connector
that was previously working | `OAUTH2_AUTH_CODE_BYOA` | Salesforce allows only five unique OAuth approvals per user per
connected application. Each refresh token counts as an approval, and a new
approval beyond the limit revokes the oldest. Sharing one
Salesforce user and connected application across multiple connectors (or
re-authorizing repeatedly) exhausts this limit and revokes an
older connector’s refresh token. | Use a dedicated Salesforce user for each connector (a shared
connected application is fine as long as the user differs), and avoid
unnecessary re-authorizations. Then re-authorize the affected
connector with **Connect with Salesforce**. For more information,
see Salesforce’s [Manage OAuth-Enabled Connected Apps’ Access](https://help.salesforce.com/s/articleView?id=xcloud.remoteaccess_request_manage.htm&type=5)
documentation. | ## Quick Start Use this quick start to get up and running with the Confluent Cloud Salesforce SObject Sink connector. The quick start provides the basics of selecting the connector and configuring it to stream events Prerequisites : - Authorized access to a [Confluent Cloud](https://www.confluent.io/confluent-cloud/) cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud. - An authorized Salesforce user and credentials for the connector. - The Confluent CLI installed and configured for the cluster. See [Install the Confluent CLI](https://docs.confluent.io/confluent-cli/current/install.html). - [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). - At least one source Kafka topic must exist in your Confluent Cloud cluster before creating the sink connector. ### Using the Confluent Cloud Console #### Step 1: Launch your Confluent Cloud cluster To create and launch a Kafka cluster in Confluent Cloud, see [Create a kafka cluster in Confluent Cloud](../get-started/index.md#cloud-create-kafka-cluster). #### Step 2: Add a connector In the left navigation menu, click **Connectors**. If you already have connectors in your cluster, click **+ Add connector**. #### Step 3: Select your connector Click the **Salesforce SObject Sink** connector card.  #### Step 4: Enter the connector details #### NOTE * Ensure you have all your [prerequisites](#cc-salesforce-sobjects-sink-prereqs) completed. * An asterisk ( \* ) designates a required entry. At the **Add Salesforce SObject Sink Connector** screen, complete the following: ### Topic selection If you’ve already populated your Kafka topics, select the topics you want to connect from the **Topics** list. To create a new topic, click **+Add new topic**. ### Kafka access 1. Select the way you want to provide **Kafka Cluster credentials**. You can choose one of the following options: - **My account**: This setting allows your connector to globally access everything that you have access to. With a user account, the connector uses an API key and secret to access the Kafka cluster. This option is not recommended for production. - **Service account**: This setting limits the access for your connector by using a [service account](service-account.md#s3-cloud-service-account). This option is recommended for production. - **Use an existing API key**: This setting allows you to specify an API key and a secret pair. You can use an existing pair or create a new one. This method is not recommended for production environments. #### NOTE Freight clusters support only service accounts for Kafka authentication. 2. Click **Continue**. ### Authentication 1. Configure the authentication properties: - **Salesforce grant type**: Sets the authentication grant type to `PASSWORD` , `JWT_BEARER` ([Salesforce JSON Web Token (JWT)](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_jwt_flow.htm&type=5)) or `CLIENT_CREDENTIALS`. Defaults to `PASSWORD`. **Salesforce details** - **Salesforce instance**: The URL of the Salesforce endpoint to use. The default is [https://login.salesforce.com](https://login.salesforce.com). This directs the connector to use the endpoint specified in the authentication response. - **Salesforce username**: The Salesforce username for the connector to use. - **Salesforce password**: The Salesforce password for the connector to use. - **Salesforce password token**: The Salesforce security token associated with the username. - **Salesforce consumer key**: The consumer key for the OAuth application. - **Salesforce consumer secret**: The consumer secret for the OAuth application. - **Salesforce JWT keystore file**: If using the grant type `JWT_BEARER`, upload the JWT keystore file. - **Salesforce JWT keystore password**: The password used to access the JWT keystore file. #### NOTE The following properties are used based on the **Salesforce grant type** you choose. - `JWT_BEARER`: Requires username, consumer key, JWT keystore file, and JWT keystore password. - `PASSWORD`: Requires username, password, password token, consumer key, and consumer secret. - `CLIENT_CREDENTIALS`: Requires the client ID and client secret of a Salesforce connected application as the consumer key and consumer secret, and the Salesforce domain URL in the Salesforce instance option. The default value [https://login.salesforce.com](https://login.salesforce.com) does not work for this option. To use `CLIENT_CREDENTIALS`, you must enable the Client Credentials flow in your connected Salesforce application and assign an integration user. - `OAUTH2_AUTH_CODE_BYOA`: Requires consumer key and consumer secret (the consumer key and consumer secret of your Salesforce connected application or external client application). After you enter these values, complete the authorization by clicking **Connect with Salesforce** to perform the OAuth 2.0 handshake and store the refresh token. Only bring your own application (BYOA) is supported. A shared application is not supported. Confluent recommends using the My Domain URL, although the default URLs also work. 2. Click **Continue**. ### Configuration #### NOTE Configuration properties that are not shown in the Cloud Console use the default values. See [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties) for all property values and definitions. - **Input Kafka record value format**: Select the input Kafka record value format (data coming from the Kafka topic). Valid values are AVRO, JSON_SR, or PROTOBUF. A valid schema must be available in [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) to use a schema-based message format (for example, Avro, JSON Schema, or Protobuf). - **Number of salesforce objects**: The number of Salesforce objects to write to. This is used when multiple SObjects are enabled. **Batching configurations** - **Enable Batching**: Enables batching support. - **Batch Size**: The maximum number of records to send in a single batch to Salesforce (only applicable if batching is enabled). - **All Or None**: Enables All Or None functionality while batching. When true, the entire batch fails if any record fails. When false, individual records can fail within a batch. **Object 1 configuration** - **Salesforce SObject1 Name**: The Salesforce SObject1 to write to. - **Salesforce SObject1 Topics**: The comma-separated list of topics associated with Salesforce SObject1. - **Salesforce SObject1 Override**: A flag to indicate that the Kafka SObject1 source record EventType (create, update, delete) is overridden to use the operation specified in the SObject1 override operation field. - **Salesforce SObject1 Override Operation**: The Salesforce sink operation to perform on the SObject1. One of: insert, update, upsert, delete. Default is insert. This feature works if `override.event.type` is true. - **Salesforce SObject1 Ignore Fields**: The comma-separated list of fields from the source Kafka record to ignore when pushing a record into Salesforce. - **Salesforce SObject1 Ignore Reference Fields**: A flag to prevent reference type fields from being updated or inserted in Salesforce SObjects. - **Skip SObject1 Relationship Fields**: If set to `true`, skips relationship fields when updating or inserting records in Salesforce SObjects. - **Salesforce SObject1 Use Custom Field**: A flag to use a custom external ID field in SObjects. - **Salesforce SObject1 Custom Field Name**: The name of a custom external ID field in SObject to structure REST API calls for insert, upsert, delete, and update operations. **Data decryption** - Enable **Client-Side Field Level Encryption** for data decryption. Specify a **Service Account** to access the Schema Registry and associated encryption rules or keys with that schema. Select the connector behavior (`ERROR` or `NONE`) on data decryption failure. If set to `ERROR`, the connector fails and writes the encrypted data in the DLQ. If set to `NONE`, the connector writes the encrypted data in the target system without decryption. For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](csfle.md#connect-csfle). ### **Show other configurations** - **Schema context**: Select a schema context to use for this connector, if using a schema-based data format. This property defaults to the **Default** context, which configures the connector to use the default schema set up for Schema Registry in your Confluent Cloud environment. A schema context allows you to use separate schemas (like schema sub-registries) tied to topics in different Kafka clusters that share the same Schema Registry environment. For example, if you select a non-default context, a **Source** connector uses only that schema context to register a schema and a **Sink** connector uses only that schema context to read from. For more information about setting up a schema context, see [What are schema contexts and when should you use them?](../sr/faqs-cc.md#faq-schema-contexts). - **Connection timeout**: The amount of time to wait in milliseconds when connecting to the Salesforce endpoint. - **Behavior on API errors**: The error handling behavior configuration for any API errors. - **Behavior on null record**: The error handling behavior configuration for null records. - **Ignore null fields**: Specifies whether `null` field values are sent or not sent to Salesforce. When set to `true`, `null` field values are not sent and corresponding Salesforce fields retain the existing value. When set to `false`, `null` field values are sent and the corresponding Salesforce fields get cleared. Defaults to `false`. **Additional Configs** - **Value Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for values. The deserializer reads schema IDs from message headers. - **Value Converter Reference Subject Name Strategy**: Sets the subject reference name strategy for values. Valid entries are `DefaultReferenceSubjectNameStrategy` or `QualifiedReferenceSubjectNameStrategy`. You can use this strategy only with `PROTOBUF` format; the default strategy is `DefaultReferenceSubjectNameStrategy`. - **Schema ID For Value Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`. - **errors.tolerance**: Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records. - **value.converter.ignore.default.for.nullables**: When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF and JSON_SR Converters. - **Key Converter Schema ID Deserializer**: Sets the class name of the schema ID deserializer for keys. The deserializer reads schema IDs from message headers. - **Value Converter Decimal Format**: Specifies the `JSON` or `JSON_SR` serialization format for Connect `DECIMAL` logical type values with two allowed literals: `BASE64` to serialize `DECIMAL` logical types as base64 encoded binary data, and `NUMERIC` to serialize `DECIMAL` logical type values in `JSON` or `JSON_SR` as a number representing the decimal value. - **Schema GUID For Key Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`. - **Schema GUID For Value Converter**: Sets the schema GUID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema GUID for deserializing message values. This property is applicable only when `value.converter.value.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`. - **Value Converter Connect Meta Data**: Enables the Connect converter to add its metadata to the output schema. Applies to Avro converters. - **Value Converter Value Subject Name Strategy**: Determines how to construct the subject name under which the value schema is registered with Schema Registry. - **Key Converter Key Subject Name Strategy**: Determines how to construct the subject name for key schema registration. - **Schema ID For Key Converter**: Sets the schema ID to use for deserialization when using `ConfigSchemaIdDeserializer`. This lets you specify a fixed schema ID for deserializing message keys. This property is applicable only when `key.converter.key.schema.id.deserializer` is set to `ConfigSchemaIdDeserializer`. **Auto-restart policy** - **Enable Connector Auto-restart**: Enables the auto-restart behavior of the connector and its task in the event of user-actionable errors. Defaults to `true`, enabling the connector to automatically restart in case of user-actionable errors. Set this property to `false` to disable auto-restart for failed connectors. If disabled, you must manually restart the connector. **Consumer configuration** - **Max poll interval(ms)**: Sets the maximum delay between subsequent consume requests to Kafka. Use this property to improve connector performance in cases when the connector cannot send records to the sink system. The default is 300,000 milliseconds (5 minutes). - **Max poll records**: Sets the maximum number of records to consume from Kafka in a single request. Use this property to improve connector performance in cases when the connector cannot send records to the sink system. The default is 500 records. **Connection details** - **Max retry time (ms)**: Maximum time in milliseconds until the connector stops retrying failed Salesforce requests. Default is `30000` and minimum is `1000`. **Transforms** - **Single Message Transformations**: To add a new SMT, see [Add transforms](single-message-transforms.md#cc-single-message-transforms-ui). For more information about unsupported SMTs, see [Unsupported transformations](single-message-transforms.md#cc-single-message-transforms-unsupported-transforms). **Processing position** - **Set offsets**: Click **Set offsets** to define a specific offset for this connector to begin procession data from. For more information on managing offsets, see [Manage offsets](offsets.md#connect-custom-offsets). See [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties) for all property values and definitions. - Click **Continue**. ### Sizing Based on the number of topic partitions you select, you will be provided with a recommended number of tasks. 1. To change the number of recommended tasks, enter the number of [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use in the **Tasks** field. 2. Click **Continue**. ### Review and Launch 1. Verify the connection details. 2. Click **Launch**. The status for the connector should go from **Provisioning** to **Running**. #### Step 5: Check for records Verify that records are being produced at the endpoint. For more information and examples to use with the Confluent Cloud API for Connect, see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section. ### Using the Confluent CLI Complete the following steps to set up and run the connector using the Confluent CLI. #### NOTE Make sure you have all your [prerequisites](#cc-salesforce-sobjects-sink-prereqs) completed. #### Step 1: List the available connectors Enter the following command to list available connectors: ```none confluent connect plugin list ``` #### Step 2: List the connector configuration properties Enter the following command to show the connector configuration properties: ```none confluent connect plugin describe ``` The command output shows the required and optional configuration properties. #### Step 3: Create the connector configuration file Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties for a single SObject. ```json { "connector.class": "SalesforceSObjectSink", "input.data.format": "AVRO", "name": "SalesforceSObjectSinkConnector_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "", "kafka.api.secret": "", "salesforce.grant.type": "PASSWORD", "salesforce.instance": "https://login.salesforce.com", "salesforce.username": "", "salesforce.password": "", "salesforce.password.token": "", "salesforce.consumer.key": "", "salesforce.consumer.secret": "", "salesforce.enable.batching": "false", "salesforce.object.num": "1", "salesforce.object1": "", "tasks.max": "1", "topics": "orders" } ``` Note the following property definitions: * `"connector.class"`: Identifies the connector plugin name. * `"input.data.format"`: Sets the input Kafka record value format (data coming from the Kafka topic). Valid entries are **AVRO**, **JSON_SR**, and **PROTOBUF**. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). * `"name"`: Sets a name for your new connector. * `"kafka.auth.mode"`: Identifies the connector authentication mode you want to use. There are two options: `SERVICE_ACCOUNT` or `KAFKA_API_KEY` (the default). To use an API key and secret, specify the configuration properties `kafka.api.key` and `kafka.api.secret`, as shown in the example configuration (above). To use a [service account](service-account.md#s3-cloud-service-account), specify the **Resource ID** in the property `kafka.service.account.id=`. To list the available service account resource IDs, use the following command: ```bash confluent iam service-account list ``` For example: ```bash confluent iam service-account list Id | Resource ID | Name | Description +---------+-------------+-------------------+------------------- 123456 | sa-l1r23m | sa-1 | Service account 1 789101 | sa-l4d56p | sa-2 | Service account 2 ``` * `"salesforce.grant.type"`: Sets the authentication grant type to `PASSWORD` (username+password) , `JWT_BEARER` ([Salesforce JSON Web Token (JWT)](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_jwt_flow.htm&type=5)) or `CLIENT_CREDENTIALS`. Defaults to `PASSWORD`. #### NOTE The following properties are used based on the **Salesforce grant type** you choose. - `JWT_BEARER`: Requires username, consumer key, JWT keystore file, and JWT keystore password. - `PASSWORD`: Requires username, password, password token, consumer key, and consumer secret. - `CLIENT_CREDENTIALS`: Requires the client ID and client secret of a Salesforce connected application as the consumer key and consumer secret, and the Salesforce domain URL in the Salesforce instance option. The default value [https://login.salesforce.com](https://login.salesforce.com) does not work for this option. To use `CLIENT_CREDENTIALS`, you must enable the Client Credentials flow in your connected Salesforce application and assign an integration user. - `OAUTH2_AUTH_CODE_BYOA`: Requires consumer key and consumer secret (the consumer key and consumer secret of your Salesforce connected application or external client application). After you enter these values, complete the authorization by clicking **Connect with Salesforce** to perform the OAuth 2.0 handshake and store the refresh token. Only bring your own application (BYOA) is supported. A shared application is not supported. Confluent recommends using the My Domain URL, although the default URLs also work. * `"salesforce.username"`: The Salesforce username for the connector to use. * `"salesforce.password"`: The Salesforce username password. * `"salesforce.password.token"`: The Salesforce security token associated with the username. * `"salesforce.consumer.key"`: The consumer key for the OAuth application. * `"salesforce.consumer.secret"`: The consumer secret for the OAuth application. * `"salesforce.jwt.keystore.file"`: Salesforce JWT keystore file. The JWT keystore file is a binary file and you supply the contents of the file in the property encoded in Base64. To use the `salesforce.jwt.keystore.file` property, encode the keystore contents in Base64, take the encoded string, add the `data:text/plain:base64` prefix, and then use the entire string as the property entry. For example: ```properties "salesforce.jwt.keystore.file" : "data:text/plain;base64,/u3+7QAAAAIAAAACAAAAGY2xpZ...==", "salesforce.jwt.keystore.password" : "", ``` * `"salesforce.jwt.keystore.password"`: Enter the password used to access the JWT keystore file. * `"salesforce.object1"`: Enter the SObject1 name to write to. * `"tasks.max"`: Enter the maximum number of [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use. More tasks may improve performance (that is, consumer lag is reduced with multiple tasks running). * `"topics"`: Enter the topic name or a comma-separated list of topic names associated with the SObject1. The following example shows the required connector properties for two SObjects- ```json { "connector.class": "SalesforceSObjectSink", "input.data.format": "AVRO", "name": "SalesforceSObjectSinkConnector_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "", "kafka.api.secret": "", "salesforce.grant.type": "PASSWORD", "salesforce.instance": "https://login.salesforce.com", "salesforce.username": "", "salesforce.password": "", "salesforce.password.token": "", "salesforce.consumer.key": "", "salesforce.consumer.secret": "", "salesforce.enable.batching": "false", "salesforce.object.num": "2", "salesforce.object1": "", "salesforce.object1.topics": "", "salesforce.object2": "", "salesforce.object2.topics": "", "tasks.max": "1" } ``` #### NOTE To enable CSFLE or CSPE for data encryption, specify the following properties: * `csfle.enabled`: Flag to indicate whether the connector honors CSFLE or CSPE rules. * `sr.service.account.id`: A Service Account to access the Schema Registry and associated encryption rules or keys with that schema. * `csfle.onFailure`: Configures the connector behavior (`ERROR` or `NONE`) on data decryption failure. If set to `ERROR`, the connector fails and writes the encrypted data in the DLQ. If set to `NONE`, the connector writes the encrypted data in the target system without decryption. When using CSFLE or CSPE with connectors that route failed messages to a Dead Letter Queue (DLQ), be aware that data sent to the DLQ is written in unencrypted plaintext. This poses a significant security risk as sensitive data that should be encrypted may be exposed in the DLQ. Do not use DLQ with CSFLE or CSPE in the current version. If you need error handling for CSFLE- or CSPE-enabled data, use alternative approaches such as: * Setting the connector behavior to `ERROR` to throw exceptions instead of routing to DLQ * Implementing custom error handling in your applications * Using `NONE` to pass encrypted data through without decryption For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](csfle.md#connect-csfle). **SMTs**: For details about adding SMTs using the Confluent CLI, see the [Single Message Transformations](single-message-transforms.md#cc-single-message-transforms) documentation. See [Configuration Properties](#cc-salesforce-sobjects-sink-config-properties) for all property values and descriptions. #### Step 4: Load the properties file and create the connector Enter the following command to load the configuration and start the connector: ```none confluent connect cluster create --config-file .json ``` For example: ```none confluent connect cluster create --config-file salesforce-SObject-sink-config.json ``` Example output: ```none Created connector SalesforceSObjectSinkConnector_0 lcc-do6vzd ``` #### Step 5: Check the connector status Enter the following command to check the connector status: ```none confluent connect cluster list ``` Example output: ```none ID | Name | Status | Type | Trace +------------+----------------------------------+---------+------+-------+ lcc-do6vzd | SalesforceSObjectSinkConnector_0 | RUNNING | sink | | ``` #### Step 6: Check for records. Verify that records are populating the endpoint. For more information and examples to use with the Confluent Cloud API for Connect, see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section. ## Configuration Properties Use the following configuration properties with the fully managed connector. For self-managed connector property definitions and other details, see the connector docs in [Self-managed connectors for Confluent Platform](/platform/current/connect/kafka_connectors.html). ### Which topics do you want to get data from? `topics.regex` : A regular expression that matches the names of the topics to consume from. This is useful when you want to consume from multiple topics that match a certain pattern without having to list them all individually.
* Type: string * Importance: low `topics` : Identifies the topic name or a comma-separated list of topic names.
* Type: list * Importance: high `errors.deadletterqueue.topic.name` : The name of the topic to be used as the dead letter queue (DLQ) for messages that result in an error when processed by this sink connector, or its transformations or converters. Defaults to ‘dlq-${connector}’ if not set. The DLQ topic will be created automatically if it does not exist. You can provide `${connector}` in the value to use it as a placeholder for the logical cluster ID.
* Type: string * Default: dlq-${connector} * Importance: low `reporter.result.topic.name` : The name of the topic to produce records to after successfully processing a sink record. Defaults to ‘success-${connector}’ if not set. You can provide `${connector}` in the value to use it as a placeholder for the logical cluster ID.
* Type: string * Default: success-${connector} * Importance: low `reporter.error.topic.name` : The name of the topic to produce records to after each unsuccessful record sink attempt. Defaults to ‘error-${connector}’ if not set. You can provide `${connector}` in the value to use it as a placeholder for the logical cluster ID.
* Type: string * Default: error-${connector} * Importance: low ### Schema Config `schema.context.name` : Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.
* Type: string * Default: default * Importance: medium ### Input messages `input.data.format` : Sets the input Kafka record value format. Valid entries are AVRO, JSON_SR and PROTOBUF. Note that you need to have Confluent Cloud Schema Registry configured
* Type: string * Importance: high ### How should we connect to your data? `name` : Sets a name for your connector.
* Type: string * Valid Values: A string at most 64 characters long * Importance: high ### Kafka Cluster credentials `kafka.auth.mode` : Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode, whenever possible.
* Type: string * Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY * Importance: high `kafka.api.key` : Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.
* Type: password * Importance: high `kafka.service.account.id` : The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.
* Type: string * Importance: high `kafka.api.secret` : Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.
* Type: password * Importance: high ### Batching configurations `salesforce.enable.batching` : Enable Batching Support
* Type: boolean * Default: false * Importance: high `salesforce.batch.size` : Max number of records to send in a single batch to Salesforce (only applicable if batching is enabled)
* Type: int * Default: 200 * Valid Values: [1,…,200] * Importance: high `salesforce.all.or.none` : To enable All Or None functionality while batching. When true, entire batch fails if any record fails. When false, individual records can fail within a batch.
* Type: boolean * Default: false * Importance: high ### How should we connect to Salesforce? `salesforce.grant.type` : Grant type the connector uses for Salesforce authentication: PASSWORD, CLIENT_CREDENTIALS, JWT_BEARER, or OAUTH2_AUTH_CODE_BYOA (OAuth 2.0 Authorization Code with your own connected app)
* Type: string * Default: PASSWORD * Importance: high `salesforce.instance` : Salesforce endpoint URL the connector uses for API requests. For CLIENT_CREDENTIALS and the OAuth 2.0 Authorization Code grant, set this to your org’s My Domain URL (for example [https://MyDomainName.my.salesforce.com](https://MyDomainName.my.salesforce.com)). Defaults to [https://login.salesforce.com](https://login.salesforce.com).
* Type: string * Default: [https://login.salesforce.com](https://login.salesforce.com) * Importance: high `salesforce.username` : Salesforce username for connector authentication
* Type: string * Importance: high `salesforce.password` : Salesforce account password for connector authentication
* Type: password * Importance: high `salesforce.password.token` : Security token associated with the Salesforce username
* Type: password * Importance: high `salesforce.consumer.key` : Client ID (consumer key) for the Salesforce connected app
* Type: password * Importance: high `salesforce.consumer.secret` : Client secret (consumer secret) for the Salesforce connected app
* Type: password * Importance: medium `salesforce.jwt.keystore.file` : Keystore file that stores the private key for JWT authentication
* Type: password * Default: [hidden] * Importance: medium `salesforce.jwt.keystore.password` : Password that unlocks the JWT keystore file
* Type: password * Importance: medium `salesforce.object.num` : The number of salesforce objects to write to. This is used when multiple SObjects are enabled.
* Type: int * Default: 1 * Valid Values: [1,…,5] * Importance: high `oauth.refresh.token` : OAuth 2.0 refresh token. Populated by Confluent Cloud after authorization.
* Type: password * Importance: high ### Object 1 configuration `salesforce.object1` : The Salesforce SObject1 to write to.
* Type: string * Importance: high `salesforce.object1.topics` : The comma separated list of topics associated with Salesforce SObject1
* Type: list * Default: “” * Importance: high `salesforce.object1.override.event.type` : A flag to indicate that the Kafka SObject1 source record EventType(create, update, delete) is overridden to use the operation specified in the SObject1 override operation field.
* Type: boolean * Default: false * Importance: low `salesforce.object1.sink.operation` : The Salesforce sink operation to perform on the SObject1. One of: insert, update, upsert, delete. Default is insert. This feature works if `override.event.type` is true.
* Type: string * Default: insert * Importance: low `salesforce.object1.ignore.fields` : Comma separate list of fields from the source Kafka record to ignore when pushing a record into Salesforce.
* Type: list * Default: “” * Importance: low `salesforce.object1.ignore.reference.fields` : Flag to prevent reference type fields from being updated or inserted in Salesforce SObjects.
* Type: boolean * Default: false * Importance: low `skip.object1.relationship.fields` : Flag to skip relationship fields in records from being updated or inserted in Salesforce SObjects.
* Type: boolean * Default: true * Importance: medium `salesforce.object1.use.custom.id.field` : Flag to use custom external id field in SObjects.
* Type: boolean * Default: false * Importance: low `salesforce.object1.custom.id.field.name` : Name of a custom external id field in SObject to structure Rest Api calls for insert, upsert, delete, and update operations.
* Type: string * Importance: low ### Connection details `connection.timeout` : The amount of time to wait in milliseconds while connecting to the Salesforce streaming endpoint.
* Type: long * Default: 30000 * Importance: low `behavior.on.api.errors` : Error handling behavior config for any API errors.
* Type: string * Default: ignore * Importance: low `request.max.retries.time.ms` : Maximum time in milliseconds until the connector stops retrying failed Salesforce requests. Default is 30000 and minimum is 1000.
* Type: long * Default: 30000 (30 seconds) * Valid Values: [1000,…,250000] * Importance: low `behavior.on.null.record` : Error handling behavior config for null records
* Type: string * Default: fail * Importance: low `ignore.null.fields` : Whether null field values are ignored (not sent) in records written to Salesforce. When true, null fields are omitted and Salesforce retains the existing value; when false, null fields are sent and clear the corresponding field in Salesforce. Defaults to false.
* Type: boolean * Default: false * Importance: low ### Consumer configuration `max.poll.interval.ms` : The maximum delay between subsequent consume requests to Kafka. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 300000 milliseconds (5 minutes).
* Type: long * Default: 300000 (5 minutes) * Valid Values: [60000,…,1800000] for non-dedicated clusters and [60000,…] for dedicated clusters * Importance: low `max.poll.records` : The maximum number of records to consume from Kafka in a single request. This configuration property may be used to improve the performance of the connector, if the connector cannot send records to the sink system. Defaults to 500 records.
* Type: long * Default: 500 * Valid Values: [1,…,500] for non-dedicated clusters and [1,…] for dedicated clusters * Importance: low ### Number of tasks for this connector `tasks.max` : Maximum number of tasks for the connector.
* Type: int * Valid Values: [1,…] * Importance: high ### Additional Configs `consumer.override.auto.offset.reset` : Defines the behavior of the consumer when there is no committed position (which occurs when the group is first initialized) or when an offset is out of range. You can choose either to reset the position to the “earliest” offset (the default) or the “latest” offset. You can also select “none” if you would rather set the initial offset yourself and you are willing to handle out of range errors manually. More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#auto-offset-reset)
* Type: string * Importance: low `consumer.override.isolation.level` : Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. More details: [https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level](https://docs.confluent.io/platform/current/installation/configuration/consumer-configs.html#isolation-level)
* Type: string * Importance: low `header.converter` : The converter class for the headers. This is used to serialize and deserialize the headers of the messages.
* Type: string * Importance: low `key.converter.use.schema.guid` : The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
* Type: string * Importance: low `key.converter.use.schema.id` : The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message keys. Only applicable when key.converter.key.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
* Type: int * Importance: low `value.converter.allow.optional.map.keys` : Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.
* Type: boolean * Importance: low `value.converter.auto.register.schemas` : Specify if the Serializer should attempt to register the Schema.
* Type: boolean * Importance: low `value.converter.connect.meta.data` : Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.
* Type: boolean * Importance: low `value.converter.enhanced.avro.schema.support` : Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.
* Type: boolean * Importance: low `value.converter.enhanced.protobuf.schema.support` : Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.flatten.unions` : Whether to flatten unions (oneofs). Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.generate.index.for.unions` : Whether to generate an index suffix for unions. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.generate.struct.for.nulls` : Whether to generate a struct variable for null values. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.int.for.enums` : Whether to represent enums as integers. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.latest.compatibility.strict` : Verify latest subject version is backward compatible when use.latest.version is true.
* Type: boolean * Importance: low `value.converter.object.additional.properties` : Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.
* Type: boolean * Importance: low `value.converter.optional.for.nullables` : Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.optional.for.proto2` : Whether proto2 optionals are supported. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.scrub.invalid.names` : Whether to scrub invalid names by replacing invalid characters with valid characters. Applicable for Avro and Protobuf Converters.
* Type: boolean * Importance: low `value.converter.use.latest.version` : Use latest version of schema in subject for serialization when auto.register.schemas is false.
* Type: boolean * Importance: low `value.converter.use.optional.for.nonrequired` : Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.
* Type: boolean * Importance: low `value.converter.use.schema.guid` : The schema GUID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema GUID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
* Type: string * Importance: low `value.converter.use.schema.id` : The schema ID to use for deserialization when using ConfigSchemaIdDeserializer. This allows you to specify a fixed schema ID to be used for deserializing message values. Only applicable when value.converter.value.schema.id.deserializer is set to ConfigSchemaIdDeserializer.
* Type: int * Importance: low `value.converter.wrapper.for.nullables` : Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `value.converter.wrapper.for.raw.primitives` : Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.
* Type: boolean * Importance: low `errors.tolerance` : Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.
* Type: string * Default: all * Importance: low `key.converter.key.schema.id.deserializer` : The class name of the schema ID deserializer for keys. This is used to deserialize schema IDs from the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer * Importance: low `key.converter.key.subject.name.strategy` : How to construct the subject name for key schema registration.
* Type: string * Default: TopicNameStrategy * Importance: low `value.converter.decimal.format` : Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:
BASE64 to serialize DECIMAL logical types as base64 encoded binary data and
NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.
* Type: string * Default: BASE64 * Importance: low `value.converter.flatten.singleton.unions` : Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.
* Type: boolean * Default: false * Importance: low `value.converter.ignore.default.for.nullables` : When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF and JSON_SR Converters.
* Type: boolean * Default: false * Importance: low `value.converter.reference.subject.name.strategy` : Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.
* Type: string * Default: DefaultReferenceSubjectNameStrategy * Importance: low `value.converter.value.schema.id.deserializer` : The class name of the schema ID deserializer for values. This is used to deserialize schema IDs from the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.DualSchemaIdDeserializer * Importance: low `value.converter.value.subject.name.strategy` : Determines how to construct the subject name under which the value schema is registered with Schema Registry.
* Type: string * Default: TopicNameStrategy * Importance: low ### Auto-restart policy `auto.restart.on.user.error` : Enable connector to automatically restart on user-actionable errors.
* Type: boolean * Default: true * Importance: medium ## Frequently asked questions Find answers to frequently asked questions about the Salesforce SObject Sink connector for Confluent Cloud. ### Authentication and connection #### How do I configure `CLIENT_CREDENTIALS` grant type authentication? The connector supports three authentication grant types: `PASSWORD`, `JWT_BEARER`, and `CLIENT_CREDENTIALS`. For `CLIENT_CREDENTIALS` authentication: 1. Use your Salesforce domain URL (for example, `https://mycompany.my.salesforce.com`) in the `salesforce.instance` configuration. The default `https://login.salesforce.com` URL does not work. 2. Enable “Client Credentials Flow” in your Salesforce Connected App settings. 3. Configure a **Run As** user (execution user) in the Connected App policies. Without this configuration, authentication fails with an `invalid_grant` error. 4. Verify that the execution user has the necessary permissions and profiles assigned. For more information, see [Step 4: Enter the connector details](#cc-salesforce-sobjects-sink-connection). #### Why am I getting `invalid_grant` errors during authentication? Invalid grant errors occur due to authentication issues. ```none org.apache.kafka.connect.errors.ConnectException: Exception encountered while calling salesforce Caused by: invalid_grant ``` Common causes by authentication type: **PASSWORD grant type** * Incorrect username, password, or security token. * User account is locked or lacks API access. **JWT_BEARER grant type** * Certificate is expired or mismatched. * User is not pre-authorized in the Connected App. **CLIENT_CREDENTIALS grant type** * Use of the default login URL instead of your specific Salesforce domain URL. * Expired or invalid credentials. * **Run As** user is not configured in the Connected App policies. **Resolution:** 1. **Use domain URL**: Verify that you use your Salesforce my domain URL (for example, `https://mycompany.my.salesforce.com`) instead of `https://login.salesforce.com`. 2. **Configure Run As user**: In Salesforce Connected App settings, configure a **Run As** user under Client Credentials Flow policies. 3. **Verify credentials**: Check that all credentials (consumer key, consumer secret, passwords, certificates) remain current and have not expired. 4. **Review permissions**: Verify that the service account has appropriate permissions to access and modify SObjects. ### Data format and schema issues #### Why am I getting `_EventType field is missing` errors? This error occurs when the connector is configured to use the `_EventType` field from records, but the field is missing: ```none Kafka Record doesn't match config. _EventType field is missing and config property override.event.type=false. Please set the config property override.event.type=true and set the salesforce.sink.object.operation or include the _EventType field in the record. ``` **Common causes:** * Upstream producers do not include the `_EventType` field in records. * The connector configuration `override.event.type` is set to `false` (default). **Resolution:** You have two options: 1. **Include the \_EventType field**: Add the `_EventType` field to your records with values: `created`, `updated`, or `deleted`. The connector maps these to `insert`, `update`, or `delete` operations. 2. **Override event type**: Set `Salesforce SObject Override` (`override.event.type`) to `true` in the connector configuration and specify a fixed operation in `Salesforce SObject Override Operation` (`salesforce.sink.object.operation`). Valid operations are `insert`, `update`, `upsert`, or `delete`. #### NOTE The SObject Sink connector is designed to work with records produced by the Salesforce PushTopic Source connector, which automatically includes the `_EventType` field. If you use a different data source, you must configure `override.event.type=true`. #### How do I handle tombstone records? Tombstone records are records with null values in Kafka topics. The connector supports configurable behavior for these records using the `behavior.on.null.record` configuration: * `ignore` : Silently skip tombstone records without processing them. * `fail` (default): Throw an exception when encountering tombstone records, causing the connector to fail. * `delete`: Convert tombstone records to delete operations in Salesforce. **Configuration example:** ```json { "behavior.on.null.record": "delete" } ``` #### NOTE If batching is enabled, deletion of tombstone records takes place after the batch is processed to avoid inconsistencies. ### Batching and performance tuning #### How do I enable batching to avoid hitting Salesforce API limits? The connector supports batching using the Salesforce Collections API to reduce the number of API calls. To enable batching: 1. Set `Enable Batching` (`salesforce.enable.batching`) to `true`. 2. Configure `Batch Size` (`salesforce.batch.size`) to specify the maximum number of records per batch (maximum `200`, default is `200`). 3. Optionally, configure `All Or None` (`salesforce.all.or.none`) to control batch failure behavior: * `true`: The entire batch fails if any record fails. * `false` (default): Individual records can fail within a batch. **Configuration example:** ```json { "salesforce.enable.batching": "true", "salesforce.batch.size": "200", "salesforce.all.or.none": "false" } ``` **Limitations:** * Batching is only supported in Salesforce API version 42.0 and later. * Batches are created based on operation type, object type, and external field ID. * Records with different external IDs within an upsert operation are split into separate batches. #### Why is my connector experiencing lag or hitting API limits? Connector lag or API limit errors occur when the connector cannot keep up with incoming messages or exceeds Salesforce daily API quotas. **Common causes:** * Salesforce API rate limits are being exceeded (default: 15,000 API calls per 24 hours for most editions). * Batching is not enabled, resulting in one API call per record. * Insufficient connector tasks for the workload. **Resolution:** 1. **Enable batching**: Set `salesforce.enable.batching=true` to reduce API calls by up to 99% with optimal batch size. 2. **Increase tasks**: The connector supports multiple tasks. Increase `tasks.max` to improve throughput. 3. **Monitor API usage**: In Salesforce, navigate to **Setup > System Overview > API Usage** to monitor current usage and remaining limits. 4. **Tune consumer settings**: Adjust consumer configuration properties to control polling behavior: * Increase `consumer.override.max.poll.records` to fetch more records per poll. * Adjust `consumer.override.max.poll.interval.ms` if timeout errors occur. ### SObject operations and configuration #### Can I configure multiple SObjects in one connector? Yes, the connector supports up to five SObjects in a single connector instance. **Configuration requirements:** 1. Set **Salesforce SObject Number** (`salesforce.object.num`) to the number of SObjects (1-5). 2. For each SObject, configure: * The SObject name (`salesforce.object`). * A comma-separated list of associated topics (`salesforce.object.topics`). * SObject-specific configurations like operation type, external ID fields, and relationship field handling. 3. Each topic must be mapped to exactly one SObject. A topic cannot contain records for multiple SObjects. **Example configuration for two SObjects:** ```json { "salesforce.object.num": "2", "salesforce.object1": "Account", "salesforce.object1.topics": "account-topic", "salesforce.object1.override.event.type": "true", "salesforce.object1.sink.operation": "upsert", "salesforce.object2": "Contact", "salesforce.object2.topics": "contact-topic", "salesforce.object2.override.event.type": "true", "salesforce.object2.sink.operation": "insert" } ``` #### How do I configure upsert operations with external ID fields? Upsert operations require configuration of external ID fields in Salesforce and the connector. Follow these steps: 1. **Create an external ID field in Salesforce**: In Salesforce Setup, navigate to **Object Manager > [Your SObject] > Fields & Relationships > New** and create a custom field with the **External ID** checkbox selected (for example, `CustomId__c`). 2. **Configure the connector**: * Set `Salesforce SObject Use Custom Field` (`salesforce.use.custom.id.field`) to `true` * Set `Salesforce SObject Custom Field Name` (`salesforce.custom.id.field.name`) to your external ID field name (for example, `CustomId__c`) * Set `Salesforce SObject Override` (`override.event.type`) to `true` * Set `Salesforce SObject Override Operation` (`salesforce.sink.object.operation`) to `upsert` **Example configuration:** ```json { "salesforce.object1": "Account", "salesforce.object1.use.custom.id.field": "true", "salesforce.object1.custom.id.field.name": "CustomId__c", "salesforce.object1.override.event.type": "true", "salesforce.object1.sink.operation": "upsert" } ``` **Important considerations:** * The connector copies the `Id` field value from the Kafka record to the configured external ID field. * When `salesforce.use.custom.id.field=true`, the Kafka record must contain a non-empty `Id` field, or the connector fails with an error. * Upsert operations using external IDs work across different Salesforce organizations. #### Why am I getting `Id field is blank` errors when using upsert? This error occurs when `salesforce.use.custom.id.field` is set to `true`, but the Kafka record does not contain an `Id` field: ```none Configured to use custom id field but Kafka sObject 'Account' Id field is blank. ``` **Resolution:** 1. **Verify record schema**: Confirm that your Kafka records contain a non-empty `Id` field. 2. **Filter upstream**: Use an upstream filter (Kafka Streams, ksqlDB, or SMT) to drop records where `Id` is null before they reach the connector. 3. **Review configuration**: If you do not need external ID-based upserts, set `salesforce.use.custom.id.field=false`. ### Relationship fields #### How do I configure the connector to process relationship fields? The connector supports Salesforce relationship fields (lookup and master-detail relationships). To enable relationship field processing: 1. Set `Skip relationship fields` (`skip.object.relationship.fields`) to `false` for each SObject. 2. Set `Ignore reference fields` (`salesforce.object.ignore.reference.fields`) to `false` for each SObject. **Example configuration:** ```json { "skip.object1.relationship.fields": "false", "salesforce.object1.ignore.reference.fields": "false" } ``` **Important considerations:** * Relationship fields must reference the external ID of the related object (for example, `Account__r.ExternalId__c`), not the Salesforce internal ID. * The related object must exist in Salesforce before the relationship can be established. * Records cannot contain both the lookup field (`RelatedAccount__c`) and the relationship field (`RelatedAccount__r`) for the same relationship. Salesforce expects only one. * Referencing a field through an idLookup field is only supported if the referenced field is the same object type as the parent. Otherwise, use a field explicitly marked as an External ID. For more information, see [Salesforce relationship fields](#salesforce-relationship-fields-sobject-sink). ### Error handling and troubleshooting #### Why are records going to the dead letter queue (DLQ)? Records are sent to the DLQ when they fail processing. Common causes include: * **Invalid data format**: Records are not in the expected Struct format with proper schema. * **Missing required fields**: Salesforce SObject requires fields that are not present in the record. * **Salesforce validation errors**: Salesforce triggers or validation rules reject the record. * **Duplicate records**: Attempting to insert duplicate records when duplicate rules are enforced. * **Field-level errors**: Field values do not meet Salesforce field requirements (for example, `string too long, invalid picklist value`). **Resolution:** 1. **Check DLQ topic**: The connector automatically creates a DLQ topic named `dlq-`. Review messages in this topic to identify failure reasons. 2. **Check error topic**: Review the `error-` topic for detailed error messages from Salesforce. 3. **Check success topic**: Review the `success-` topic to confirm which records succeeded. 4. **Verify data format**: Verify that records use Avro, JSON Schema (JSON-SR), or Protobuf with a valid schema registered in Confluent Cloud Schema Registry. 5. **Review Salesforce configuration**: Check Salesforce triggers, validation rules, and duplicate rules that might be rejecting records. #### Why are read-only fields being excluded from my operations? Salesforce SObject fields may not be writable by insert, update, or upsert operations because the fields are set with `creatable=false` or `updatable=false` attributes in Salesforce. If a write is attempted to a field with these attributes, the connector excludes the field from the operation rather than fail the entire operation. This behavior is not configurable. **Common read-only fields:** * System fields like `Id`, `CreatedDate`, `CreatedById`, `LastModifiedDate`, `LastModifiedById` * Formula fields * Roll-up summary fields * Auto-number fields **Resolution:** This is expected behavior. The connector automatically filters out read-only fields to prevent operation failures. No action is required. #### How do I troubleshoot connector failures or check connector logs? For fully managed connectors in Confluent Cloud: 1. **Check connector status**: In the Confluent Cloud Console, navigate to your connector and check its status and any error messages displayed. 2. **Review connector metrics**: Monitor metrics such as records processed, errors, and throughput in the Confluent Cloud Console. 3. **Check connector topics**: The connector automatically creates three topics: * **Success topic** (`success-`): Contains successfully processed records. * **Error topic** (`error-`): Contains errors encountered during processing. * **DLQ topic** (`dlq-`): Contains records that failed processing. 4. **Access connector logs**: Connector logs are available through the Confluent Cloud Console. Navigate to your connector and click on the **Logs** tab to view detailed error messages and stack traces. 5. **Review Salesforce errors**: Check the error topic for detailed error responses from Salesforce, including API errors, validation errors, and field-level issues. For assistance, contact [Confluent Support](https://support.confluent.io/) with your connector ID, cluster ID, and relevant error messages. ## Next Steps For an example that shows fully managed Confluent Cloud connectors in action with Confluent Cloud for Apache Flink, see the [Cloud ETL Demo](/platform/current/tutorials/examples/cloud-etl/docs/index.html). This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud. [](https://docs.confluent.io/platform/current/tutorials/examples/cloud-etl/docs/index.html)