- 15 Jun 2023
- 12 Minutes to read
- Print
- DarkLight
Salesforce Steps
- Updated on 15 Jun 2023
- 12 Minutes to read
- Print
- DarkLight
Step Details | |
Introduced in Version | 3.0.0 |
Last Modified in Version | 8.12.0 |
Location | Integration > Salesforce |
Overview
The Salesforce Module allows users to integrate with Salesforce to automate their sales processes through pre-built Flow steps.
In Salesforce, several datatypes are commonly used: Account, Contact, Case, Contract, Event, Lead, Quote, Task, Product, and Opportunity. Each datatype represents a different aspect of the business and requires specific actions to work with them effectively.
For each datatype, there are pre-built steps that users can use within the workflows: Create, Update, Selective Update, Delete, and a few steps to retrieve the datatype from Salesforce.
The following article demonstrates detailed information on all the Salesforce Steps located in Flow Designer at Toolbox > Integrations > Salesforce.
Prerequisites
Common Input Fields on Salesforce Steps
Following are the common input properties on most of the Salesforce Steps:
- Override SOQL Version: By default, Salesforce Steps adhere to the API version of Salesforce configured in the System Settings > Salesforce Settings. Users can override this by specifying a different API version using the "Override SOQL Version" input property. This allows users to execute the steps with a specific Salesforce API version. The default API version is v35.
- Token ID: Users must provide a valid Token ID to authenticate and authorize access to Salesforce resources.
Create Steps
The table below lists unique input fields specific to each step. These Steps also allow users to define Custom Fields to be filled in Salesforce when configuring the inputs.
The "Create" step returns a string output with parameters such as "id," "success," and "errors."
Step Name | Step Description | Unique Input Field/s |
---|---|---|
Create Account | Creates an Account in the Salesforce | New Account: Exposes Account Fields to add a new Account in Salesforce. |
Create Case | Generates a new Case record to track and manage customer issues or inquiries. | New Case: Exposes the Case Fields to add a new Case in Salesforce. |
Create Contact | Establishes a new Contact record to store information about individuals associated with an Account. | New Contact: Exposes the Contact Fields to add a New Contact in Salesforce. |
Create Contract | Generates a new Contract record to define and manage agreements with customers or partners. | New Contract: Exposes the Contract Fields to add a new Contract in Salesforce. |
Create Event | Create a new Event record to schedule and track meetings, appointments, or other activities. | New Event: Exposes the Event Fields to add a new Event in Salesforce. |
Create Lead | Generates a new Lead record to capture potential sales opportunities. | New Lead: Exposes the Lead Fields to add a new Lead in Salesforce. |
Create Opportunity | Creates a new Opportunity record to track and manage potential deals or sales. | New Opp: Exposes the Opportunity Fields to add a new Opportunity in Salesforce. |
Create Opportunity With Product | Creates a new Opportunity record and associates it with a specific Product. |
|
Create Opportunity With Product Id | Creates a new Opportunity record and associates it with a specific Product. |
|
Create Price Book Entry | Creates a new Price Book Entry to define pricing and availability for a product in a price book. | Price Book Entry: Exposes the Price Book Entry Fields to enter the price of a product in a price book. |
Create Product | Creates a new Product Record to define and manage products or services offered. | New Task: Exposes the Product Fields to create a new Product record. |
Create Quote | Creates a new Quote record to provide pricing information for products or services. | New Quote: Exposes the Quote Fields to create a new Quote record. |
Create Task | Creates a new Task record to track and manage specific activities or to-dos. | New Task: Exposes the Task Fields to create a new task record. |
Delete Objects
For the Delete steps, the unique input field required is the [DataType] ID.
For example, users must provide the Account ID in the input field to delete a Salesforce Account.
Output is null returned for all the Delete Steps.
Step Name | Description | Unique Input Field/s |
---|---|---|
Delete Account | Removes an existing Account record from Salesforce. | Account Id: Provide the Account Id to delete the Account from Salesforce. |
Delete Case | Deletes a specific Case record from the Salesforce system. | Case ID: Provide the Case ID to delete the corresponding Case from Salesforce. |
Delete Contact | Removes a Contact record associated with an Account from the Salesforce database. | Contact ID: Provide the Contact ID to delete the corresponding Contact from Salesforce. |
Delete Contract | Deletes a Contract record that defines agreements with customers or partners. | Contract ID: Provide the Contract ID to delete the corresponding Contract from Salesforce. |
Delete Event | Removes an Event record that is scheduled or tracked in Salesforce. | Event ID: Provide the Event ID to delete the corresponding Event from Salesforce. |
Delete Lead | Deletes a Lead record representing a potential sales opportunity. | Lead ID: Provide the Lead ID to delete the corresponding Lead from Salesforce. |
Delete Opportunity | Removes an Opportunity record associated with potential deals or sales. | Opportunity ID: Provide the Opportunity ID to delete the corresponding Opportunity from Salesforce. |
Delete Opportunity Product | Deletes a specific Product associated with an Opportunity. | Opportunity Product ID: Provide the Opportunity Product ID to delete the corresponding Opportunity Product from Salesforce. |
Delete Price Book Entry | Removes a Price Book Entry that defines pricing and availability for a Product. | Price Book Entry: Provide the Price Book Entry ID to delete the corresponding Price Book Entry from Salesforce. |
Delete Product | Deletes a Product record representing a specific item or service. | Product ID: Provide the Product ID to delete the corresponding Product from Salesforce. |
Delete Quote | Removes a Quote record that provides pricing information for products or services. | Quote ID: Provide the Quote ID to delete the corresponding Quote from Salesforce. |
Delete Task | Deletes a Task record representing a specific activity or to-do item. | Task ID: Provide the Task ID to delete the corresponding Task from Salesforce. |
Find/Get Steps
Find and Get Steps to allow users to retrieve data from Salesforce.
On all the "Find & Get" steps, the "Custom Fields to Get" input field enables users to retrieve specific Custom Fields and the Standard Fields for the respective data type.
Find steps returns all the Fields and values for the data type.
Step Name | Description | Unique Input Field/s |
---|---|---|
Find Accounts By Name | Retrieve Accounts from Salesforce based on their name. | Name Starts With: Enter the account's name or the first alphabet of the name to retrieve all the accounts. |
Find All Opportunities | Retrieve all Opportunity records from Salesforce. | -- |
Find All Opportunities For Product | Retrieve all Opportunity records associated with a specific product. | Product ID: Provide the Product ID to retrieve all the opportunities. |
Find All Price Book Entries | Retrieve all Price Book entries from Salesforce. | -- |
Find All Products | Retrieve all Product records from Salesforce. | -- |
Find All Products For Opportunity | Retrieve all Products associated with a specific opportunity. | Opportunity ID: Provide the Opportunity Product ID to retrieve all the product details. |
Find All Quotes | Retrieve all Quote records from Salesforce. | -- |
Find All Tasks | Retrieve all Task records from Salesforce. | -- |
Find All Users | Retrieve all User records from Salesforce. | -- |
Find Cases By Account | Retrieve Cases associated with a specific Account. | Account ID: Provide the Account Id to retrieve the specific cases. |
Find Cases By Contact | Retrieve Cases associated with a specific Contact. | Contact ID: Provide the Contact ID to retrieve the specific cases. |
Find Cases By Subject Text | Retrieve Cases based on a specific subject text. | Subject Text: Provide the Subject Text to retrieve the specific cases. |
Find Cases By Account | Retrieve Cases associated with a specific Account. | Account ID: Provide the Account Id to retrieve Account details. |
Find Contacts By Name | Retrieve Contacts from Salesforce based on their Name. | Name Starts With: Provide the starting characters of the contact's name to retrieve the object. |
Find Contracts | Retrieve Contract records from Salesforce. | Name Starts With: Provide the starting characters of the contract's name to retrieve the object. |
Find Opportunity By Account | Retrieve an Opportunity record associated with a specific Account. | Account ID: Provide the Account id to retrieve an opportunity. |
Find Quotes By Opportunity | Retrieve Quotes associated with a specific Opportunity. | Opportunity ID: Provide the opportunity ID to retrieve the Opportunity field details. |
Find Tasks By Who | Retrieve Tasks assigned to a specific User. | Who ID: Provide the Who ID to retrieve the Task details. |
Find User By Name | Retrieve user records from Salesforce based on their name. | Name to Find: Provide the Name to find the users. |
Get Account By Id | Retrieve an Account record from Salesforce using its unique identifier. | Id: Provide the Salesforce Object ID to retrieve the Account details. |
Get Case by Number | Retrieve a Case record from Salesforce using its unique number. | Case Number: Provide the case number to retrieve the case details |
Get Contact By Id | Retrieve a Contact record from Salesforce using its unique identifier. | Id: Provide the Salesforce Object ID to retrieve event details. |
Get Event By ID | Retrieve an Event record from Salesforce using its unique identifier. | Id: Provide the Salesforce Object ID to retrieve event details. |
Get Lead By ID | Retrieve a Lead record from Salesforce using its unique identifier. | Id: Provide the Salesforce Object ID to retrieve the Lead details. |
Get Opportunity by ID | Retrieve an Opportunity record from Salesforce using its unique identifier. | Opportunity ID: Provide the Opportunity ID to retrieve the corresponding Opportunity details. |
Selective Update Steps
These steps allow users to update specific fields from an existing Data Type.
To update the fields, users must pass the Object ID in the input.
Output is null returned for all the Selective Update Steps.
Step Name | Step Name | Unique Input field/s |
---|---|---|
Selective Update Account | Modify specific fields of an existing Account record in Salesforce. | Account to Update: Exposes Account Fields to update specific fields. |
Selective Update Case | Update specific fields of a Case record in the Salesforce system. | Case to Update: Exposes the Case Fields to update specific fields. |
Selective Update Contact | Modify specific fields of a contact record associated with an Account in the Salesforce database. | Contact to Update: Exposes the Contact Fields to update specific fields. |
Selective Update Contract | Update specific fields and details of a Contract record defining agreements with customers or partners. | Contract to Update: Exposes the Contract Fields to update specific fields. |
Selective Update Event | Modify specific details or schedules of an Event record in Salesforce. | Event to Update: Exposes the Event Fields to update specific fields. |
Selective Update Lead | Update specific fields and information of a Lead record representing a potential sales opportunity. | Lead to Update: Exposes the Lead Fields to update specific fields. |
Selective Update Opportunity | Modify specific fields and details of an Opportunity record associated with potential deals or sales. | Opp to Update: Exposes the Opportunity Fields to update specific fields. |
Selective Update Opportunity Product | Update specific fields and details of a product associated with an Opportunity. | Opportunity Product: Exposes the Opportunity Product Fields to update specific fields. |
Selective Update Product | Modify specific fields and information of a product record representing a specific item or service. | Product to Update: Exposes the Product Fields to update specific fields. |
Selective Update Quote | Update specific fields and details of a Quote record providing pricing information for products or services. | Quote to Update: Exposes the Quote Fields to update specific fields. |
Selective Update Task | Modify specific fields and details of a Task record representing a specific activity or to-do item. | Task to Update: Exposes the Task Fields to update specific fields. |
Update Steps
Update steps will update the entire Salesforce object. If no values are provided for specific fields, those fields will be updated with a "null" value, replacing any existing data.
Output is null returned for all the Update Steps.
Step Name | Unique Input field/s | Unique Input field/s |
---|---|---|
Update Account | Modifies an existing Account record in Salesforce. | Account to Update: Exposes Account Fields to update specific fields. |
Update Case | Updates specific fields of a Case record in the Salesforce system. | Case to Update: Exposes the Case Fields to update specific fields. |
Update Contact | Modifies the information of a Contact record associated with an Account in the Salesforce database. | Contact to Update: Exposes the Contact Fields to update specific fields. |
Update Contract | Updates fields and details of a Contract record defining agreements with customers or partners. | Contract to Update: Exposes the Contract Fields to update specific fields. |
Update Event | Modifies the details or schedule of an Event record in Salesforce. | Event to Update: Exposes the Event Fields to update specific fields. |
Update Lead | Updates fields and information of a Lead record representing a potential sales opportunity. | Lead to Update: Exposes the Lead Fields to update specific fields. |
Update Opportunity | Modifies fields and details of an Opportunity record associated with potential deals or sales. | Opp to Update: Exposes the Opportunity Fields to update specific fields. |
Update Opportunity Product | Update specific fields and details of a product associated with an Opportunity. | Opportunity Product: Exposes the Opportunity Product Fields to update specific fields. |
Update Product | Modifies fields and information of a Product record representing a specific item or service. | Product to Update: Exposes the Product Fields to update specific fields. |
Update Quote | Updates fields and details of a Quote record providing pricing information for products or services. | Quote to Update: Exposes the Quote Fields to update specific fields. |
Update Task | Modifies the fields and details of a Task record representing a specific activity or to-do item. | Task to Update: Exposes the Task Fields to update specific fields. |
Advanced Steps
Following Steps are meant to be used for advanced use cases.
Step Name | Description | Unique Input Field/s | Unique Input Field/s |
---|---|---|---|
Copy Document to Salesforce Lightning | Allows copying a document from Salesforce Classic to a specific folder in Salesforce Lightning. |
| Output is null returned. |
Describe Global Objects | Retrieves information about the Global Objects and its metadata available in Salesforce. | -- | Returns all the SObjects. |
Get SOQL Escaped String | The GetSoqlEscapedString step escapes the input string, making it safe to include in a SOQL query. |
| Returns the Escaped SOQL String. |
Run SOQL Query | Executes a SOQL (Salesforce Object Query Language) query in Salesforce and allows data retrieval from Salesforce objects based on the specified query criteria. | SOQL Query: this input expects the SOQL query string that defines the criteria for retrieving data from Salesforce. | Returns a List of Records in the form of Dynamic Data Rows. |
Run SOQL Query Get JSON | Executes a SOQL (Salesforce Object Query Language) query in Salesforce and retrieves the query results in JSON format. | SOQL Query: this input expects the SOQL query string that defines the criteria for retrieving data from Salesforce. | Output is null returned. |
Salesforce Delete Data | Allows deleting data from Objects. | Service URL After Instance: URL endpoint for the Salesforce service after the instance. | Output is null returned |
Salesforce Insert Data | Allows inserting data in the Objects. |
| Output is null returned. |
Salesforce Update Data | Allows updating data in the Objects. |
| Output is null returned. |
Upload Document | Allows uploading the Documents to a specific Folder in Salesforce. |
| -- |
Upload File to Salesforce Lightning | Allows uploading the Documents to a specific Folder in Salesforce Lightning. |
| Output is null returned. |
Related Articles:
Feature Changes
Description | Version | Date | Developer Task |
---|---|---|---|
Added missing Steps in Salesforce Object | 8.12 | 07 Jun 2023 | [DT-037729] |