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.
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 |
Controls whether mutation responses echo the input request payload alongside each response row. |
- 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.
Gets a single Salesforce record by id and returns only the fields you request in IncludedFields.
| 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 |
Array |
A single response row containing the selected Salesforce fields for the requested record. |
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. |
BatchSize |
Integer |
The number of records to send per request. Defaults to 200. |
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. |
BatchSize |
Integer |
The number of records to send per request. Defaults to 200. |
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. |
BatchSize |
Integer |
The number of records to send per batch. Defaults to 25 when IdFieldName is Id and 200 for external-id subrequests. |
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. |
BatchSize |
Integer |
The number of records to send per request. Defaults to 200. |
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 in V2.Create, Update, and Delete support up to 200 records per request.Upsert supports two batching modes: Id-based upserts support up to 25 records per request, while 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.