Salesforce

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

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

Parameters

Take a look at the configuration parameters of the component. They are divided into five tabs: General, Authentication, Salesforce API, Advanced Settings, and Documentation. Parameters supported by Double Braces expressions are marked with (DB).

General Tab

ParameterDescriptionDefault valueData type

Fail On Error

If the option is activated, the execution of the pipeline with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

False

Boolean

Authentication Tab

ParameterDescriptionDefault valueData type

Operation Account

Defines the account that is used to perform Salesforce operations. Supported accounts: Basic, Certificate-Chain.

N/A

Account

Salesforce Login URL (DB)

Defines the Salesforce URL instance used for authentication.

N/A

String

Salesforce Client Account

Defines the Salesforce Connected App account containing the Client ID. It must be an Oauth-provider account type.

N/A

oauth-provider account type

OAuth Authentication Flow

Defines the authentication used in the Salesforce app. Options: JWT Bearer Token Flow, Username-Password Flow.

N/A

String

Subject

Defines the user that is used for authentication with the Salesforce app.

N/A

String

Salesforce API Tab

The Salesforce component can automatically retrieve all available entities on the Salesforce platform to help configure the component.

To use this feature, you must first configure a valid Salesforce account and a Salesforce URL option. If an invalid account or URL is configured, the component will only allow a RAW mode usage. This means that the request must be manually configured. This behavior also applies if no account is selected in the Operation Account parameter.

ParameterDescriptionDefault valueData type

API Version

Defines the Salesforce API version.

{latest version}

String

APIs

Defines the Salesforce API to be accessed.

The available options are Rest, Bulk, Bulk 2.0 and RAW.

N/A

String

Operation

Defines the operation to be performed on Salesforce API. See below in a dedicated section the available options for each API.

N/A

String

Object Name

Defines the SObject to be handled in the request.

N/A

String

Interactive Mode

If the option is activated, the Salesforce component will expect to be configured by individual fields based on the selected SObject. Otherwise, it will expect a full JSON object containing all the required SObject data.

False

Boolean

RAW

When APIs parameter is set as RAW, the following parameters will be presented for configuring the request manually:

ParameterDescriptionDefault valueData type

Method

Defines the HTTP method.

GET

String

Path (DB)

Defines the Salesforce API service path to be requested.

N/A

String

Headers (DB)

Defines all types of headers required for the request.

N/A

String

Query params (DB)

Defines the query parameters required for the request.

N/A

String

Body (DB)

Defines the request body.

N/A

JSON

Advanced settings Tab

ParameterDescriptionDefault valueData type

Send NULL values

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

ParameterDescriptionDefault valueData type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Available options for the Operation parameter

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

Additional information - Composite operation

When using the Composite operation, it is important to remove the full path of the url property to ensure the correct behavior of the component. Consider the example below:

Body

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

In this case, the following excerpt must be removed from the url property:

/services/data/v59.0

After editing the property, the correct example should look like this:

Body

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

Last updated