Salesforce Commands

To interact with data inside Salesforce® as part of a chain, add a step with a Salesforce connection command. For example:

  • Load, extract, and delete data via SOQL and bulk operations
  • Create and manage Salesforce objects
  • Update and create records

Connection Properties

To enable these commands, an IT admin first creates a Salesforce connection and configures its credentials and properties. The connection interacts with all versions of Salesforce Sales Cloud—Salesforce Essentials®, Lightning® Professional, Lightning Enterprise, and Lightning Unlimited via the REST API.

Instance
Input Detail
User Name Enter the Salesforce username to authenticate with
Password Enter the Salesforce password to authenticate with
Security Token Enter the Saleforce security token. To request one in Saleforce, go to Settings > My Personal Information > Reset Security Token.
Instance Enter the instance of Salesforce to connect to. In your Salesforce URL, this is the characters before salesforce.com, such as na73.

Permissions

For the connection to work properly, ensure the selected user has the proper permissions. The API Enabled permission is required, but your Salesforce administrator may decide which objects can be accessed. To verify the user's permissions in Salesforce, go to Administer > Manage Users > Profiles, and select their profile.

At a minimum, objects must have Read permissions enabled for the connector to perform the appropriate functions. You may add more permissions at your discretion. For example, to make bulk changes to specific types of Salesforce objects, they must have the Update permission enabled.

Bulk Delete

Deletes a large volume of records based on a comma-separated values (CSV) file.

Inputs

Input Detail
Concurrency Mode Select whether to process records at the same time or sequentially.
  • To process records at the same time, select Parallel.
  • To process records sequentially, select Serial.
SObject Name Enter the type of SObject to perform the operation on
Input File Enter the file that contains the records to delete
File Format Select whether the Input File input is CSV, JSON, or XML
Batch Size Enter the number of records to process per batch. We recommend you leave the default.
Wait for Completion To poll Salesforce and only move to the next command when all records are processed, check this box. To trigger the command and immediately move onto the next step, uncheck this box.

Outputs

Output Output Type
Bulk Delete Error Log File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Bulk Insert

Inserts a large volume of records based on CSV file

Inputs

Input Detail
Concurrency Mode Select whether to process records at the same time or sequentially.
  • To process records at the same time, select Parallel.
  • To process records sequentially, select Serial.
SObject Name Enter the type of SObject to perform the operation on
Input File Enter the file that contains the records to insert
File Format Select whether the Input File input is CSV, JSON, or XML
Batch Size Enter the number of records to process per batch. We recommend you leave the default.
Wait for Completion To poll Salesforce and only move to the next command when all records are processed, check this box. To trigger the command and immediately move onto the next step, uncheck this box.

Outputs

Output Output Type
Bulk Insert Error Log File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Bulk Query

Queries a large volume of records

Inputs

Input Detail
Concurrency Mode Select whether to process records at the same time or sequentially.
  • To process records at the same time, select Parallel.
  • To process records sequentially, select Serial.
SObject Name Enter the type of SObject to perform the operation on
SOQL Query Enter the SOQL query to execute

Outputs

Output Output Type
Bulk Query Results CSV File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Bulk Update

Updates a large volume of records

Inputs

Input Detail
Concurrency Mode Select whether to process records at the same time or sequentially.
  • To process records at the same time, select Parallel.
  • To process records sequentially, select Serial.
SObject Name Enter the type of SObject to perform the operation on
Input File Enter the file that contains the records to update
File Format Select whether the Input File input is CSV, JSON, or XML
Batch Size Enter the number of records to process per batch. We recommend you leave the default.
Wait for Completion To poll Salesforce and only move to the next command when all records are processed, check this box. To trigger the command and immediately move onto the next step, uncheck this box.

Outputs

Output Output Type
Bulk Update Error Log File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Bulk Upsert

Performs an upsert on a large volume of records, either updating existing records or creating new ones based on the external ID field

Inputs

Input Detail
Concurrency Mode Select whether to process records at the same time or sequentially.
  • To process records at the same time, select Parallel.
  • To process records sequentially, select Serial.
SObject Name Enter the type of SObject to perform the operation on
Input File Enter the file that contains the records to upsert
File Format Select whether the Input File input is CSV, JSON, or XML
Batch Size Enter the number of records to process per batch. We recommend you leave the default.
Wait for Completion To poll Salesforce and only move to the next command when all records are processed, check this box. To trigger the command and immediately move onto the next step, uncheck this box.
External ID To identify whether a record already exists or needs to created, enter the external ID field required for the object involved in the upsert

Outputs

Output Output Type
Bulk Upsert Error Log File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Create Record

Creates a new record in Salesforce

Inputs

Input Detail
Name Enter the name of the SObject to create the record under
Fields Enter the record fields to update, in the format of FIELD_NAME:VALUE

Outputs

Output Output Type
New Record ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Delete Record

Deletes a record in Salesforce given an ID

Inputs

Input Detail
ID Enter the ID of the record to delete. If the ID is unknown, enter an external ID in the format of EXTERNAL_ID_NAME:VALUE, such as Name:John.
Name Enter the name of the SObject to delete the record under

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Get Record

Retrieves a record from Salesforce given an ID

Inputs

Input Detail
ID Enter the ID of the record to retreive
Name Enter the name of the SObject to retrieve the record under
Fields Enter the report's fields to include (optional)

Outputs

Output Output Type
Get Record JSON JSON

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

List Logins

Lists logins in the Salesforce environment

Inputs

None

Outputs

Output Output Type
List Logins CSV File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

List Objects

Lists SObjects from Salesforce

Inputs

None

Outputs

Output Output Type
List Objects CSV File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

List Reports

Lists reports from Salesforce

Inputs

None

Outputs

Output Output Type
List Reports CSV File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

SOQL Query

Executes a SOQL query, and generates its results as a CSV file

Inputs

Input Detail
Query Enter the SOQL query to execute
Query Command Select whether to include deleted records.
  • To exclude deleted records, select Query.
  • To include deleted records, select QueryAll.

Outputs

Output Output Type
SOQL Query Output File

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

SObject - Create

Creates a new SObject in Salesforce

Inputs

Input Detail
Name Enter the name of the new SObject. To denote this is a custom object, Salesforce automatically appends __c.
Fields Enter the record fields to create, in the format of FIELD_NAME:TYPE, where TYPE corresponds to a Salesforce field type

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

SObject - Delete

Deletes SObjects in Salesforce

Inputs

Input Detail
Name Enter the name of the SObjects to create

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure

Update Records

Updates a record in Salesforce given an ID and field values |

Inputs

Input Detail
ID Enter the ID of the record to update
Name Enter the name of the SObject to update the record under
Fields Enter the record fields to update, in the format of FIELD_NAME:VALUE

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error General failure