# Salesforce Bulk API 2.0 Source Connector for Confluent Cloud The fully managed Salesforce Bulk API 2.0 Source connector for Confluent Cloud pulls records and captures changes from [Salesforce.com](https://developer.salesforce.com/) into Apache Kafka® topics using [Salesforce Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_common_diff_two_versions.htm). #### NOTE * This Quick Start is for the fully managed Confluent Cloud connector that uses Salesforce Bulk API 2.0. If you are installing the fully managed cloud connector that supports the original [Salesforce Bulk Query API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm), see [Salesforce Bulk API Source Connector for Confluent Cloud](cc-salesforce-bulk-api-source.md#cc-salesforce-bulk-api-source). * 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 Bulk API 2.0 Source connector provides the following features: * **API 2.0**: Supports [Salesforce Bulk API 2.0](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_common_diff_two_versions.htm). * **At least once delivery**: The connector guarantees that records are delivered at least once to the Kafka topic. If the connector restarts, there could be duplicate records in the Kafka topic. * **Supported data formats:** The connector supports Avro, JSON Schema, Protobuf, or JSON (schemaless) output data. [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). * **Tasks per connector**: Organizations can run multiple connectors with a limit of one task per connector (that is, `"tasks.max": "1"`). * **Offset management capabilities**: Supports offset management. For more information, see [Manage custom offsets](#cc-salesforce-bulk-api-v2-source-custom-offsets). * **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-bulk-api-v2-source-setup-connection). * **Multiple SObject support**: Each connector instance supports up to five SObjects. For each SObject, you must provide the associated topic name. No single topic can contain records for multiple SObjects. The connector routes records for each SObject to its dedicated topic. The `result.max.rows` value (range: 1 to 3000) is divided equally among the configured SObject queries. * **Custom query support**: The connector supports custom SOQL queries, giving you control over which fields and records are retrieved from Salesforce. You can specify the list of fields to retrieve, add conditions to the `WHERE` clause, and select the offset field. For more information, see [Custom query support](#cc-salesforce-bulk-api-v2-source-custom-query). * **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. 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 Bulk API 2.0 Source Connector](limits.md#cc-salesforce-bulk-api-v2-source-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). ## Manage custom offsets You can manage the offsets for this connector. Offsets provide information on the point in the system from which the connector is accessing data. For more information, see [Manage Offsets for Fully Managed Connectors in Confluent Cloud](offsets.md#connect-custom-offsets). **To manage offsets**: - Manage offsets using Confluent Cloud APIs. For more information, see [Connect offsets API reference](https://docs.confluent.io/cloud/current/ccloud/offsets-connect-v-1/). ### Get the current offset To get the current offset, make a `GET` request that specifies the environment, Kafka cluster, and connector name. ```bash GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets Host: https://api.confluent.cloud ``` **Response:** Successful calls return HTTP `200` with a JSON payload that describes the offset. ```bash { "id": "lcc-example123", "name": "{connector_name}", "offsets": [ { "partition": { "table": "Account" }, "offset": { "jobId": "7505i00000Ug2TKAAZ", "locator": "null", "time": "2024-04-09T15:32:45Z" } } ], "metadata": { "observed_at": "2024-03-28T17:57:48.139635200Z" } } ``` Responses include the following information: - `jobId`, `locator`, and `time` indicate the position of the latest offset. - The observed time of the offset in the metadata portion of the payload. The `observed_at` time indicates a snapshot in time for when the API retrieved the offset. A running connector is always updating its offsets. Use `observed_at` to get a sense for the gap between real time and the time at which the request was made. By default, offsets are observed every minute. Calling get repeatedly will fetch more recently observed offsets. - Information about the connector. ### Update the offset To update the offset, make a `POST` request that specifies the environment, Kafka cluster, and connector name. Include a JSON payload that specifies new offset and a patch type. ```bash POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request Host: https://api.confluent.cloud { "type": "PATCH", "offsets": [ { "partition": { "table": "Account" }, "offset": { "jobId": "AHFHDGHGHGJDHJHF", "locator": "null", "time": "2024-04-09T15:20:47Z" } } ] } ``` Considerations: - You can only make one offset change at a time for a given connector. - This is an asynchronous request. To check the status of this request, you must use the check offset status API. For more information, see **Get the status of an offset request**. - For source connectors, the connector attempts to read from the position defined by the requested offsets. **Response:** Successful calls return HTTP `202 Accepted` with a JSON payload that describes the offset. ```bash { "id": "lcc-example123", "name": "{connector_name}", "offsets": [ { "partition": { "table": "Account" }, "offset": { "jobId": "AHFHDGHGHGJDHJHF", "locator": "null", "time": "2024-04-09T15:20:47Z" } } ], "requested_at": "2024-03-28T17:58:45.606796307Z", "type": "PATCH" } ``` Responses include the following information: - The requested position of the offsets in the source. - The time of the request to update the offset. - Information about the connector. ### Delete the offset To delete the offset, make a `POST` request that specifies the environment, Kafka cluster, and connector name. Include a JSON payload that specifies the delete type. ```bash POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request Host: https://api.confluent.cloud { "type": "DELETE" } ``` Considerations: - Delete requests delete the offset for the provided partition and reset to the base state. A delete request is as if you created a fresh new connector. - This is an asynchronous request. To check the status of this request, you must use the check offset status API. For more information, see **Get the status of an offset request**. - Do not issue delete and patch requests at the same time. - For source connectors, the connector attempts to read from the position defined in the base state. **Response**: Successful calls return HTTP `202 Accepted` with a JSON payload that describes the result. ```bash { "id": "lcc-example123", "name": "{connector_name}", "offsets": [], "requested_at": "2024-03-28T17:59:45.606796307Z", "type": "DELETE" } ``` Responses include the following information: - Empty offsets. - The time of the request to delete the offset. - Information about Kafka cluster and connector. - The type of request. ### Get the status of an offset request To get the status of a previous offset request, make a `GET` request that specifies the environment, Kafka cluster, and connector name. ```bash GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status Host: https://api.confluent.cloud ``` Considerations: - The status endpoint always shows the status of the most recent PATCH/DELETE operation. **Response**: Successful calls return HTTP `200` with a JSON payload that describes the result. The following is an example of an applied patch. ```bash { "request": { "id": "lcc-example123", "name": "{connector_name}", "offsets": [ { "partition": { "table": "Account" }, "offset": { "jobId": "CDCDCDCDCDCDC", "locator": "null", "time": "2024-04-09T15:10:47Z" } } ], "requested_at": "2024-03-28T17:58:45.606796307Z", "type": "PATCH" }, "status": { "phase": "APPLIED", "message": "The Connect framework-managed offsets for this connector have been altered successfully. However, if this connector manages offsets externally, they will need to be manually altered in the system that the connector uses." }, "previous_offsets": [ { "partition": { "table": "Account" }, "offset": { "jobId": "AHFHDGHGHGJDHJHF", "locator": "null", "time": "2024-04-09T15:20:47Z" } } ], "applied_at": "2024-03-28T17:58:48.079141883Z" } ``` Responses include the following information: - The original request, including the time it was made. - The status of the request: applied, pending, or failed. - The time you issued the status request. - The previous offsets. These are the offsets that the connector last updated prior to updating the offsets. Use these to try to restore the state of your connector if a patch update causes your connector to fail or to return a connector to its previous state after rolling back. ### JSON payload The table below offers a description of the unique fields in the JSON payload for managing offsets of the Salesforce Bulk API 2.0 Source connector. | Field | Definition | Required/Optional | |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| | `time` | Represents the time of the last query to bulk API. When you reset the offset, the connector selects events with a
time greater than and equal to the specified value in `time`. To update offsets, it is recommended that you only use a value in `time` and two
double quotes (`""`) for `jobID` and `locater`.

