Collapse navigation tree

Collapse

salesforce

Available in: Self-Managed

License: This component requires an enterprise license. You can either upgrade to an Enterprise Edition license, or generate a trial license key that's valid for 30 days.

Fetches data from Salesforce based on input messages.

Introduced in version 4.85.0.

This processor takes input messages containing Salesforce queries and returns Salesforce data.

Supports the following Salesforce resources:

  • sObject REST snapshot (all queryable sObjects or a filtered subset)

  • Filtered SOQL queries via REST or GraphQL

  • Change Data Capture (CDC) streaming via the Pub/Sub gRPC API

  • Platform Events via the Pub/Sub gRPC API

  • Common

  • Advanced

processors:
  label: ""
  salesforce:
    org_url: "" # No default (required)
    client_id: "" # No default (required)
    client_secret: "" # No default (required)
    restapi_version: v65.0
    request_timeout: 30s
    max_retries: 10
    query_type: rest
    query: ""
    cdc_enabled: false
    cdc_objects: []
    cdc_batch_size: 100
    cdc_buffer_size: 1000
    cdc_replay_preset: latest
    pubsub_topic: ""
    grpc_reconnect_base_delay: 500ms
    grpc_reconnect_max_delay: 30s
    grpc_reconnect_max_attempts: 0
    grpc_shutdown_timeout: 10s
    cache_resource: salesforce_checkpoint
    parallel_fetch: 1
    query_batch_size: 2000
    rest_objects: []
processors:
  label: ""
  salesforce:
    org_url: "" # No default (required)
    client_id: "" # No default (required)
    client_secret: "" # No default (required)
    restapi_version: v65.0
    request_timeout: 30s
    max_retries: 10
    query_type: rest
    query: ""
    cdc_enabled: false
    cdc_objects: []
    cdc_batch_size: 100
    cdc_buffer_size: 1000
    cdc_replay_preset: latest
    pubsub_topic: ""
    grpc_reconnect_base_delay: 500ms
    grpc_reconnect_max_delay: 30s
    grpc_reconnect_max_attempts: 0
    grpc_shutdown_timeout: 10s
    cache_resource: salesforce_checkpoint
    parallel_fetch: 1
    query_batch_size: 2000
    rest_objects: []

Fields

cache_resource

Name of the cache resource used for checkpointing state (must be defined in cache_resources).

Type: string

Default: salesforce_checkpoint

cdc_batch_size

Number of CDC events to request per gRPC fetch.

Type: int

Default: 100

cdc_buffer_size

Size of the internal CDC event buffer.

Type: int

Default: 1000

cdc_enabled

Enables Change Data Capture streaming after the REST snapshot completes.

Type: bool

Default: false

cdc_objects[]

sObject types to capture changes for (for example, ["Account", "Contact"]). When empty, subscribes to /data/ChangeEvents for all objects.

Type: array

Default: []

cdc_replay_preset

CDC replay preset when no checkpoint exists: latest (default) or earliest.

Type: string

Default: latest

client_id

Client ID for the Salesforce Connected App.

Type: string

client_secret

Client secret for the Salesforce Connected App.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

grpc_reconnect_base_delay

Base delay for gRPC reconnection backoff.

Type: string

Default: 500ms

grpc_reconnect_max_attempts

Maximum number of gRPC reconnection attempts (0 = unlimited).

Type: int

Default: 0

grpc_reconnect_max_delay

Maximum delay for gRPC reconnection backoff.

Type: string

Default: 30s

grpc_shutdown_timeout

Timeout for graceful gRPC client shutdown.

Type: string

Default: 10s

max_retries

Maximum number of retries on a 429 Too Many Requests error.

Type: int

Default: 10

org_url

Salesforce instance base URL (for example, https://your-domain.salesforce.com).

Type: string

parallel_fetch

Number of sObjects to fetch concurrently during the REST snapshot (no-query mode). Higher values improve throughput but consume more API quota.

Type: int

Default: 1

pubsub_topic

Arbitrary Pub/Sub API topic (for example, /event/MyEvent__e). When set, overrides cdc_objects for topic selection.

Type: string

Default: ""

query

Optional SOQL (REST) or GraphQL query. When empty, all sObjects are fetched using REST.

Type: string

Default: ""

query_batch_size

Number of records Salesforce returns per query page (200-2000). Lower values reduce individual response size and avoid timeouts on wide sObjects.

Type: int

Default: 2000

query_type

API mode: rest (default) or graphql.

Type: string

Default: rest

request_timeout

Timeout for HTTP requests.

Type: string

Default: 30s

rest_objects[]

Limits the REST snapshot to only these sObject types (for example, ["Account", "Contact"]). When empty, all queryable sObjects are fetched.

Type: array

Default: []

restapi_version

Salesforce REST API version to use (for example, v65.0).

Type: string

Default: v65.0