Salesforce

Discover more about the Salesforce connector and how to use it on the Digibee Integration Platform.

The Salesforce connector allows you to perform operations on the Salesforce platform.

Parameters

Take a look at the configuration parameters of the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Fail On Error	If enabled, interrupts the pipeline execution when an error occurs. If disabled, execution continues, but the "success" property will be set to false.	False	Boolean

Authentication tab

Parameter	Description	Default value	Data type
Salesforce Login URL (DB)	URL used for Salesforce authentication.	N/A	String
Salesforce Client Account	Connected App account with the Client ID. Supported types: OAuth Provider.	N/A	Account
OAuth Authentication Flow	Authentication type used in the Salesforce app: JWT Bearer Token Flow or Username-Password Flow.	N/A	String
Operation Account	Account used to perform Salesforce operations. Supported accounts: Basic, Certificate-Chain.	N/A	Account
Subject	User used for authentication with the Salesforce app. Available only with JWT Bearer Token Flow.	N/A	String

Salesforce API tab

The Salesforce connector can automatically retrieve all available entities on the Salesforce platform to simplify configuration.

Important information:

• To use this feature, you must configure a valid Salesforce account and URL. If no account is selected in Operation Account, or the credentials are invalid, the connector switches automatically to RAW mode, which requires manual configuration.

• In Capsules, only RAW mode is supported. This means all configurations, including the API Version parameter, must be set up manually. The use of Double Braces syntax is supported.

AuthToken Reuse

When accessing the Salesforce API tab, the connector generates an access token with limited validity that may expire.

To prevent frequent token regeneration, Digibee offers AuthToken Reuse for the username-password flow. This allows configuring a new connection in the Salesforce portal and reusing the existing token.

See how to configure this mechanism.

Salesforce API tab parameters

Parameter	Description	Default value	Data type
API Version	Salesforce API version.	{latest version}	String
API Protocol	Salesforce API to use: Bulk, Bulk 2.0, RAW, and Rest.	N/A	String
Operation	Operation to be performed on Salesforce API. See below in a dedicated section the available options for each API.	N/A	String

RAW mode parameters

When API Protocol is set to RAW, configure the following parameters manually:

Parameter	Description	Default value	Data type
Method	HTTP method to use.	GET	String
Path (DB)	Salesforce API endpoint path. Make sure to include the API version in the path.	/services/data/v51/sobjects/Account/	String
Headers (DB)	Required request headers.	Content-Type: application/json	String
Object Fields	List of keys that must match the ones defined in the Headers field. These keys are required here to ensure proper processing of the request. If a header is not listed in this field, it will not be included in the request.	Content-Type	String
Body (DB)	Request body.	N/A	JSON

Available operations by API type

Bulk:

• Abort Job

• Close Job

• Create Batch

• Create Batch Query

• Create Job

• Get All Batches

• Get Batch

• Get Job

• Get Query Result

• Get Query Result Ids

• Get Request

• Get Results

Bulk 2.0:

• Abort Job

• Abort Query Job

• Close Job

• Create Batch

• Create Job

• Create Query Job

• Delete Job

• Delete Query Job

• Get All Jobs

• Get All Query Jobs

• Get Failed Results

• Get Job

• Get Query Job

• Get Query Job Results

• Get Successful Results

• Get Unprocessed Records

Rest:

• Apex Call

• Approval

• Approvals

• Composite

• Composite-batch

• Composite Create SObject Collections

• Composite Delete SObject Collections

• Composite Retrieve SObject Collections

• Composite-tree

• Composite Update SObject Collections

• Composite Upsert SObject Collections

• Create SObject

• Delete SObject

• Delete SObject With Id

• Get Basic Info

• Get Blob Field

• Get Description

• Get Global Objects

• Get Resources

• Get SObject

• Get SObject With Id

• Get Versions

• Limits

• Query

• Query All

• Query More

• Recent

• Search

• Update SObject

• Upsert SObject

Advanced settings tab

Parameter	Description	Default value	Data type
Fields to NULL	Defines if SObject fields with null values must be considered by the Salesforce API. By default, Salesforce ignores SObjects with null fields.	False	Boolean

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Optional field to describe the connector configuration and any relevant business rules.	N/A	String

Additional notes

REST protocol

Composite operation

When using the Composite operation, you must remove the base path from the url property to ensure the connector works correctly. For example:

{
  "method": "POST",
  "url": "/services/data/v59.0/sobjects/Account",
  "referenceId": "refAccount",
  "body": {
    "Name": "Sample Account"
  }
}

In this case, remove the /services/data/v59.0 part from the url property.

After editing, the correct url should be:

{
  "method": "POST",
  "url": "/sobjects/Account",
  "referenceId": "refAccount",
  "body": {
    "Name": "Sample Account"
  }
}

Composite Update SObject Collections operation

The expected output for this operation is:

{
  "success": true,
  "data": [
    {
      "id": "003ak00000XgSkrAAF",
      "errors": [],
      "success": true
    },
    {
      "id": "003ak00000XgSksAAF",
      "errors": [],
      "success": true
    },
    {
      "id": "003ak00000XgSktAAF",
      "errors": [],
      "success": true
    }
  ]
}

Get Blob Field operation

For this operation, the file can be received in two ways:

• As a base64 string

• As a file stored in the local pipeline directory

By default, the file is received in base64 format. To store it as a local file in the pipeline directory, enable the Save as Local File flag and specify the file name in the File Name field. You can then use file reader connectors later in the flow to process the saved file.

Query operation

For any Query operation (such as Query, Query All, or Query More), use this pattern:

{
  "q": "SELECT Id, LastName, Company FROM Lead ORDER BY CreatedDate DESC LIMIT 5"
}

If you want to use Double Braces expressions, write it like this:

{
  "q": "{{ message.query }}"
}

Bulk 2.0 protocol

Create Batch operation

The expected output for this operation is:

{
  "success": true,
  "data": {
    "HttpResponseCode": "201",
    "HttpResponseText": "Created",
    "Content-type": "text/csv",
    "Sforce-Limit-Info": "api-usage=4184/15000"
  }
}