Use the following format for `time`: `yyyy-MM-dd'T'hh:mm:ss'Z'` | Required | | `jobId` | Unique ID for the bulk v2 query job. This field is not available in kafka records. | Optional | | `locator` | Pointer to the next batch of records. This field is not available in kafka records. | Optional | ## Custom query support The connector supports custom SOQL queries, giving you control over which fields and records are retrieved from Salesforce. By default, the connector queries all fields from the configured SObject. Custom query support lets you specify a subset of fields, apply `WHERE` clause conditions, and configure the offset field for incremental ingestion. When you enable custom query support, configure the following parameters: * **Fields**: A comma-separated list of fields to retrieve from the Salesforce object. The list must include the `Id` field and the configured offset field. All fields must exist on the Salesforce object. Compound fields such as Address and Location are not supported. * **WHERE clause conditions**: Conditions to filter records. Enter them without the `WHERE` keyword; the connector adds it automatically. Conditions are required and must include an initial-bound condition (for example, `CreatedDate > 2024-01-01T00:00:00Z`) to avoid unbounded queries. Do not constrain the offset field in the `WHERE` clause. The connector automatically injects incremental bounds for the offset field. The `WHERE` clause conditions configuration value is stored as a password type to prevent exposure of sensitive data. * **Offset field**: The `Date` or `DateTime` type field the connector uses to track incremental progress. Defaults to `LastModifiedDate`. The connector validates the custom query by making an API call to Salesforce during the validation phase and returns any errors. #### IMPORTANT Enabling custom query support, or modifying the fields, `WHERE` clause, or offset field of an existing custom query, resets the connector offset and creates a new partition. The connector restarts data ingestion based on the new query configuration. Custom queries do not support subqueries, `GROUP BY`, `ORDER BY`, `HAVING`, `OFFSET`, or `TYPEOF` clauses, or aggregate functions such as `COUNT`, `SUM`, `AVG`, `MIN`, and `MAX`. For more information, see [Salesforce Bulk API 2.0 Queries](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm). The following sample shows the custom query syntax: ```none SELECT [List Of Fields] FROM ObjectName WHERE [Filters] ``` The following is an example of an initial custom query: ```none SELECT Id, Name, SystemModstamp FROM Account WHERE Industry = 'Tech' AND AnnualRevenue > 1000000 AND CreatedDate >= 2025-01-01T00:00:00Z ``` ## 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 Salesforce Bulk API 2.0 Source connector. The quick start provides the basics of selecting the connector and configuring it to capture records and record changes from Salesforce. 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. - Salesforce account credentials. - 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 topic must exist** in your Confluent Cloud cluster before creating the connector. - For networking considerations, see [Networking and DNS](overview.md#connect-internet-access-resources). To use a set of public egress IP addresses, see [Public Egress IP Addresses for Confluent Cloud Connectors](static-egress-ip.md#cc-static-egress-ips).
- Kafka cluster credentials. The following lists the different ways you can provide credentials. - Enter an existing [service account](service-account.md#s3-cloud-service-account) resource ID. - Create a Confluent Cloud [service account](service-account.md#s3-cloud-service-account) for the connector. Make sure to review the ACL entries required in the [service account documentation](service-account.md#s3-cloud-service-account). Some connectors have specific ACL requirements. - Create a Confluent Cloud API key and secret. To create a key and secret, you can use [confluent api-key create](https://docs.confluent.io/confluent-cli/current/command-reference/api-key/confluent_api-key_create.html) *or* you can autogenerate the API key and secret directly in the Cloud Console when setting up the 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 Bulk API 2.0 Source** connector card. ![Salesforce Bulk API 2.0 Source Connector Card](images/ccloud-salesforce-bulk-api-v2-source-icon.png) #### IMPORTANT At least one topic must exist in your Confluent Cloud cluster before creating the connector. #### Step 4: Enter the connector details #### NOTE * Make sure you have all your [prerequisites](#cc-salesforce-bulk-api-v2-source-prereqs) completed. * An asterisk ( \* ) designates a required entry. At the **Add Salesforce Bulk API 2.0 Source 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**. ### 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 - **Number of salesforce objects**: The number of salesforce objects to process. **Output messages** - **Select output record value format**: Select the output record value format (data going to the Kafka topic). Valid vales are AVRO, JSON, JSON_SR (JSON Schema), or PROTOBUF. [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON Schema, or Protobuf). **Object 1 configuration** - **Enable custom query for SObject1**: When set to `true`, enables a custom query for `SObject1` instead of pulling all fields. - **List Of Fields**: Comma-separated list of fields to fetch for `SObject1`. Must include `Id` and the configured offset field. - **Salesforce SObject1 Name**: The Salesforce SObject1 to write to. - **Object 1 Topic name**: Specify the topic name to write the data to for Object 1. - **Where conditions for the custom query**: `WHERE` conditions to apply in the custom query (without the `WHERE` keyword). Must include an initial time bound to define the starting point for data fetch. For example: `CreatedDate > 2024-01-01T00:00:00Z AND Status = Active`. Do not include conditions on the offset field (for example, `LastModifiedDate`). The connector automatically manages incremental bounds. - **Offset field for SObject1**: Offset field to use for incremental bounds. Must be a date or datetime field, for example, `SystemModstamp` or `LastModifiedDate`. The values in this field must always increase over time. The connector uses these values to track progress and skip records it has already read. - **Salesforce SObject1 Since**: Specifies the `CreatedDate` after which the records should be pulled for SObject1. The time is in UTC and has required format: `yyyy-MM-dd`. - **Include deleted records for SObject1**: If set to `true`, the connector also fetches deleted records using `queryAll` operation type. This includes records in the recycle bin (soft deleted). By default, when you delete records in Salesforce they remain in the recycle bin for a minimum of 15 days, or possibly longer if specified by your organization’s settings. After this retention period, records are permanently deleted and cannot be restored. This configuration retrieves only records in the recycle bin that aren’t permanently deleted. - **Skip Epoch Conversion Fields for SObject1**: Comma-separated list of date or datetime fields to keep in their original ISO 8601 string format instead of converting to epoch. For example: `LastModifiedDate,CreatedDate`. Adding or removing fields causes schema changes. Ensure your Schema Registry compatibility settings allow the resulting schema evolution for affected fields. **Data encryption** - Enable **Client-Side Field Level Encryption** for data encryption. Specify a **Service Account** to access the Schema Registry and associated encryption rules or keys with that schema. 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). - **Poll interval (ms)**: Set the time in milliseconds to wait for new change events when no data is returned. Default is `500` ms. - **Max records per result set**: The maximum number of records the connector retrieves in a set of results for a Bulk API 2.0 query. The default value is set to the maximum value of `1000` records in a result set. **Additional Configs** - **value.converter.replace.null.with.default**: Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter. - **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`. - **value.converter.schemas.enable**: Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter. - **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. - **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. - **Key Converter Schema ID Serializer**: The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers. - **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. - **Value Converter Schema ID Serializer**: The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers. **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. **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). For all property values and definitions, see [Configuration Properties](cc-salesforce-bulk-api-source.md#cc-salesforce-bulk-api-source-config-properties). - Click **Continue**. ### Sizing This connector supports running a single task per connector instance. Click **Continue**. ### Review and Launch 1. Verify the connection details by previewing the running configuration. 2. After you’ve validated that the properties are configured to your satisfaction, click **Launch**. The status for the connector should go from **Provisioning** to **Running**. #### Step 5: Check the Kafka topic After the connector is running, verify that messages are populating your Kafka topic. 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. #### IMPORTANT * Make sure you have all your [prerequisites](#cc-salesforce-bulk-api-v2-source-prereqs) completed. * At least one topic must exist in your Confluent Cloud cluster before creating the connector. #### 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. ```none { "connector.class": "SalesforceBulkApiV2Source", "name": "SalesforceBulkApiV2Source_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "", "kafka.api.secret": "", "salesforce.object.num": 1, "salesforce.object1.topic": "TestBulkAPI", "salesforce.grant.type": "PASSWORD", "salesforce.instance": "https://login.salesforce.com", "salesforce.username": "", "salesforce.password": "**************", "salesforce.password.token": "************************", "salesforce.consumer.key": "**************", "salesforce.consumer.secret": "************************", "salesforce.object1": "", "output.data.format": "JSON", "tasks.max": "1" } ``` Note the following property definitions: * `"connector.class"`: Identifies the connector plugin name. * `"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.objectN.topic"`: Enter a Kafka topic name. A topic must exist before launching the connector (N can range from 1 to 5). * `"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.objectN""`: The SObject that the connector polls for new and changed records (N can range from 1 to 5). * `"output.data.format"`: Sets the output Kafka record value format (data coming from the connector). Valid entries are **AVRO**, **JSON_SR**, **PROTOBUF**, or **JSON**. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). * `"tasks.max"`: Enter the number of [tasks](/platform/current/connect/concepts.html#tasks) in use by the connector. Organizations can run multiple connectors with a limit of one task per connector (that is, `"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. For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](csfle.md#connect-csfle). The following example shows the required connector properties for two SObjects: ```none { "connector.class": "SalesforceBulkApiV2Source, "name": "SalesforceBulkApiV2Source_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "", "kafka.api.secret": "", "salesforce.object1.topic": "TestBulkAPI", "salesforce.instance": "https://login.salesforce.com", "salesforce.grant.type": "PASSWORD", "salesforce.username": "", "salesforce.password": "**************", "salesforce.password.token": "************************", "salesforce.consumer.key": "**************", "salesforce.consumer.secret": "************************", "salesforce.object.num": "2", "salesforce.object1": "", "salesforce.object1.topic": "", "salesforce.object2": "", "salesforce.object2.topic": "", "output.data.format": "JSON", "tasks.max": "1" } ``` **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-bulk-api-v2-source-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-bulk-api-v2-source.json ``` Example output: ```none Created connector SalesforceBulkApiV2Source_0 lcc-aj3qr ``` #### 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 +-----------+--------------------------------+---------+-------+ lcc-aj3qr | SalesforceBulkApiV2Source_0 | RUNNING | source ``` #### Step 6: Check the Kafka topic. After the connector is running, verify that messages are populating your Kafka topic. 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). #### NOTE These are properties for the fully managed cloud connector that uses Salesforce Bulk API 2.0. If you are installing the fully managed cloud connector that supports the original [Salesforce Bulk Query API](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_bulk_query_intro.htm), see [Salesforce Bulk API Source Connector for Confluent Cloud](cc-salesforce-bulk-api-source.md#cc-salesforce-bulk-api-source). ### 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 ### 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 ### 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 process.
* Type: int * Default: 1 * Valid Values: [1,…,5] * Importance: high `poll.interval.ms` : How often to query Salesforce for new records.
Note: If the connector is restarted (for example, due to a cluster re-roll or manual restart), any elapsed time in the current polling interval is lost, and the interval timer is reset. As a result, the actual wait time between polls may be longer than the configured value if a restart occurs mid-interval.
For example: If poll.interval.ms is set to 3 hours and the connector restarts 1 hours into the interval, after the restart it will wait the full 3 hours again before polling, resulting in a total wait of 4 hours for that poll cycle.
* Type: int * Default: 30000 (30 seconds) * Valid Values: [8700,…,10800000] * Importance: medium `result.max.rows` : The maximum number of records to retrieve per set of results for the Bulk API 2.0 query. The default value is set to 1000. If multiple objects are processed, this limit is split across those objects.
* Type: int * Default: 1000 * Valid Values: [1,…,3000] * Importance: medium `oauth.refresh.token` : OAuth 2.0 refresh token. Populated by Confluent Cloud after authorization.
* Type: password * Importance: high ### Object 1 configuration `salesforce.object1.enable.custom.query` : Enable custom query for SObject1.
* Type: boolean * Default: false * Importance: medium `salesforce.object1.custom.query.fields` : Comma separated list of fields to be fetched for SObject1. Must include Id and the configured offset field.
* Type: string * Importance: medium `salesforce.object1` : The Salesforce SObject1 to write to.
* Type: string * Importance: high `salesforce.object1.topic` : Specify the topic name to write the data to for Object 1.
* Type: string * Default: “” * Importance: high `salesforce.object1.custom.query.where` : WHERE conditions to be applied in the custom query (without the ‘WHERE’ keyword). Must include an initial time bound to define the starting point for data fetch. Example: ‘CreatedDate > 2024-01-01T00:00:00Z AND Status = Active’. Note: Do not include conditions on the offset field (e.g., LastModifiedDate) as the connector automatically manages incremental bounds.
* Type: password * Importance: medium `salesforce.object1.offset.field.name` : Offset field to use for incremental bounds. Must be a date or datetime field (e.g., SystemModstamp, LastModifiedDate). The field should have monotonically increasing values as the connector uses it to track progress and avoid duplicate reads.
* Type: string * Default: LastModifiedDate * Importance: medium `salesforce.object1.since` : CreatedDate after which the records should be pulled for SObject1. Note that the time is in UTC and has required format: yyyy-MM-dd.
* Type: string * Importance: medium `salesforce.object1.include.deleted.records` : If true, the connector will also fetch deleted records using queryAll operation type. This will include records that have been soft deleted (present in the recycle bin).
Note: By default, deleted records in Salesforce remain in the Recycle Bin for 15 days (or longer, if specified by your organization’s settings). After this retention period, records are permanently deleted and cannot be restored. This configuration will only retrieve records that are still present in the Recycle Bin and have not yet been permanently deleted.
* Type: boolean * Default: false * Importance: medium `salesforce.object1.skip.epoch.conversion.fields` : Comma-separated list of date/datetime fields that should retain their original ISO 8601 string format instead of being converted to epoch. Example: LastModifiedDate,CreatedDate. Note: Adding or removing fields will cause schema changes. Ensure your Schema Registry compatibility settings allow the resulting schema evolution for affected fields.
* Type: list * Importance: low ### Connection details `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 ### Output messages `output.data.format` : Sets the output Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF
* Type: string * Default: JSON * Importance: high ### Number of tasks for this connector `tasks.max` : Maximum number of tasks for the connector.
* Type: int * Valid Values: [1,…] * Importance: high ### Additional Configs `header.converter` : The converter class for the headers. This is used to serialize and deserialize the headers of the messages.
* Type: string * Importance: low `producer.override.compression.type` : The compression type for all data generated by the producer. Valid values are none, gzip, snappy, lz4, and zstd.
* Type: string * Importance: low `producer.override.linger.ms` : The producer groups together any records that arrive in between request transmissions into a single batched request. More details can be found in the documentation: [https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#linger-ms](https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#linger-ms).
* Type: long * Valid Values: [100,…,1000] * 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.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: none * Importance: low `key.converter.key.schema.id.serializer` : The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer * 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.replace.null.with.default` : Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter.
* Type: boolean * Default: true * Importance: low `value.converter.schemas.enable` : Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter.
* Type: boolean * Default: false * Importance: low `value.converter.value.schema.id.serializer` : The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer * 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 Bulk API 2.0 Source connector for Confluent Cloud. ### Authentication and connection #### What authentication methods are supported, and how do I configure `CLIENT_CREDENTIALS` grant type? The connector supports three authentication grant types: * **PASSWORD** (username + password + security token): Default authentication method * **JWT_BEARER** (JSON Web Token): Certificate-based authentication * **CLIENT_CREDENTIALS** (OAuth 2.0): Machine-to-machine authentication For `CLIENT_CREDENTIALS` authentication: 1. You must use your Salesforce my domain URL (for example, `https://mycompany.my.salesforce.com`) in the `salesforce.instance` configuration. The default `https://login.salesforce.com` URL will 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, authentication fails with an `invalid_grant` error. 4. Ensure the execution user has the necessary permissions and profiles assigned. For more information, see [Step 4: Enter the connector details](#cc-salesforce-bulk-api-v2-source-setup-connection). #### Why am I getting `401 Unauthorized` or `INVALID_SESSION_ID` errors intermittently? These authentication errors typically occur due to Salesforce session management issues: ```none org.apache.kafka.connect.errors.ConnectException: Exception encountered while calling salesforce Caused by: com.sforce.soap.partner.fault.UnexpectedErrorFault: INVALID_SESSION_ID ``` **Common causes:** * External login scripts or processes using the same Salesforce user account can invalidate the connector’s session. * Salesforce’s shared-session behavior means multiple logins with the same credentials can conflict. * Session timeout or expiration based on Salesforce security policies. **Resolution:** - **Use dedicated service accounts**: Create a dedicated Salesforce user account exclusively for the connector to avoid session conflicts. - **Verify credentials**: Ensure your Salesforce credentials (password, security token, consumer key/secret) are current and not expired. - **Check Salesforce session settings**: Review your Salesforce organization’s session timeout and security policies in **Setup > Session Settings**. - **Monitor connector logs**: The connector will automatically attempt to reconnect and re-authenticate. If errors persist, check for underlying authentication issues. ### Data ingestion and schema #### Why is my connector running but not processing any data? The Salesforce Bulk API 2.0 Source connector requires both `CreatedDate` and `LastModifiedDate` fields to incrementally query data from Salesforce objects. If your Salesforce object lacks these fields, the connector runs without processing any data. **Common objects without required fields:** * `GroupMember` - Missing both CreatedDate and `LastModifiedDate`. * `UserRole` - Missing `CreatedDate`. * `PermissionSetAssignment` - Missing `LastModifiedDate`. * `CaseHistory` - Missing `LastModifiedDate`. **Resolution:** - **Verify object support**: Check that your Salesforce object has both `CreatedDate` and `LastModifiedDate` fields before configuring the connector. - **Alternative approaches**: For objects without these fields, consider: * Using the [Salesforce CDC Source connector](cc-salesforce-source-cdc.md#cc-salesforce-source-cdc) if change data capture is enabled for the object. * Using the [Salesforce Platform Event Source connector](cc-salesforce-platform-event-source.md#cc-salesforce-platform-event-source) for event-based data. #### Why are some fields missing after I updated my Salesforce object definition? When you add new fields to a Salesforce object, the connector may not immediately recognize them. The connector caches the Salesforce object metadata when it connects. To ensure the connector processes new fields: 1. **Restart the connector**: This refreshes the cached Salesforce object metadata and ensures the connector recognizes newly added fields. 2. **Verify field visibility**: Ensure the Salesforce user has field-level security permissions to access the new fields. 3. **Check topic messages**: Review messages in your Kafka topic to confirm all expected fields are being ingested. #### NOTE The connector does not automatically detect schema changes. You must manually restart the connector after modifying the Salesforce object definition. ### Performance and configuration #### How do I avoid hitting Salesforce API limits? Salesforce enforces daily API limits based on your organization’s edition and license type. The Bulk API 2.0 has specific limits that you should be aware of: * **Daily Bulk API 2.0 batch limit**: 15,000 batches per 24-hour rolling period. * **Concurrent job limit**: Up to 100 concurrent Bulk API 2.0 jobs. * **Result set size**: Maximum 1,000 records per result set (configurable via `result.max.rows`). **Best practices:** - **Configure polling interval**: Increase the `poll.interval.ms` property to reduce the frequency of API calls. The default is `30000 ms` (30 seconds). Consider setting it to `300000 ms` (5 minutes) or higher based on your data freshness requirements. - **Adjust result.max.rows**: The `result.max.rows` property controls the maximum number of records retrieved per API call. The default and maximum value is `1000`. Larger values reduce the number of API calls but may increase processing time. - **Monitor API usage**: Use Salesforce Setup Console (**Setup > System Overview > API Usage**) to monitor your current API usage and remaining limits. - **Use appropriate connector types**: For real-time data changes, consider using [Salesforce CDC Source connector](cc-salesforce-source-cdc.md#cc-salesforce-source-cdc) which uses the Streaming API instead of REST/Bulk API. For more information, see [Salesforce Bulk API 2.0 Limits](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/bulk_common_diff_two_versions.htm). #### Why am I getting `Read timed out (SocketTimeoutException)` errors? Read timeout errors occur when the connector cannot retrieve data from Salesforce within the configured timeout period: ```none java.net.SocketTimeoutException: Read timed out at io.confluent.connect.salesforce.bulk.v2.SalesforceBulkApiV2SourceTask.poll ``` **Common causes:** * The Salesforce object contains a very large number of records. * Complex Salesforce object relationships or triggers that slow down query execution. * Network latency between Confluent Cloud and Salesforce. * Salesforce server-side performance issues. **Resolution:** - **Reduce result.max.rows**: Lower the `result.max.rows` property to retrieve fewer records per API call. Try setting it to `500` or `250` instead of the default `1000`. - **Increase polling interval**: Increase the `poll.interval.ms` property to give Salesforce more time between queries. - **Verify Salesforce performance**: Check with your Salesforce administrators to ensure the object and any associated triggers or workflows are performing optimally. - **Compare with other objects**: If you have multiple connectors querying different Salesforce objects from the same organization, compare their performance. If only one object experiences timeouts, the issue is likely specific to that object’s configuration or data volume. ### Troubleshooting #### 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. **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. 4. **Common log locations**: For API access to logs, see the [Confluent Cloud API documentation](https://docs.confluent.io/cloud/current/api.html). For assistance, contact [Confluent Support](https://support.confluent.io/) with your connector ID, cluster ID, and relevant error messages. #### How do I reset the connector to re-ingest all data from Salesforce? To re-ingest all data from the beginning: 1. **Delete connector offsets**: Use the offset management API to delete the connector’s stored offsets. See [Manage custom offsets](#cc-salesforce-bulk-api-v2-source-custom-offsets) for detailed instructions. 2. **Update salesforce.since configuration**: Alternatively, you can update the `salesforce.since` property to a date in the past (for example, `2020-01-01T00:00:00Z`) and restart the connector. 3. **Pause the connector first**: Before making offset changes, pause the connector to ensure it’s not actively processing data. #### WARNING Deleting offsets or changing the `salesforce.since` date will cause the connector to re-ingest all data, potentially creating duplicate records in your Kafka topic. ## 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)