# Salesforce Platform Event Sink Connector for Confluent Cloud Salesforce [platform events](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_intro_emp.htm) are user-defined publish-subscribe events. The fully managed Salesforce Platform Event Sink connector for Confluent Cloud publishes platform events from Apache Kafka® topics to Salesforce. The fully managed Salesforce Platform Event Sink connector can be thought of as the inverse of the [Platform Events Source connector](https://docs.confluent.io/cloud/current/connectors/cc-salesforce-platform-event-source.html). It is designed to read platform event records from a Kafka topic containing data streamed from the Platform Event Source connector. The connector then publishes this data as new platform events to the configured organization. #### NOTE * This Quick Start is for the fully managed Confluent Cloud connector. If you are installing the connector locally for Confluent Platform, see [Salesforce Platform Event Sink Connector for Confluent Platform](https://docs.confluent.io/kafka-connectors/salesforce/current/platformevents_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 Platform Event Sink connector supports 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. ![Salesforce Platform Event Sink Connector Topics](images/ccloud-datadog-metrics-sink-topics.png) 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 format 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 platform events**: The connector allows you to configure up to five platform events in a single connector instance. You can select the number of events and configure them individually. Each selected topic must be mapped to a specific event, and a single topic cannot contain records for multiple events. For each event, you must provide the event name and a comma-separated list of associated topics. If you select only one event, all selected topics are mapped to that event by default. * **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-platform-event-sink-setup-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. ## Limitations Be sure to review the following information. * For connector limitations, see [Salesforce Platform Event Sink Connector](limits.md#cc-salesforce-platform-event-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). ## Data Fields The UI configuration property **Salesforce platform event name** (CLI property `salesforce.platform.event.name`) designates the name of the event. Event names must end with `__e`. For example, `MyPlatformEvent__e`. The connector only publishes data fields that are part of the Platform Event Definition (that is, data fields ending with `__c`). All other fields are ignored. If there are no fields in the message that have the required `__c` suffix, the entire message is not sent to Salesforce. #### NOTE The Platform Event Definition must exist in Salesforce before the connector can publish events to Salesforce. See the [Salesforce Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_define.htm) for more information. ## 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 Platform Event 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. - An authorized Salesforce consumer key and secret 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 Platform Event Sink** connector card. ![Salesforce Platform Event Sink Connector Card](images/ccloud-salesforce-platform-event-sink-icon.png) #### Step 4: Set up the connection. #### NOTE * Make sure you have all your [prerequisites](#cc-salesforce-platform-event-sink-prereqs) completed. * An asterisk ( \* ) designates a required entry. At the **Add Salesforce Platform Event Sink connector** screen, complete the following: ### Topic selection Select the topic you want to send data to 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**. #### IMPORTANT If using a service account, you must add ACL entries. For standard service account ACL entries, see [Sink connector service account](service-account.md#cloud-service-account-sink-connectors). For the additional ACLs required for this connector, see [Sink connector SUCCESS and ERROR topics](service-account.md#cloud-service-account-sink-additional-acls). ### 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 - **Input Kafka record value format**: Select the input Kafka record value format (data coming from the Kafka topic). Valid values are AVRO, JSON_SR (JSON Schema), 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_SR (JSON Schema), or Protobuf). for additional information. - **Number of platform events**: The number of Salesforce platform events to write to. Must be between 1 and 5. **Platform Event 1 configuration** - **Platform Event1 Name**: The name of the Salesforce platform event 1 to publish to. The event name should end with the \_\_e suffix. For example: LoginEvent_\_e. - **Platform Event1 Topics**: The list of topics to use for platform event 1. **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 advanced 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 (ms) when connecting to the Salesforce endpoint. The default is 30000 ms (30 seconds). - **Behavior on API errors**: How the connector behaves when a Salesforce API error occurs. Valid options are `fail` and `ignore` (the default). If set to `fail`, the connector stops. **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). - Click **Continue**. ### Sizing Based on the number of topic partitions you select, you will be provided with a recommended number of tasks. More tasks may improve performance. Click **Continue**. ### Review and Launch 1. Verify the connection details by previewing the running configuration. 2. Once you’ve validated that the properties are configured to your satisfaction, click **Continue**. The status for the connector should go from **Provisioning** to **Running**.
See [Configuration Properties](#cc-salesforce-platform-event-sink-config-properties) for all property values and descriptions. #### Step 5: Check the connector status The status for the connector should go from **Provisioning** to **Running**. #### Step 6: 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-platform-event-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. ```json { "connector.class": "SalesforcePlatformEventSink", "input.data.format": "AVRO", "name": "SalesforcePlatformEventSinkConnector_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.platform.event.num": "1", "salesforce.platform.event1.name": "__e", "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 ``` #### IMPORTANT If using a service account, you must add ACL entries. For standard service account ACL entries, see [Sink connector service account](service-account.md#cloud-service-account-sink-connectors). For the additional ACLs required for this connector, see [Sink connector SUCCESS and ERROR topics](service-account.md#cloud-service-account-sink-additional-acls). * `"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.platform.event.num"`: The number of platform events to be supported. (Must be between 1 to 5) * `"salesforce.platform.event1.name"`: The event name. This name is case sensitive. * `"tasks.max"`: The connector supports running one or more tasks. 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. #### 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-platform-event-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-platform-event-sink-config.json ``` Example output: ```none Created connector SalesforcePlatformEventSinkConnector_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 | SalesforcePlatformEventSinkConnector_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 ### 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.platform.event.num` : The number of Salesforce platform events to write to. Must be between 1 and 5.
* 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 ### Platform Event 1 configuration `salesforce.platform.event1.name` : The name of the Salesforce platform event 1 to publish to. The Event name should end with \_\_e suffix. For example: LoginEvent_\_e.
* Type: string * Importance: high `salesforce.platform.event1.topics` : List of topics to be used for platform event 1.
* Type: list * Default: “” * Importance: high ### 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 `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.api.errors` : Error handling behavior config for any Salesforce API errors.
* Type: string * Default: ignore * 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 Platform Event 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: Set up the connection.](#cc-salesforce-platform-event-sink-setup-connection). #### Why am I getting `invalid_grant` errors during authentication? Invalid grant errors occur due to authentication issues, particularly with `CLIENT_CREDENTIALS` grant type: ```none org.apache.kafka.connect.errors.ConnectException: Exception encountered while calling salesforce Caused by: invalid_grant ``` **Common causes:** * `CLIENT_CREDENTIALS` authentication uses the default login URL instead of your Salesforce domain URL. * The **Run As** user is not configured in the Connected app policies. * Credentials or certificates have expired. * Service account permissions are insufficient. **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 publish platform events. ### Platform event configuration #### Why are my records not being published to Salesforce? The connector publishes only data fields that are part of the Platform Event Definition. Records without properly formatted fields are not sent to Salesforce. **Common causes:** * The Platform Event Definition does not exist in Salesforce. * Record fields do not end with the required `__c` suffix. * The event name does not end with `__e`. * Event name case does not match the Salesforce definition (case sensitive). **Resolution:** 1. **Create Platform Event Definition**: Verify that the Platform Event Definition exists in your Salesforce organization before starting the connector. See the [Salesforce Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_define.htm) for details. 2. **Verify field names**: The connector publishes only custom fields ending with `__c`. System fields (for example, ReplayId, CreatedDate) are ignored. Records without any `__c` fields are dropped entirely. 3. **Check event name**: Verify that your event name ends with `__e` (for example, `MyPlatformEvent__e`). 4. **Match case**: Event names are case sensitive. Verify that the `salesforce.platform.eventN.name` configuration matches the exact case used in Salesforce. #### NOTE The connector automatically ignores all non-custom fields. If a message contains no fields ending with `__c`, the entire message is not sent to Salesforce, and no error is logged. #### Can I publish to multiple platform events with a single connector instance? Yes, the fully managed Salesforce Platform Event Sink connector supports up to five platform events per connector instance. **Configuration requirements:** 1. Set `salesforce.platform.event.num` to a value between `1` and `5`. 2. For each platform event, configure: * Event name (for example, `salesforce.platform.event1.name`). * Comma-separated list of topics mapped to that event. 3. Each topic must map to exactly one platform event. A single topic cannot contain records for multiple event types. #### NOTE If you configure only one event, all selected topics map to that event by default. ### Data format and schema #### Why am I getting schema-related errors? The connector supports only Avro, JSON Schema (JSON-SR), and Protobuf input formats with Confluent Cloud Schema Registry enabled. ```none Schema not found error ``` **Common causes:** * The input data format is plain JSON without schema. * Confluent Cloud Schema Registry is not enabled for your cluster. * Schema does not exist in Schema Registry for the topic. * Schema format does not match the connector configuration. **Resolution:** 1. **Enable Schema Registry**: Verify that [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) is enabled for your Confluent Cloud cluster. 2. **Use supported formats**: Configure producers to send data in Avro, JSON Schema (JSON-SR), or Protobuf format. Plain JSON is not supported. 3. **Verify schema exists**: Check that the schema exists in Schema Registry for your topic. 4. **Match data format**: Verify that the `input.data.format` configuration matches your producer’s serialization format. ### Performance and API limits #### How do I avoid hitting Salesforce API limits? Salesforce enforces daily API limits based on your organization’s edition and license type. Platform Events have specific allocations: * **Daily platform event allocations**: Varies by Salesforce edition * **API call limits**: Vary by Salesforce edition **Best practices:** 1. **Monitor API usage**: Use Salesforce Setup Console (Setup > System Overview > API Usage) to monitor your current usage and remaining limits. 2. **Adjust consumer configuration**: Modify consumer settings to control the rate of data consumption: * Increase `consumer.max.poll.interval.ms` to give more time between polls. * Reduce `consumer.max.poll.records` to fetch fewer records per poll. * These settings are available under advanced configurations. 3. **Coordinate with administrators**: Work with Salesforce administrators to increase org limits if needed. 4. **Review error topic**: Check the error topic for quota-related error messages from Salesforce. #### NOTE The connector creates success, error, and DLQ topics automatically. Quota errors appear in the error topic while the connector continues running only when `behavior.on.api.errors` is set to `log`. With the default setting of `fail`, quota and API errors stop the connector. #### Why is my connector experiencing lag? Connector lag occurs when the connector cannot keep up with the rate of incoming messages from Kafka topics. **Common causes:** * Salesforce API rate limits are being exceeded. * Consumer configuration is not optimized for your throughput. * Insufficient connector tasks for the workload. * Network latency between Confluent Cloud and Salesforce. **Resolution:** - **Increase tasks**: The connector supports multiple tasks. Increase `tasks.max` to improve throughput. More tasks reduce consumer lag with multiple tasks running. - **Tune consumer settings**: Adjust consumer configuration properties: * Increase `consumer.max.poll.records` to fetch more records per poll. * Decrease `consumer.max.poll.interval.ms` to poll records more frequently. * These settings are available under advanced configurations. - **Monitor Salesforce performance**: Check with your Salesforce administrators to verify that the organization is not experiencing performance issues. - **Review metrics**: Monitor connector metrics in the Confluent Cloud Console for records processed, errors, and throughput. ### Troubleshooting #### Why am I getting duplicate value errors from Salesforce? Salesforce rejects platform events with duplicate values for unique fields defined in the Platform Event Definition. ```none Salesforce error: duplicate value found ``` **Common causes:** * The Platform Event Definition contains unique field constraints. * Upstream producers are generating duplicate records. * Connector retries are re-publishing the same events. **Resolution:** - **Review Platform Event Definition**: Check your Salesforce Platform Event Definition for unique field constraints. - **Check for duplicates upstream**: Verify that upstream producers are not generating duplicate records. - **Review DLQ topic**: Check the Dead Letter Queue (DLQ) topic for records that failed due to duplicate values. - **Consider idempotency**: Design your Platform Event Definition to allow duplicate events if your use case requires at-least-once delivery guarantees. #### 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**: Contains successfully published events. * **Error topic**: Contains errors encountered during publishing. * **DLQ topic**: 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 quota 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. [![image](images/topology.png)](https://docs.confluent.io/platform/current/tutorials/examples/cloud-etl/docs/index.html)