Provides integration with Salesforce for reading and writing standard or custom objects through the Salesforce REST API.
0.0.0.7 - Initial release.
0.0.0.11 - Fix template: Returns array types.
0.0.0.14 - Fix template: Returns array.
0.0.0.15 - Fix template: Data types for front end compatibility.
0.0.0.16 - Fixed shared OAuthConnection lock handling.
0.0.0.17 - Changed template key format for AI system.
0.0.0.19 - Added interim invoke methods and changed the Query template Sample to Value.
0.0.0.29 - Invoke Methods completed with Create, Update and Delete.
0.0.0.30 - Minor updates: Template samples, token error messages and parameter name format.
0.0.0.31 - Added Get, QueryAll and Upsert methods.
0.0.0.32 - Minor maintenance updates.
0.0.0.33 - Removed user-configurable batch sizes and enabled automatic batching.
0.0.0.37 - Standardized mutation responses and changed query failures to surface as errors.
0.0.1.2 - Changed Get to return a single object.
Use a Salesforce OAuth Connection for all methods.
| Property |
Type |
Description |
Url |
String |
Salesforce login host used during OAuth, e.g. https://login.salesforce.com or https://test.salesforce.com. |
Client Id |
String |
The Salesforce Connected App consumer key. |
Client Secret |
Masked |
The Salesforce Connected App consumer secret. |
Scope |
String |
The OAuth scopes requested for the connection. The default is full refresh_token offline_access. |
Access Token |
Masked |
The short-lived OAuth access token populated after account authentication. |
Refresh Token |
Masked |
The OAuth refresh token used to obtain a new access token when the current one expires. |
Instance URL |
String |
The base URL for the authenticated Salesforce org. This is populated after account authentication. |
API Version |
String |
Optional Salesforce REST API version override. Leave blank to use the node default. |
Don't Interleave Request in Response |
Boolean |
Specifies whether input data is echoed back with the response. |
- Create a Salesforce Connected App and enable OAuth for it.
- Add the Flowgear callback URL shown during Connection setup to the Connected App configuration.
- Use
https://login.salesforce.com for production orgs and https://test.salesforce.com for sandbox orgs unless your Salesforce environment requires a custom domain.
- The default
Scope value is full refresh_token offline_access. Change it only when your Salesforce security policy requires a different scope set.
- Leave
API Version blank unless you need to target a specific Salesforce REST API version.
Salesforce exposes object-specific templates for each method so you can discover available objects and fields from the connected org.
Create, Update, Upsert, and Delete return one response row per input item. Each row includes a Flowgear object containing IsSuccess, Message, and a copy of the original item in Request.
Gets a single Salesforce record by ID and returns only the fields you request in IncludedFields. You must specify at least one field.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
ObjectName |
String |
The Salesforce object name to read, e.g. Account or Contact. |
Id |
String |
The Salesforce record ID to retrieve. |
IncludedFields |
Array |
The field names to include in the returned record. |
| Return |
Type |
Description |
Response |
Object |
An object containing the selected Salesforce fields, or an empty object when no record matches. |
Executes a SOQL query and streams current Salesforce records across all result pages.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
Query |
String |
The SOQL query to execute. Templates can prepopulate this for a selected object. |
| Return |
Type |
Description |
Response |
Array |
One response row per record returned by the query. |
Executes a SOQL query and streams Salesforce records including deleted or archived rows when Salesforce exposes them for the target object.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
Query |
String |
The SOQL query to execute. Templates can prepopulate this for a selected object. |
| Return |
Type |
Description |
Response |
Array |
One response row per record returned by the query, including deleted or archived rows when Salesforce includes them. |
Creates one or more Salesforce records for the selected object.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
ObjectName |
String |
The Salesforce object name to create, e.g. Account or Contact. |
Items |
Array |
The records to create. |
| Return |
Type |
Description |
Response |
Array |
One response row per input item. Mutation responses can include Salesforce fields such as id, success, created, errors, errorCode, and message when supplied by Salesforce. |
Updates one or more Salesforce records for the selected object.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
ObjectName |
String |
The Salesforce object name to update. |
IdFieldName |
String |
The field in each input item that identifies the record to update. Defaults to Id. |
Items |
Array |
The records to update. |
| Return |
Type |
Description |
Response |
Array |
One response row per input item. Mutation responses can include Salesforce fields such as id, success, errors, errorCode, and message when supplied by Salesforce. |
Creates or updates Salesforce records depending on whether the record already exists for the field identified by IdFieldName.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
ObjectName |
String |
The Salesforce object name to upsert. |
IdFieldName |
String |
The field used to identify each record. Use Id for Salesforce record IDs, or provide a writable external-ID field for larger upsert batches. |
Items |
Array |
The records to upsert. |
| Return |
Type |
Description |
Response |
Array |
One response row per input item. Mutation responses can include Salesforce fields such as id, success, created, errors, errorCode, statusCode, referenceId, and message when supplied by Salesforce. |
Deletes one or more Salesforce records.
| Parameter |
Type |
Description |
Connection |
Connection |
The Salesforce OAuth connection. |
IdFieldName |
String |
The field in each input item that contains the record ID to delete. Defaults to Id. |
Items |
Array |
The records to delete. |
| Return |
Type |
Description |
Response |
Array |
One response row per input item. Mutation responses can include Salesforce fields such as id, success, deleted, errors, errorCode, and message when supplied by Salesforce. |
Query returns current records only. Use QueryAll when your Workflow also needs deleted or archived rows.
Query and QueryAll page through Salesforce results internally, so you do not need a separate continuation method.
- The Node automatically batches
Create, Update, and Delete items into requests of up to 200 records.
- The Node automatically batches
Id-based Upsert items into requests of up to 25 records. External-ID upserts support up to 1000 records per composite request in 200-record subrequests.
- Templates are generated from the connected Salesforce org, so available objects and fields can differ between environments.
- External-ID
Upsert requires the target Salesforce object to expose a writable external-ID field in the connected org.