Salesforce Component

Query, create, update or delete Salesforce records

Component key: salesforce

Description

Salesforce is a customer relationship management (CRM) platform. This component gives you the ability to manage sales leads and records within the Salesforce platform.

API Documentation

This component was built using the following API References currently utilizing v63.0 by default.

This component includes CRUD (create, read, update, delete) actions for records and a create action for leads. For more complex queries, you can use Salesforce Object Query Language and the query action of this component.

Listening for events in Salesforce

Salesforce can notify you when a record is created, updated, deleted, or undeleted. To listen for these events, you can use the Outbound Messaging feature of Salesforce.

When you create a Salesforce Flow, you specify which conditions cause the rule to run. When those conditions are met, Salesforce sends an outbound message to the URL you specified in the outbound message.

You may use the Flow Outbound Message Webhook trigger to run on instance deploy it will configure the necessary Flows and outbound messages for you.

Example integration

We have an example integration in our GitHub examples repo that you can import and test yourself.

Example Integration

The integration has three flows:

Initial Account Import runs when an instance is first deployed. It uses SOQL to query pages of Account records, and for each page it loops over results and posts those results to "Acme". Account records are translated using the field mapping values the customer selected with a code step.
Process Salesforce Outbound Messages receives notifications when an Account is changed. It fetches the modified account, maps data from SFDC to a format that "Acme Corp" understands, and sends the request to Acme. The subscription to a Salesforce Outbound Message and Workflow Rule are performed on instance deploy automatically. Those resource are deleted on instance removal.
Create Account from Acme provides bi-directional data flow from SFDC and Acme. Acme (you) can send a webhook request to this flow via its webhook URL, and a corresponding Account will be created in SFDC. A payload should look like this:
```
{
"acct_name": "My New Account",
"revenue": 12345
}
```

The integration also has a custom field mapper, which fetches fields on the Account object and allows the user to map them to fields on the Acme object. The field mapper in the example integration is built using the Code component, but we recommend building a custom field mapper in a custom component so you can test it locally and dynamically pull data from your app, as well. See Building a Field Mapper Data Source.

Connections

Basic Authentication

key: basic

When using Basic Auth, supply a Salesforce username and password. Depending on the Salesforce setup, the password may have a security token attached to it. If security tokens in the Salesforce account are disabled, the password to supply is simply the Salesforce password. If security tokens are enabled in the Salesforce account, then the password to enter is the concatenation of the password and the security token.

For example, if the Salesforce password is p@$sw0rD and the security token that Salesforce provides is ExAmPlE0000000000ExAmPlE, then enter p@$sw0rDExAmPlE0000000000ExAmPlE as the password. Manage security tokens by clicking the profile picture on the top-right of Salesforce, selecting My Settings, and then opening Personal -> Reset My Security Token.

Input	Notes	Example
Login URL	Your SalesForce Login URL - required for Basic Auth	https://my-company.my.salesforce.com/
Password	The password of the Salesforce account
Username	The username of the Salesforce account	myUser

OAuth 2.0

key: oauth2

OAuth 2.0 provides a simple way for users to authorize applications. To use OAuth 2.0, create and configure a Connected App within Salesforce:

Log in to the Salesforce account
Navigate to Setup by clicking the gear icon in the upper right corner
Open Apps > External Client Apps > Settings
Enable Allow creation of connected apps if it is not already enabled
Select New Connected App
- When creating the "Connected App" be sure to check Enable OAuth Settings, and enter the OAuth callback URL https://oauth2.prismatic.io/callback as a Callback URL.
- Consult Salesforce to determine the proper OAuth Scopes to assign. To grant integrations the same permissions that the user authenticating through OAuth has, select Full access (full). Also select Perform requests at any time (refresh_token, offline_access). Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Manage Connected Apps in Salesforce Platform Tools

Next select Save and Continue. Then, get the app's Consumer Key and Consumer Secret by selecting Manage Consumer Details. Take note of these keys:

Manage Connected Apps in Salesforce Platform Tools with Consumer and Secret Keys

To return to this screen, select Apps > App Manager, click the dropdown menu to the right of the app and select Edit. From there, manage callback URLs.

Now, add a Salesforce action to the integration. This will automatically create a connection config variable for Salesforce. Enter the Consumer Key and Consumer Secret noted previously.

Users should now be able to authenticate through Salesforce using OAuth 2.0.

Connecting to a Salesforce Sandbox Account

To connect to a Salesforce sandbox organization for testing purposes, edit the connection's Authorize URL, Token URL and Revoke URLs to read test.salesforce.com instead of login.salesforce.com. Be sure to change these values back when testing is done.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Salesforce	https://login.salesforce.com/services/oauth2/authorize
Consumer Key		3MVG9ZL1aBcDeFGHjklMNOpQRsTUVwXyZ1234567890abcdefg
Consumer Secret
Revoke URL	The OAuth 2.0 Revocation URL for Salesforce	https://login.salesforce.com/services/oauth2/revoke
Scopes	A space-delimited set of one or more scopes to get the user's permission to access.
Token URL	The OAuth 2.0 Token URL for Salesforce	https://login.salesforce.com/services/oauth2/token

OAuth 2.0 Client Credentials

key: salesforceClientCredentials

OAuth 2.0 Client Credentials provides server-to-server authentication without user interaction. Use this connection type for integrations that run in the background without a user context.

This connection requires a Connected App configured for Client Credentials. If a Connected App already exists for OAuth 2.0 (see OAuth 2.0 connection documentation), enable Client Credentials on that app. Otherwise, create a new Connected App following the OAuth 2.0 setup steps first.

Enable Client Credentials Flow

Navigate to Setup > Apps > App Manager
Find the Connected App and select Edit from the dropdown menu
Under API (Enable OAuth Settings), check Enable Client Credentials Flow
Click Save

Configure Run As User

The Client Credentials flow requires specifying which user the integration will authenticate as:

From the Connected App, select Manage from the dropdown menu
Click Edit Policies
Under Client Credentials Flow, select a user from the Run As dropdown
Click Save

The selected user's permissions determine what the integration can access.

Configure the Connection

Instance URL: Enter the Salesforce My Domain URL (e.g., https://acme-corp.my.salesforce.com)
Consumer Key: Enter the Consumer Key from the Connected App
Consumer Secret: Enter the Consumer Secret from the Connected App

Connecting to a Salesforce Sandbox

For sandbox environments, use the sandbox My Domain URL format: https://your-company--sandbox.sandbox.my.salesforce.com

Input	Notes	Example
Consumer Key	The Consumer Key from your Salesforce Connected App.	3MVG9ZL1aBcDeFGHjklMNOpQRsTUVwXyZ1234567890abcdefg
Consumer Secret	The Consumer Secret from your Salesforce Connected App.
Instance URL	Your Salesforce My Domain URL (e.g., https://your-company.my.salesforce.com). For sandbox, use https://your-company--sandbox.sandbox.my.salesforce.com.	https://acme-corp.my.salesforce.com
Scopes	Scopes are configured in the Salesforce Connected App settings.
Token URL		{{#instanceUrl}}/services/oauth2/token

Triggers

Flow Outbound Message Webhook

Receive Flow-based outbound messages from Salesforce. | key: flowOutboundMessageTrigger

Input	Notes	Example
Connection	The Salesforce connection to use.
Fields	Fields to include in the Outbound Message.	Name, Phone, Email, etc.
Filter Formula	Optional formula to filter which records trigger the flow.	ISCHANGED(Email) && NOT(ISBLANK(Email))
Flow Metadata	Additional Flow metadata in JSON format. This will be merged with other inputs.
Prefix	Sets a prefix to the Flow Name and Outbound Messages created. Must start with a letter, can contain letters, numbers, underscores, and be at most 15 characters.	Acme_Services
Trigger Record Type	The Record Type that will trigger this integration flow.
Trigger On	When to trigger the flow (record creation, update, or both).	CreateAndUpdate
Version	Salesforce API Version Number.	63.0

The Flow Outbound Message trigger can manage Salesforce Flow based webhook integrations for your instance. Unlike traditional webhook setups that require manual configuration in Salesforce Setup, this trigger handles the entire Flow lifecycle automatically.

When the trigger is used in a flow:

On Instance Deploy: The trigger automatically creates a record triggered Flow in your Salesforce org with an outbound message action pointing to your instance's unique webhook URL.

The trigger supports different Flow trigger conditions:

Create: Triggers when new records are created
Update: Triggers when existing records are updated
Create or Update: Triggers on both record creation and updates

New and Updated Records

Checks for new and updated records in Salesforce on a recurring schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	You can set the maximum number of records the trigger will fetch. By default, it will fetch up to 20,000 records.	20000
Record Type	The type of Salesforce Record.	Account
Show New Records	Show new records.	true
Show Updated Records	Show updated records.	true
Version	Salesforce API Version Number.	63.0

Webhook

Trigger for handling webhook requests from the Salesforce platform. Returns the expected response to Salesforce and converts the XML payload to an object for more convenient use in the rest of the flow. | key: webhook

You can configure a Salesforce outbound message to send information to a flow's webhook URL under certain conditions (an "Account" is created, an "Opportunity" is updated, etc.).

This trigger responds to a Salesforce outbound message request with the acknowledgement (ack) response that Salesforce expects.

Since Salesforce always sends XML payloads, the XML is deserialized automatically as part of the trigger, so no additional XML deserialization step is required.

Workflow Outbound Message Webhook (Deprecated)

Receive workflow rule outbound messages from Salesforce. | key: workflowTrigger

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Fields	Fields to include in the Outbound Message.	Name, Phone, Email, etc.
Outbound Message Name	The name of the outbound message to be used.	MyOutboundMessage
Record Type	The type of Salesforce Record.	Account
Trigger Type	Conditions in which the trigger fires. On All Changes: The workflow rule is considered on all changes. On Create Only: Considered on creation. On Create or Meets Rule Criteria: Considered on create and when it is updated to meet any Rule Criteria configured to the workflow rule.	onAllChanges
Version	Salesforce API Version Number.	63.0
Workflow Rule Name	The name of the workflow rule to be used.	MyWorkflowRule

Action Required: Salesforce Workflow Rules Retiring December 31, 2025

Salesforce is ending support for Workflow Rules and Process Builder on December 31, 2025 and will no longer provide customer support or bug fixes for Workflow Rules and Process Builder. While existing webhook subscriptions may continue to function, they will become unsupported after the deadline. It is recommended that you migrate your webhook subscriptions to the Flow Builder by that time.

As a solution, the Salesforce component now offers Flow based features to replace the workflow rule functionality. Outbound Message functionality will remain unaffected and Flows are compatible with Outbound Messages. For an overview of the new Flow trigger functionality please reference the following Flow Outbound Message Webhook demonstration.

Migrating Workflow Rules to Flows: It is recommended to migrate your current integrations to Flows before the end of the year.

To migrate, simply update and configure your integrations to the new Flow Outbound Message Webhook trigger. On deploy, the trigger will automatically create a brand new active Flow and Outbound Message. The original Outbound Message will be removed to disable the Workflow Rule automation.

The migration only removes the prior Outbound Message. The Workflow Rule will remain intact but is no longer active.
The payload returned by the new trigger will be different and may break integration references. Please review and update any input steps that reference the trigger payload.

Data Sources

Record Type Field Preview

A list of fields of the specified Record Type for use as a preview during configuration. | key: previewRecordTypeFields | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Record Type	The type of Salesforce Record	Account
Version	Salesforce API Version Number.	63.0

Record Type Field Value Preview

A list of values of the specified Record Type field for use as a preview during configuration. | key: previewRecordTypeFieldValues | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Field Name	The name of field on the Record Type for which to fetch values.	Account Name
Record Type	The type of Salesforce Record	Account
Value Count	The maximum number of values to fetch. Must be less than or equal to 20.	5
Version	Salesforce API Version Number.	63.0

Record Type Fields

A map of a list of fields to Salesforce Record Type fields. | key: mapRecordTypeFields | type: objectFieldMap

Input	Notes	Example
Connection	The Salesforce connection to use.
Include Supplemental Metadata	When true, will store all data retrieved from the Salesforce Metadata API for each mapped Record Type.	false
Mapping Fields	Provide an ObjectFieldMap that contains the list of fields to map and optional default mappings to object fields.	{ "fields": [ { "field": { "key": "name", "label": "Name" }, "defaultObject": { "key": "account", "label": "Account" }, "defaultField": { "key": "contactName", "label": "Contact Name" } }, { "field": { "key": "address", "label": "Address" }, "defaultObject": { "key": "account", "label": "Account" }, "defaultField": { "key": "contactAddress", "label": "Contact Address" } } ] }
Selected Record Types	The selected Record Types to use as choices for performing field mapping.
Version	Salesforce API Version Number.	63.0

Record Types

A subset of Salesforce Record Types. | key: selectRecordTypes | type: objectSelection

Input	Notes	Example
Connection	The Salesforce connection to use.
Default Selected Record Types	The names of the Record Types to default in a selected state.
Include All Custom Record Types	When true, will include all Custom Record Types, even those not included in Record Type Name Filter.	true
Include Only Top Level Record Types	When true, will include only Record Types that are top-level, meaning not subtypes of other Types, regardless of other filters.	false
Record Type Filter	The names or labels of the Record Types to include; if blank then all types are included. Uses case-insensitive matching.
Show Triggerable Only	If true, only triggerable objects are returned. If false, all objects are returned.	false
Version	Salesforce API Version Number.	63.0

Record Types With Fields

A subset of Salesforce Record Types. | key: selectRecordTypesWithFields | type: objectSelection

Input	Notes	Example
Connection	The Salesforce connection to use.
Default Selected Record Types	The names of the Record Types to default in a selected state.
Include All Custom Record Types	When true, will include all Custom Record Types, even those not included in Record Type Name Filter.	true
Include Only Top Level Record Types	When true, will include only Record Types that are top-level, meaning not subtypes of other Types	false
Record Type Filter	The names or labels of the Record Types to include; if left blank no record types are returned. Uses case-insensitive matching.
Show Triggerable Only	If true, only triggerable objects are returned. If false, all objects are returned.	false
Version	Salesforce API Version Number.	63.0

Select Bulk Job

A picklist of bulk jobs. | key: selectBulkJob | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Contact

A picklist of contacts. | key: selectContact | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Customer

A picklist of customers. | key: selectCustomer | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Flow

Select a Salesforce Flow from available flows in the org | key: selectFlow | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Lead

A picklist of leads. | key: selectLead | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Opportunity

A picklist of opportunities. | key: selectOpportunity | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Outbound Message

Select a Salesforce Outbound Message from available outbound messages in the org | key: selectOutboundMessage | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Profile

A picklist of profiles. | key: selectProfile | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select Record Type

A picklist of record types. | key: selectRecordType | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Select User

A picklist of users. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Salesforce connection to use.
Filter Query	Filter results by matching this text.	Some text to filter by
Version	Salesforce API Version Number.	63.0

Actions

Abort Bulk Job

Aborts a Job | key: abortBulkJob

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "7506g00000DhRA2AAN",
    "operation": "insert",
    "object": "Account",
    "createdById": "0056g000005HQPyAAO",
    "createdDate": "2018-12-18T22:51:36.000+0000",
    "systemModstamp": "2018-12-18T22:51:58.000+0000",
    "state": "Open",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 60,
    "jobType": "V2Ingest",
    "contentUrl": "services/data/v60.0/jobs/ingest/7506g00000DhRA2AAN/batches",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "retries": 0,
    "totalProcessingTime": 0,
    "apiActiveProcessingTime": 0,
    "apexProcessingTime": 0
  }
}

Abort Bulk Query Job

Aborts a query job. | key: abortBulkQueryJob

Input	Notes	Example
Connection	The Salesforce connection to use.
Query Job Id	The ID of the query job to abort	750R0000000zlh9IAA
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "750R000000146UvIAI",
    "operation": "query",
    "object": "Account",
    "createdById": "005R0000000GiwjIAC",
    "createdDate": "2018-12-18T16:15:31.000+0000",
    "systemModstamp": "2018-12-18T16:15:32.000+0000",
    "state": "Aborted",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 46
  }
}

Activate Flow

Activate a Flow in Salesforce by name | key: activateFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Add Attachment

Attach a file to a Parent record object (Account, Opportunity, etc.) | key: addAttachment

Input	Notes	Example
Connection	The Salesforce connection to use.
File Contents	Reference a file from a previous step, or enter plain text here.	Hello World
File Name	The name of the file you wish to upload	file.pdf
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "015D0000000N3ZZIA0",
    "errors": [],
    "success": true
  }
}

Add User Permission Set

Adds a Permission Set to the specified User | key: addUserPermissionSet

Input	Notes	Example
Connection	The Salesforce connection to use.
Permission Set	Provide the name of the Permission Set.	Standard User
User Name	Provide a User Name.	JohnDoe
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Bulk Insert Records

Creates new Salesforce Records | key: bulkInsertRecords

Input	Notes	Example
Connection	The Salesforce connection to use.
External ID Field Name	The name of the column that refers to the External ID Field	ExtId__c
File	The file to be uploaded
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "id": "015D0000000N3ZZIA0",
      "errors": [],
      "success": true
    }
  ]
}

Bulk Upsert Records

Updates Salesforce Records if they exists, otherwise creates new Salesforce Records | key: bulkUpsertRecords

Input	Notes	Example
Connection	The Salesforce connection to use.
External ID Field Name	The name of the column that refers to the External ID Field	ExtId__c
File	The file to be uploaded
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "id": "015D0000000N3ZZIA0",
      "errors": [],
      "success": true
    }
  ]
}

Complete Upload Bulk Job

Notifies Salesforce servers that the upload of job data is complete and is ready for processing. You can’t add any more job data. | key: completeUploadBulkJob

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "7506g00000DhRA2AAN",
    "operation": "insert",
    "object": "Account",
    "createdById": "0056g000005HQPyAAO",
    "createdDate": "2018-12-18T22:51:36.000+0000",
    "systemModstamp": "2018-12-18T22:51:58.000+0000",
    "state": "Open",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 60,
    "jobType": "V2Ingest",
    "contentUrl": "services/data/v60.0/jobs/ingest/7506g00000DhRA2AAN/batches",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "retries": 0,
    "totalProcessingTime": 0,
    "apiActiveProcessingTime": 0,
    "apexProcessingTime": 0
  }
}

Composite Requests

Send multiple requests in a single HTTP call | key: compositeRequests

Input	Notes	Example
All Or None	Specifies what to do when an error occurs while processing a subrequest. If the value is true, the entire composite request is rolled back. The top-level request returns HTTP 200 and includes responses for each subrequest.	true
Collate Subrequests	Controls whether the API collates unrelated subrequests to bulkify them (true) or not (false).	false
Composite Request	Collection of subrequests to execute.
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "hasErrors": false,
    "results": [
      {
        "statusCode": 204,
        "result": null
      },
      {
        "statusCode": 200,
        "result": {
          "attributes": {
            "type": "Account",
            "url": "/services/data/v60.0/sobjects/Account/001D000000K0fXOIAZ"
          },
          "Name": "NewName",
          "BillingPostalCode": "94105",
          "Id": "001D000000K0fXOIAZ"
        }
      }
    ]
  }
}

Create Account

Create a Salesforce Account Record | key: createAccount

Input	Notes	Example
Billing City	The city of the object's billing address.	Cupertino
Billing Country	The country of the object's billing address.	CA
Billing Postal Code	The zip code of the object's billing address.	94024
Billing State	The state of the object's billing address.	CA
Billing Street Address	The street address of the billing object.	4 Privet Drive
City	The city of the object's address.	Cupertino
Connection	The Salesforce connection to use.
Country	The country of the object's address.	United States
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Number of Employees	The number of employees associated with the object.	30
Field Values	Name of a record's fields and their corresponding values
Industry	The industry of the account record.
Name	The name of the object.	myExampleObject
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
Annual Revenue	The estimated annual revenue of the object.	38000
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Account Type	The type of account record.
Version	Salesforce API Version Number.	63.0
Website	Provide a valid URL for the website of the object.	website-example.com

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Create Bulk Job

Creates a job representing a bulk operation and its associated data that is sent to Salesforce for asynchronous processing. | key: createBulkJob

Input	Notes	Example
Assignment Rule Id	The ID of an assignment rule to run for a Case or a Lead. The assignment rule can be active or inactive.	01Q7F0000004g8eUAA
Column Delimiter	The delimiter to use for the columns	COMMA
Connection	The Salesforce connection to use.
External ID Field Name	The external ID field in the object being updated. Only needed for upsert operations. Field values must also exist in CSV job data.	ExtId__c
Line Ending	The line ending to use for the file	LF
Object	The object type for the data being processed. Use only a single object type per job.	Account
Operation	The operation to execute	insert
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "750R0000000zlh9IAA",
    "operation": "query",
    "object": "Account",
    "createdById": "005R0000000GiwjIAC",
    "createdDate": "2018-12-10T17:50:19.000+0000",
    "systemModstamp": "2018-12-10T17:51:27.000+0000",
    "state": "JobComplete",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 46,
    "jobType": "V2Query",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "numberRecordsProcessed": 500,
    "retries": 0,
    "totalProcessingTime": 334,
    "isPkChunkingSupported": true
  }
}

Create Bulk Query Job

Creates a query job. | key: createBulkQueryJob

Input	Notes	Example
Column Delimiter	The delimiter to use for the columns	COMMA
Connection	The Salesforce connection to use.
Line Ending	The line ending to use for the file	LF
Operation	The operation to execute	query
Query	The query to execute	SELECT Id FROM Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "750R0000000zlh9IAA",
    "operation": "query",
    "object": "Account",
    "createdById": "005R0000000GiwjIAC",
    "createdDate": "2018-12-10T17:50:19.000+0000",
    "systemModstamp": "2018-12-10T17:50:19.000+0000",
    "state": "UploadComplete",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 46,
    "lineEnding": "LF",
    "columnDelimiter": "COMMA"
  }
}

Create Contact

Create a Salesforce contact | key: createContact

Input	Notes	Example
Assistant	Provide a string value that represents the name of the contact's assistant.	Jane Doe
Assistant's Phone	Provide a string value that represents the phone number of the contact's assistant.	18005555555
Billing City	The city of the object's billing address.	Cupertino
Billing Country	The country of the object's billing address.	CA
Billing Postal Code	The zip code of the object's billing address.	94024
Billing State	The state of the object's billing address.	CA
Billing Street Address	The street address of the billing object.	4 Privet Drive
Birthdate	Provide a string value that represents the birthdate.	YYYY-MM-DD
City	The city of the object's address.	Cupertino
Connection	The Salesforce connection to use.
Country	The country of the object's address.	United States
Department	Provide a string value that represents the name of the contact's department.	Sales
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address	The email address for the object.	someone@example.com
Fax	Provide a string value for the fax number.	18008999372
Field Values	Name of a record's fields and their corresponding values
First Name	The first name of the contact at the company	John
Last Name	The last name of the contact at the company	Smith
Mobile Phone	The mobile phone number for the object.	18005555555
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Title	The title of the object.	Example Title
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Create Customer

Create a Salesforce customer | key: createCustomer

Input	Notes	Example
Connection	The Salesforce connection to use.
Customer Status Type	The status of the customer account.	Active
Last Reference Date	The timestamp for when the current user last viewed a record related to this record.	2021-09-01T00:00:00.000Z
Last Viewed Date	The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.	2021-09-01T00:00:00.000Z
Name	Name of this customer.	myExampleObject
Owner Id	The ID of the user who owns the record.	00570000001a2fF
Party Id	Represents the individual object related to this customer record.	0697000000K2g5AAAR
Total Lifetime Value	The total revenue amount gained from this customer.	1000
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Create Flow

Create a draft flow in Salesforce | key: createFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Flow Metadata	Additional Flow metadata in JSON format. This will be merged with other inputs.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Run In Mode	The context user mode the Flow runs as. DefaultMode respects user permissions and sharing rules. SystemModeWithoutSharing grants broad data access but may lead to security warnings.	DefaultMode
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Create Lead

Create a Salesforce Lead Record | key: createLead

Input	Notes	Example
City	The city of the object's address.	Cupertino
Company	The name of the company	Widgets Inc.
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address	The email address for the object.	someone@example.com
Number of Employees	The number of employees associated with the object.	30
Field Values	Name of a record's fields and their corresponding values
First Name	The first name of the contact at the company	John
Last Name	The last name of the contact at the company	Smith
Lead Source	Provide a value for the source of the lead.	Web
Lead Status	The status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted.	Converted
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
Rating	The rating for the lead.
Annual Revenue	The estimated annual revenue of the object.	38000
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Title	The title of the object.	Example Title
Version	Salesforce API Version Number.	63.0
Website	Provide a valid URL for the website of the object.	website-example.com

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Create Metadata

Create new metadata components. | key: createObjectsFromMetadata

Input	Notes	Example
Connection	The Salesforce connection to use.
Metadata	See https://jsforce.github.io/document/#create-metadata for related documentation.
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Create Metadata Fields

Create custom fields from metadata | key: createFieldsFromMetadata

Input	Notes	Example
Connection	The Salesforce connection to use.
Metadata	See https://jsforce.github.io/document/#create-metadata for related documentation.
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Create Opportunity

Create a Salesforce Opportunity Record, which is a sale or pending deal | key: createOpportunity

Input	Notes	Example
Account ID	The ID of the account to reference.	0017000000hOMChAAO
Amount	Provide a number that represents the opportunity amount.	38000
Close Date	The date the sale will close.	YYYY-MM-DD
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Lead Source	Provide a value for the source of the lead.	Web
Name	The name of the object.	myExampleObject
Next Step	Provide a string value for the next step of the sale.	Follow up with the client
Opportunity Type	Provide a value for what type of opportunity this is.
Probability	The probability of the success of the sale.	50
Stage	The stage the sale is currently in.	Prospecting
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Create Outbound Message

Create a new Outbound Message. | key: createWorkflowOutboundMessage

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	Dynamic Fields, provided by value collection config variable, to include in the Outbound Message
Endpoint URL	The endpoint URL to send the outbound message / webhook to	https://example.com/webhook
Fields	Fields to include in the Outbound Message.	Name, Phone, Email, etc.
Integration User Email	The email of the user under which the payload is sent. If not provided, the current user will be used	jhon@doe.com
Outbound Message Name	Name of the Outbound Message	MyOutboundMessage
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Create Profile

Create a Salesforce Profile | key: createProfile

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Description of the profile.
Name	The name of the profile.
Permissions	Key/value object with permission name keys and boolean value indicating if a permission is granted or not. Use 'Describe Permissions' to retrieve the permissions of a Record Type.
User License	Identifier for associated UserLicense.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Create Record

Create a Salesforce Record | key: createRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Create User

Create a Salesforce User | key: createUser

Input	Notes	Example
Alias	Provide an Alias for the User.	JD
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address	The email address for the object.	someone@example.com
Field Values	Name of a record's fields and their corresponding values
First Name	The first name of the contact at the company	John
Last Name	The last name of the contact at the company	Smith
Profile	Provide the name of the User Profile.	Standard User
Time Zone	Time Zone in the format of 'America/New_York'.
User Name	Provide a User Name.	JohnDoe
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Create Workflow Rule (Deprecated)

Create a Workflow Rule. Workflow Rules are being deprecated by Salesforce. Please migrate to using Flow based actions | key: createWorkflowRule

Input	Notes	Example
Active	Determines if this Rule is active	true
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Rule Criteria Filter	Filter criteria data structure to use with the rule, use this or Formula. See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem
Formula	Formula to evaluate. Use this input or Filter Criteria	OwnerId <> LastModifiedById
Outbound Message Actions	Full Names of the Outbound Message Actions for this Rule to fire.
Record Type	The type of Salesforce Record.	Account
Rule Name	Name of the Workflow Rule
Trigger Type	Conditions in which the trigger fires. On All Changes: The workflow rule is considered on all changes. On Create Only: Considered on creation. On Create or Meets Rule Criteria: Considered on create and when it is updated to meet any Rule Criteria configured to the workflow rule.	onAllChanges
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Deactivate Flow

Deactivate a Flow in Salesforce by name | key: deactivateFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Delete Account

Delete an existing account record | key: deleteAccount

Input	Notes	Example
Connection	The Salesforce connection to use.
Field Values	Name of a record's fields and their corresponding values
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

Delete Bulk Job

Deletes a job. | key: deleteBulkJob

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {}
}

Delete Bulk Query Job

Deletes a query job. | key: deleteBulkQueryJob

Input	Notes	Example
Connection	The Salesforce connection to use.
Query Job Id	The ID of the query job to delete	750R0000000zlh9IAA
Version	Salesforce API Version Number.	63.0

{
  "data": {}
}

Delete Contact

Delete an existing contact record | key: deleteContact

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Delete Customer

Delete an existing customer record | key: deleteCustomer

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Delete Flow

Delete a Flow from Salesforce by name | key: deleteFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Delete Instanced Flows and Outbound Messages

Delete all instanced flows and outbound messages for a given endpoint URL | key: deleteInstancedFlowsAndOutboundMessages

Input	Notes	Example
Connection	The Salesforce connection to use.
Endpoint URL	The endpoint URL to delete the instanced flows and outbound messages for.	https://example.com/webhook
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "deletedFlows": [
      "My_Flow"
    ],
    "deletedOutboundMessages": [
      "My_Outbound_Message"
    ]
  }
}

Delete Lead

Delete a Salesforce Lead Record | key: deleteLead

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Delete Metadata

Delete one or more metadata components. | key: deleteMetadata

Input	Notes	Example
Connection	The Salesforce connection to use.
Object Full Names	The full names of the objects to delete
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": null
}

Delete Opportunity

Delete an existing opportunity record | key: deleteOpportunity

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Delete Profile

Delete a Salesforce Profile | key: deleteProfile

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Delete Record

Delete an existing Salesforce Record | key: deleteRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Delete Workflow Outbound Message

Delete a Workflow Outbound Message | key: deleteWorkflowOutboundMessage

Input	Notes	Example
Connection	The Salesforce connection to use.
Full Name Identifier	Unique identifier for Metadata objects
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Delete Workflow Rule (Deprecated)

Delete a Workflow Rule. Workflow Rules are being deprecated by Salesforce. Please migrate to using Flow based actions. | key: deleteWorkflowRule

Input	Notes	Example
Connection	The Salesforce connection to use.
Full Name Identifier	Unique identifier for Metadata objects
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "success": true,
    "fullName": "TestObject1__c"
  }
}

Describe Customer SObject

Metadata description API for Salesforce object. | key: describeCustomerSObject

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "actionOverrides": [],
    "activateable": false,
    "associateEntityType": null,
    "associateParentEntity": null,
    "childRelationships": [
      {
        "cascadeDelete": true,
        "childSObject": "AIInsightValue",
        "deprecatedAndHidden": false,
        "field": "SobjectLookupValueId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": true,
        "childSObject": "AIRecordInsight",
        "deprecatedAndHidden": false,
        "field": "TargetId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "CommSubscriptionConsent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "CommSubsConsents",
        "restrictedDelete": true
      },
      {
        "cascadeDelete": false,
        "childSObject": "CommSubscriptionConsentChangeEvent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "ContactPointConsent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "ContactPointConsents",
        "restrictedDelete": true
      },
      {
        "cascadeDelete": false,
        "childSObject": "ContactPointConsentChangeEvent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "ContactPointTypeConsent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "ContactPointTypeConsents",
        "restrictedDelete": true
      },
      {
        "cascadeDelete": false,
        "childSObject": "ContactPointTypeConsentChangeEvent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": true,
        "childSObject": "CustomerShare",
        "deprecatedAndHidden": false,
        "field": "ParentId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "Shares",
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "FlowExecutionErrorEvent",
        "deprecatedAndHidden": false,
        "field": "ContextRecordId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "FlowRecordRelation",
        "deprecatedAndHidden": false,
        "field": "RelatedRecordId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "PartyConsent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "PartyConsents",
        "restrictedDelete": true
      },
      {
        "cascadeDelete": false,
        "childSObject": "PartyConsentChangeEvent",
        "deprecatedAndHidden": false,
        "field": "PartyRoleId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": true,
        "childSObject": "PendingServiceRoutingInteractionInfo",
        "deprecatedAndHidden": false,
        "field": "TargetObjectId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": null,
        "restrictedDelete": false
      },
      {
        "cascadeDelete": true,
        "childSObject": "ProcessInstance",
        "deprecatedAndHidden": false,
        "field": "TargetObjectId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "ProcessInstances",
        "restrictedDelete": false
      },
      {
        "cascadeDelete": false,
        "childSObject": "ProcessInstanceHistory",
        "deprecatedAndHidden": false,
        "field": "TargetObjectId",
        "junctionIdListNames": [],
        "junctionReferenceTo": [],
        "relationshipName": "ProcessSteps",
        "restrictedDelete": false
      }
    ],
    "compactLayoutable": true,
    "createable": true,
    "custom": false,
    "customSetting": false,
    "deepCloneable": false,
    "defaultImplementation": null,
    "deletable": true,
    "deprecatedAndHidden": false,
    "extendedBy": null,
    "extendsInterfaces": null,
    "feedEnabled": false,
    "fields": [],
    "hasSubtypes": false,
    "implementedBy": null,
    "implementsInterfaces": null,
    "isInterface": false,
    "isSubtype": false,
    "keyPrefix": "0o6",
    "label": "Customer",
    "labelPlural": "Customers",
    "layoutable": true,
    "listviewable": null,
    "lookupLayoutable": null,
    "mergeable": false,
    "mruEnabled": true,
    "name": "Customer",
    "namedLayoutInfos": [],
    "networkScopeFieldName": null,
    "queryable": true,
    "recordTypeInfos": [
      {
        "active": true,
        "available": true,
        "defaultRecordTypeMapping": true,
        "developerName": "Master",
        "master": true,
        "name": "Master",
        "recordTypeId": "012964000000000AAA",
        "urls": {
          "layout": "/services/data/v53.0/sobjects/Customer/describe/layouts/012964000000000AAA"
        }
      }
    ],
    "replicateable": true,
    "retrieveable": true,
    "searchLayoutable": true,
    "searchable": true,
    "sobjectDescribeOption": "FULL",
    "supportedScopes": [],
    "triggerable": true,
    "undeletable": true,
    "updateable": true,
    "urls": {
      "compactLayouts": "/services/data/v53.0/sobjects/Customer/describe/compactLayouts",
      "rowTemplate": "/services/data/v53.0/sobjects/Customer/{ID}",
      "approvalLayouts": "/services/data/v53.0/sobjects/Customer/describe/approvalLayouts",
      "uiDetailTemplate": "https://dummy-uri.my.salesforce.com/{ID}",
      "uiEditTemplate": "https://dummy-uri.my.salesforce.com/{ID}/e",
      "describe": "/services/data/v53.0/sobjects/Customer/describe",
      "uiNewRecord": "https://dummy-uri.my.salesforce.com/0o6/e",
      "layouts": "/services/data/v53.0/sobjects/Customer/describe/layouts",
      "sobject": "/services/data/v53.0/sobjects/Customer"
    }
  }
}

Describe Object

Describe attributes of a Salesforce Record Type | key: describeObject

Input	Notes	Example
Connection	The Salesforce connection to use.
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

Describe Permissions

Describe permissions of a Salesforce Record Type | key: describePermissions

Input	Notes	Example
Connection	The Salesforce connection to use.
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

Find Record

Find a single Salesforce Record | key: findRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "Id": "003RM000006pL5gQAE",
    "Name": "Acme",
    "Phone": "123-456-7890",
    "BillingCity": "San Francisco",
    "BillingState": "CA"
  }
}

Find Records

Find and fetch Salesforce Records | key: findRecords

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Record Type	The type of Salesforce Record.	Account
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "Id": "003RM000006pL5gQAE",
      "Name": "Acme",
      "Phone": "123-456-7890",
      "BillingCity": "San Francisco",
      "BillingState": "CA"
    }
  ]
}

Get Attachment

Get a file attachment from an account, opportunity or contact | key: getAttachment

Input	Notes	Example
Connection	The Salesforce connection to use.
File Id	The id of the file you wish to retrieve	an-example-id
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "type": "Buffer",
    "data": [
      83,
      71,
      86,
      115,
      98,
      71,
      56,
      103,
      86,
      50,
      57,
      121,
      98,
      71,
      81,
      61
    ]
  },
  "contentType": "image/png"
}

Get Bulk Job Failed Record Results

Retrieves a list of failed records for a completed insert, delete, update or upsert job. | key: getJobFailedRecordResults

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

Get Bulk Job Info

Retrieves detailed information about a job. | key: getBulkJob

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "7506g00000DhRA2AAN",
    "operation": "insert",
    "object": "Account",
    "createdById": "0056g000005HQPyAAO",
    "createdDate": "2018-12-18T22:51:36.000+0000",
    "systemModstamp": "2018-12-18T22:51:58.000+0000",
    "state": "Open",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 60,
    "jobType": "V2Ingest",
    "contentUrl": "services/data/v60.0/jobs/ingest/7506g00000DhRA2AAN/batches",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "retries": 0,
    "totalProcessingTime": 0,
    "apiActiveProcessingTime": 0,
    "apexProcessingTime": 0
  }
}

Get Bulk Job Successful Record Results

Retrieves the successful record results for a job. | key: getJobSuccessfulRecordResults

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

Get Bulk Query Job Information

Gets information about one query job. | key: getQueryJobInformation

Input	Notes	Example
Connection	The Salesforce connection to use.
Query Job Id	The ID of the query job	750R0000000zlh9IAA
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "750R0000000zlh9IAA",
    "operation": "query",
    "object": "Account",
    "createdById": "005R0000000GiwjIAC",
    "createdDate": "2018-12-10T17:50:19.000+0000",
    "systemModstamp": "2018-12-10T17:51:27.000+0000",
    "state": "JobComplete",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 46,
    "jobType": "V2Query",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "numberRecordsProcessed": 500,
    "retries": 0,
    "totalProcessingTime": 334,
    "isPkChunkingSupported": true
  }
}

Get Current User

Return information about the current session's user | key: getCurrentUser

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "results": {
      "id": "https://login.salesforce.com/id/00Z8d000694w9weEAQ/0064c00859AJGN6KPA",
      "asserted_user": true,
      "user_id": "0064c00859AJGN6KPA",
      "organization_id": "00Z8d000694w9weEAQ",
      "username": "jhon@doe.com",
      "nick_name": "dev",
      "display_name": "Dev Env",
      "email": "jhon@doe.com",
      "email_verified": true,
      "first_name": "Dev",
      "last_name": "Dev",
      "timezone": "America/Los_Angeles",
      "photos": {
        "picture": "https://dummy-uri.file.force.com/profilephoto/005/F",
        "thumbnail": "https://dummy-uri.file.force.com/profilephoto/005/T"
      },
      "addr_street": null,
      "addr_city": null,
      "addr_state": null,
      "addr_country": "US",
      "addr_zip": null,
      "mobile_phone": null,
      "mobile_phone_verified": false,
      "is_lightning_login_user": false,
      "status": {
        "created_date": null,
        "body": null
      },
      "urls": {
        "enterprise": "https://dummy-uri.my.salesforce.com/services/Soap/c/{version}/00Z8d000694w9we",
        "metadata": "https://dummy-uri.my.salesforce.com/services/Soap/m/{version}/00Z8d000694w9we",
        "partner": "https://dummy-uri.my.salesforce.com/services/Soap/u/{version}/00Z8d000694w9we",
        "rest": "https://dummy-uri.my.salesforce.com/services/data/v{version}/",
        "sobjects": "https://dummy-uri.my.salesforce.com/services/data/v{version}/sobjects/",
        "search": "https://dummy-uri.my.salesforce.com/services/data/v{version}/search/",
        "query": "https://dummy-uri.my.salesforce.com/services/data/v{version}/query/",
        "recent": "https://dummy-uri.my.salesforce.com/services/data/v{version}/recent/",
        "tooling_soap": "https://dummy-uri.my.salesforce.com/services/Soap/T/{version}/00Z8d000694w9we",
        "tooling_rest": "https://dummy-uri.my.salesforce.com/services/data/v{version}/tooling/",
        "profile": "https://dummy-uri.my.salesforce.com/0064c00859AJGN6KPA",
        "feeds": "https://dummy-uri.my.salesforce.com/services/data/v{version}/chatter/feeds",
        "groups": "https://dummy-uri.my.salesforce.com/services/data/v{version}/chatter/groups",
        "users": "https://dummy-uri.my.salesforce.com/services/data/v{version}/chatter/users",
        "feed_items": "https://dummy-uri.my.salesforce.com/services/data/v{version}/chatter/feed-items",
        "feed_elements": "https://dummy-uri.my.salesforce.com/services/data/v{version}/chatter/feed-elements",
        "custom_domain": "https://dummy-uri.my.salesforce.com"
      },
      "active": true,
      "user_type": "STANDARD",
      "language": "en_US",
      "locale": "en_US",
      "utcOffset": -28800000,
      "last_modified_date": "2023-10-06T18:48:33Z",
      "is_app_installed": true
    }
  }
}

Get Customer

Gets an existing customer record | key: getCustomer

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "attributes": {
      "type": "Customer",
      "url": "/services/data/v53.0/sobjects/Customer/0o68c000000wk3lAAA"
    },
    "Id": "0o68c000000wk3lAAA",
    "OwnerId": "0064c00859AJGN6KPA",
    "IsDeleted": false,
    "Name": "Customer Name",
    "CreatedDate": "2023-12-14T20:54:21.000+0000",
    "CreatedById": "0064c00859AJGN6KPA",
    "LastModifiedDate": "2023-12-14T20:54:21.000+0000",
    "LastModifiedById": "0064c00859AJGN6KPA",
    "SystemModstamp": "2023-12-14T20:54:21.000+0000",
    "LastViewedDate": "2023-12-21T22:23:30.000+0000",
    "LastReferencedDate": "2023-12-21T22:23:30.000+0000",
    "PartyId": "0PK8c000963oLkUGAU",
    "TotalLifeTimeValue": null,
    "CustomerStatusType": "Active"
  }
}

Get File

Retrieves a file from Salesforce ContentVersion | key: getFile

Input	Notes	Example
Connection	The Salesforce connection to use.
Content Version Id	The ID of the ContentVersion of the file to retrieve	0697000000K2g5AAAR
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "type": "Buffer",
    "data": [
      83,
      71,
      86,
      115,
      98,
      71,
      56,
      103,
      86,
      50,
      57,
      121,
      98,
      71,
      81,
      61
    ]
  },
  "contentType": "image/png"
}

Get Flow

Get details of a specific Flow by name | key: getFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "Example_Flow_01",
    "actionCalls": [
      {
        "name": "Send_Example_Action",
        "label": "Send Example Action",
        "locationX": 176,
        "locationY": 158,
        "actionName": "Account.Example_Action",
        "actionType": "outboundMessage",
        "flowTransactionModel": "CurrentTransaction",
        "nameSegment": "Account.Example_Action",
        "processMetadataValues": [],
        "inputParameters": [],
        "outputParameters": []
      }
    ],
    "apiVersion": "49.0",
    "areMetricsLoggedToDataCloud": "false",
    "description": "Example description",
    "environments": "Default",
    "formulas": [
      {
        "name": "TriggerCondition",
        "dataType": "Boolean",
        "expression": "true",
        "processMetadataValues": []
      }
    ],
    "label": "Example Label",
    "processType": "AutoLaunchedFlow",
    "runInMode": "DefaultMode",
    "start": {
      "locationX": 50,
      "locationY": 0,
      "connector": {
        "targetReference": "Send_Example_Action",
        "processMetadataValues": []
      },
      "object": "Account",
      "recordTriggerType": "CreateAndUpdate",
      "triggerType": "RecordAfterSave",
      "processMetadataValues": [],
      "filters": []
    },
    "status": "Draft",
    "variables": [
      {
        "name": "TriggeringRecord",
        "dataType": "SObject",
        "isCollection": false,
        "isInput": true,
        "isOutput": false,
        "objectType": "Account",
        "processMetadataValues": []
      }
    ],
    "apexPluginCalls": [],
    "assignments": [],
    "choices": [],
    "constants": [],
    "decisions": [],
    "dynamicChoiceSets": [],
    "loops": [],
    "processMetadataValues": [],
    "recordCreates": [],
    "recordDeletes": [],
    "recordLookups": [],
    "recordUpdates": [],
    "screens": [],
    "stages": [],
    "steps": [],
    "subflows": [],
    "textTemplates": [],
    "waits": []
  }
}

Get Information About All Query Jobs

Gets information about all query jobs in the org. | key: getAllQueryJobInformation

Input	Notes	Example
Concurrency Mode	For future use. Gets information only about jobs matching the specified concurrency mode.	parallel
Connection	The Salesforce connection to use.
Is PK Chunking Enabled	If set to true, the request only returns information about jobs where PK Chunking is enabled. This only applies to Bulk API (not Bulk API 2.0) jobs.	false
Job Type	Gets information only about jobs matching the specified job type.
Query Locator	A string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.	MTAwMDA
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "done": false,
    "records": [
      {
        "id": "750R0000000zhfdIAA",
        "operation": "query",
        "object": "Account",
        "createdById": "005R0000000GiwjIAC",
        "createdDate": "2018-12-07T19:58:09.000+0000",
        "systemModstamp": "2018-12-07T19:59:14.000+0000",
        "state": "JobComplete",
        "concurrencyMode": "Parallel",
        "contentType": "CSV",
        "apiVersion": 60,
        "jobType": "V2Query",
        "lineEnding": "LF",
        "columnDelimiter": "COMMA"
      },
      {
        "id": "750R0000000zhjzIAA",
        "operation": "query",
        "object": "Account",
        "createdById": "005R0000000GiwjIAC",
        "createdDate": "2018-12-07T20:52:28.000+0000",
        "systemModstamp": "2018-12-07T20:53:15.000+0000",
        "state": "JobComplete",
        "concurrencyMode": "Parallel",
        "contentType": "CSV",
        "apiVersion": 60,
        "jobType": "V2Query",
        "lineEnding": "LF",
        "columnDelimiter": "COMMA"
      }
    ],
    "nextRecordsUrl": "/services/data/v60.0/jobs/ingest?queryLocator=01gR0000000opRTIAY-2000"
  }
}

Get Record

Get a single Salesforce Record by Id | key: getRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "Id": "003RM000006pL5gQAE",
    "Name": "Acme",
    "Phone": "123-456-7890",
    "BillingCity": "San Francisco",
    "BillingState": "CA"
  }
}

Get Results for a Bulk Query Job

Gets the results for a query job. The job must be in a Job Complete state | key: getQueryJobResults

Input	Notes	Example
Connection	The Salesforce connection to use.
Locator	A string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.	MTAwMDA
Max Records	The maximum number of records to retrieve per set of results for the query. The request is still subject to the size limits.	MTAwMDA
Query Job Id	The ID of the query job	750R0000000zlh9IAA
Version	Salesforce API Version Number.	63.0

{
  "data": "\n  \"Id\",\"Name\"\n\"005R0000000UyrWIAS\",\"Jane Dunn\"\n\"005R0000000GiwjIAC\",\"George Wright\"\n\"005R0000000GiwoIAC\",\"Pat Wilson\"\n"
}

List Bulk Jobs

Retrieves all jobs in the org. | key: listBulkJobs

Input	Notes	Example
Connection	The Salesforce connection to use.
Is PK Chunking Enabled	If set to true, the request only returns information about jobs where PK Chunking is enabled. This only applies to Bulk API (not Bulk API 2.0) jobs.	false
Job Type	Gets information only about jobs matching the specified job type.
Locator	A string that identifies a specific set of query results. Providing a value for this parameter returns only that set of results.	MTAwMDA
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "done": true,
    "nextRecordsUrl": "/services/data/v60.0/jobs/ingest?queryLocator=01gR0000000opRTIAY-2000",
    "records": [
      {
        "id": "7506g00000DhRA2AAN",
        "operation": "insert",
        "object": "Account",
        "createdById": "0056g000005HQPyAAO",
        "createdDate": "2018-12-18T22:51:36.000+0000",
        "systemModstamp": "2018-12-18T22:51:58.000+0000",
        "state": "Open",
        "concurrencyMode": "Parallel",
        "contentType": "CSV",
        "apiVersion": 60,
        "jobType": "V2Ingest",
        "contentUrl": "services/data/v60.0/jobs/ingest/7506g00000DhRA2AAN/batches",
        "lineEnding": "LF",
        "columnDelimiter": "COMMA",
        "retries": 0,
        "totalProcessingTime": 0,
        "apiActiveProcessingTime": 0,
        "apexProcessingTime": 0
      },
      {
        "id": "7506g00000DhRA2AAN",
        "operation": "insert",
        "object": "Account",
        "createdById": "0056g000005HQPyAAO",
        "createdDate": "2018-12-18T22:51:36.000+0000",
        "systemModstamp": "2018-12-18T22:51:58.000+0000",
        "state": "Open",
        "concurrencyMode": "Parallel",
        "contentType": "CSV",
        "apiVersion": 60,
        "jobType": "V2Ingest",
        "contentUrl": "services/data/v60.0/jobs/ingest/7506g00000DhRA2AAN/batches",
        "lineEnding": "LF",
        "columnDelimiter": "COMMA",
        "retries": 0,
        "totalProcessingTime": 0,
        "apiActiveProcessingTime": 0,
        "apexProcessingTime": 0
      }
    ]
  }
}

List Composite Resources

Gets a list of URIs for other composite resources. | key: listCompositeResources

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "hasErrors": false,
    "results": [
      {
        "tree": "/services/data/v54.0/composite/tree",
        "batch": "/services/data/v54.0/composite/batch",
        "sobjects": "/services/data/v54.0/composite/sobjects",
        "graph": "/services/data/v54.0/composite/graph"
      }
    ]
  }
}

List Contacts

List all contacts records | key: listContacts

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "attributes": {
        "type": "Contact",
        "url": "/services/data/v53.0/sobjects/Contact/kdkjsj2132"
      },
      "Id": "kdkjsj2132",
      "IsDeleted": false,
      "MasterRecordId": null,
      "AccountId": null,
      "LastName": "",
      "Name": "test",
      "OwnerId": "kasjdjdk12313",
      "CreatedDate": "2024-10-10T19:13:07.000+0000",
      "CreatedById": "kasjdjdk12313",
      "LastModifiedDate": "2024-10-10T19:13:07.000+0000",
      "LastModifiedById": "kasjdjdk12313",
      "SystemModstamp": "2024-10-10T19:13:07.000+0000"
    }
  ]
}

List Customers

List all customer records | key: listCustomers

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "records": [
      {
        "attributes": {
          "type": "Customer",
          "url": "/services/data/v53.0/sobjects/Customer/0o68c000000wk3lAAA"
        },
        "Id": "0o68c000000wk3lAAA",
        "OwnerId": "0064c00859AJGN6KPA",
        "IsDeleted": false,
        "Name": "Customer Name",
        "CreatedDate": "2023-12-14T20:54:21.000+0000",
        "CreatedById": "0064c00859AJGN6KPA",
        "LastModifiedDate": "2023-12-14T20:54:21.000+0000",
        "LastModifiedById": "0064c00859AJGN6KPA",
        "SystemModstamp": "2023-12-14T20:54:21.000+0000",
        "LastViewedDate": "2023-12-21T22:23:30.000+0000",
        "LastReferencedDate": "2023-12-21T22:23:30.000+0000",
        "PartyId": "0PK8c000963oLkUGAU",
        "TotalLifeTimeValue": null,
        "CustomerStatusType": "Active"
      },
      {
        "attributes": {
          "type": "Customer",
          "url": "/services/data/v53.0/sobjects/Customer/0o79c690000wk3qBCD"
        },
        "Id": "0o79c690000wk3qBCD",
        "OwnerId": "0064c00859AJGN6KPA",
        "IsDeleted": false,
        "Name": "New Name For Customer",
        "CreatedDate": "2023-12-14T20:54:50.000+0000",
        "CreatedById": "0064c00859AJGN6KPA",
        "LastModifiedDate": "2023-12-14T20:54:50.000+0000",
        "LastModifiedById": "0064c00859AJGN6KPA",
        "SystemModstamp": "2023-12-14T20:54:50.000+0000",
        "LastViewedDate": "2023-12-14T20:54:50.000+0000",
        "LastReferencedDate": "2023-12-14T20:54:50.000+0000",
        "PartyId": "0PK8c000963oLkUGAU",
        "TotalLifeTimeValue": null,
        "CustomerStatusType": "Active"
      }
    ],
    "done": true,
    "totalSize": 2
  }
}

List Flows

List all Flows in the Salesforce org | key: listFlows

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "fullName": "My_Flow",
      "type": "Flow",
      "namespacePrefix": null,
      "createdById": "005000000000000",
      "createdByName": "Admin User",
      "createdDate": "2023-01-01T00:00:00.000Z",
      "fileName": "flows/My_Flow.flow",
      "id": "30100000000000",
      "lastModifiedById": "005000000000000",
      "lastModifiedByName": "Admin User",
      "lastModifiedDate": "2023-01-01T00:00:00.000Z"
    }
  ]
}

List Leads

List all lead records | key: listLeads

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "attributes": {
        "type": "Lead",
        "url": "/services/data/v53.0/sobjects/Lead/asdadasdad123"
      },
      "Id": "asdadasdad123",
      "IsDeleted": false,
      "MasterRecordId": null,
      "LastName": "test",
      "FirstName": "test2",
      "Salutation": null,
      "Name": "test2 test",
      "Title": "CTO",
      "Company": "Test2 123",
      "Street": null,
      "City": "Tampa",
      "State": "Florida",
      "Address": {
        "city": "Tampa",
        "country": null,
        "geocodeAccuracy": null,
        "latitude": null,
        "longitude": null,
        "postalCode": null,
        "state": "Florida",
        "street": null
      },
      "PhotoUrl": "/services/images/photo/asdadasdad123",
      "Status": "Open - Not Contacted",
      "OwnerId": "asdadDSAFd1123",
      "CreatedDate": "2023-10-05T15:39:28.000+0000",
      "CreatedById": "asdadDSAFd1123",
      "LastModifiedDate": "2023-10-05T15:39:28.000+0000",
      "LastModifiedById": "asdadDSAFd1123",
      "CleanStatus": "Pending",
      "test__New_Test_Field__c": null
    }
  ]
}

List Metadata

Get all metadata components. | key: listObjectMetadata

Input	Notes	Example
Connection	The Salesforce connection to use.
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "results": [
      {
        "createdById": "0064c00859AJGN6KPA",
        "createdByName": "Dev Env",
        "createdDate": "1970-01-01T00:00:00.000Z",
        "fileName": "objects/Campaign.object",
        "fullName": "Campaign",
        "id": "",
        "lastModifiedById": "0064c00859AJGN6KPA",
        "lastModifiedByName": "Dev Env",
        "lastModifiedDate": "1970-01-01T00:00:00.000Z",
        "namespacePrefix": "",
        "type": "CustomObject"
      },
      {
        "createdById": "0064c00859AJGN6KPA",
        "createdByName": "Dev Env",
        "createdDate": "1970-01-01T00:00:00.000Z",
        "fileName": "objects/Campaign.object",
        "fullName": "Campaign",
        "id": "",
        "lastModifiedById": "0064c00859AJGN6KPA",
        "lastModifiedByName": "Dev Env",
        "lastModifiedDate": "1970-01-01T00:00:00.000Z",
        "namespacePrefix": "",
        "type": "CustomObject"
      }
    ]
  }
}

List Opportunities

List all opportunity records | key: listOpportunities

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "attributes": {
        "type": "Opportunity",
        "url": "/services/data/v53.0/sobjects/Opportunity/dasdj123ksad"
      },
      "Id": "dasdj123ksad",
      "IsDeleted": false,
      "AccountId": "sadasd123",
      "IsPrivate": false,
      "Name": "Example Customer",
      "Description": null,
      "StageName": "Prospecting",
      "OwnerId": "DASDOO12332",
      "CreatedDate": "2022-07-27T21:25:04.000+0000",
      "CreatedById": "DASDOO12332",
      "LastModifiedDate": "2022-07-28T12:49:16.000+0000",
      "LastModifiedById": "DASDOO12332",
      "SystemModstamp": "2022-07-28T12:49:16.000+0000",
      "LastActivityDate": null,
      "PushCount": 0,
      "LastStageChangeDate": null,
      "FiscalQuarter": 4,
      "FiscalYear": 2022,
      "Fiscal": "2022 4"
    }
  ]
}

List Outbound Messages

Retrieve all Outbound Messages. | key: listWorkflowOutboundMessages

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

List Profiles

List all profile records | key: listProfiles

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "results": [
      {
        "attributes": {
          "type": "Profile",
          "url": "/services/data/v53.0/sobjects/Profile/DSDSDJSJD123123"
        },
        "Id": "DSDSDJSJD123123",
        "Name": "Minimum Access - API Only Integrations",
        "UserLicenseId": "asdaskda123",
        "UserType": "Standard",
        "CreatedDate": "2024-02-10T07:08:00.000+0000",
        "CreatedById": "asdsad12313",
        "LastModifiedDate": "2024-10-29T18:23:13.000+0000",
        "LastModifiedById": "fsadasd1233",
        "SystemModstamp": "2024-10-29T18:23:13.000+0000",
        "Description": null,
        "LastViewedDate": null,
        "LastReferencedDate": null
      }
    ]
  }
}

List Users

List all user records | key: listUsers

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Fetch All	Fetch all records.	false
Field Values	Name of a record's fields and their corresponding values
Field Value Types	For each item, provide the key and the type corresponding to the field Value you entered above. You can assign a value a type of Boolean, Number, or String.	Name:string,Phone:string
Max Records To Fetch	If Fetch All is enabled, you can specify the maximum records to fetch, by default it will fetch up to 20,000 records.	20000
Page Number	Provide an integer value for which page to return when paginating results.	3
Page Size	Provide an integer value for the maximum results returned per page when paginating results.	20
Sort Criteria	The criteria by which you wish to sort the records. Use a string to specify the field and order. Prefix with '-' for descending order. For example, '-CreatedDate Name' will sort by 'CreatedDate' in descending order and by 'Name' in ascending order.	-CreatedDate Name
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "results": [
      {
        "attributes": {
          "type": "User",
          "url": "/services/data/v53.0/sobjects/User/DJDSJDJDSA123123"
        },
        "Id": "DJDSJDJDSA123123",
        "Username": "test.test+dev@test.test",
        "LastName": "test",
        "FirstName": "test",
        "Name": "test test",
        "LastLoginDate": "2024-08-13T14:56:59.000+0000",
        "LastPasswordChangeDate": "2024-08-13T14:45:59.000+0000",
        "CreatedDate": "2023-06-28T13:02:36.000+0000",
        "CreatedById": "DASDJASJ123",
        "LastModifiedDate": "2023-06-28T14:36:13.000+0000",
        "LastModifiedById": "DASDJASJ123",
        "SystemModstamp": "2024-08-14T06:00:01.000+0000",
        "FullPhotoUrl": "https://test3-dev-ed.my.salesforce.com/profilephoto/005/F",
        "SmallPhotoUrl": "https://test3-dev-ed.my.salesforce.com/profilephoto/005/T",
        "IsExtIndicatorVisible": false,
        "OutOfOfficeMessage": "",
        "MediumPhotoUrl": "https://test3-dev-ed.my.salesforce.com/profilephoto/005/M",
        "DigestFrequency": "D",
        "DefaultGroupNotificationFrequency": "N",
        "JigsawImportLimitOverride": 300,
        "LastViewedDate": null,
        "LastReferencedDate": null,
        "BannerPhotoUrl": "/profilephoto/005/B",
        "SmallBannerPhotoUrl": "/profilephoto/005/D",
        "MediumBannerPhotoUrl": "/profilephoto/005/E",
        "IsProfilePhotoActive": false,
        "IndividualId": null,
        "test__Verified__c": false
      }
    ]
  }
}

List Workflow Rules (Deprecated)

List all Workflow Rules. Workflow Rules are being deprecated by Salesforce. Please migrate to using Flow based actions | key: listWorkflowRules

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "results": [
      {
        "createdById": "0064c00859AJGN6KPA",
        "createdByName": "Dev Env",
        "createdDate": "2023-04-28T16:39:49.000Z",
        "fileName": "workflows/Account.workflow",
        "fullName": "Account.Vendia-Demo-Hook-0064c00859AJGN6KPA",
        "id": "01Q8c000001QiFoEAK",
        "lastModifiedById": "0064c00859AJGN6KPA",
        "lastModifiedByName": "Dev Env",
        "lastModifiedDate": "2023-04-28T16:39:49.000Z",
        "manageableState": "unmanaged",
        "type": "WorkflowRule"
      },
      {
        "createdById": "0058c00000AJGN6KPO",
        "createdByName": "Dev Env",
        "createdDate": "2023-04-28T16:39:49.000Z",
        "fileName": "workflows/Account.workflow",
        "fullName": "Account.Vendia-Demo-Hook-0064c00859AJGN6KPA",
        "id": "01Q8c000001QiFoEAK",
        "lastModifiedById": "0064c00859AJGN6KPA",
        "lastModifiedByName": "Dev Env",
        "lastModifiedDate": "2023-04-28T16:39:49.000Z",
        "manageableState": "unmanaged",
        "type": "WorkflowRule"
      }
    ]
  }
}

Raw Request

Send raw HTTP request to Salesforce | key: rawRequest

Input	Notes	Example
Connection	The Salesforce connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/chatter/feeds/record/), The base URL is already included (https://<YOUR_INSTANCE_URL_COMING_FROM_CONNECTION>/services/data/v<YOUR_INPUT_VERSION>). For example, to connect to https://instance_name/services/data/v58.0/chatter/feeds/record/, only /chatter/feeds/record/ is entered in this field.	/chatter/feeds/record/
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Version	Salesforce API Version Number.	63.0

Read Metadata of Object

Get the metadata of an object by full name | key: getObjectMetadataByName

Input	Notes	Example
Connection	The Salesforce connection to use.
Object Full Name		Widget__c
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "createdById": "0064c00859AJGN6KPA",
    "createdByName": "Dev Env",
    "createdDate": "1970-01-01T00:00:00.000Z",
    "fileName": "objects/Campaign.object",
    "fullName": "Campaign",
    "id": "",
    "lastModifiedById": "0064c00859AJGN6KPA",
    "lastModifiedByName": "Dev Env",
    "lastModifiedDate": "1970-01-01T00:00:00.000Z",
    "namespacePrefix": "",
    "type": "CustomObject"
  }
}

Remove User Permission Set

Removes a Permission Set from the specified User | key: removeUserPermissionSet

Input	Notes	Example
Connection	The Salesforce connection to use.
Permission Set	Provide the name of the Permission Set.	Standard User
User Name	Provide a User Name.	JohnDoe
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Salesforce Query

Run an SOQL Query Against SalesForce | key: query

Input	Notes	Example
Connection	The Salesforce connection to use.
SOQL Query	A SalesForce Object Query Language (SOQL) query	SELECT Id, Name FROM Opportunity
Version	Salesforce API Version Number.	63.0

Send Transactional Email

Sends a message to a single recipient via Salesforce | key: sendTransactionalEmail

Input	Notes	Example
Connection	The Salesforce connection to use.
Definition Key	The key of the message template definition	welcome_message
Message Key	The key of the message template	welcome_message
Recipient Attributes	Key-value pairs to personalize the message.
Recipient Contact Key	The key of the recipient contact	contact_key
Recipient Email	The email of the recipient	john@doe.com
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Subscribe to Record Change (Deprecated)

Create a Workflow Rule to subscribe to Record Changes in Salesforce. Workflow Rules are being deprecated by Salesforce. Please migrate to using Flow based actions | key: subscribeToRecordChange

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	Dynamic Fields, provided by value collection config variable, to include in the Outbound Message
Endpoint URL	The endpoint URL to send the outbound message / webhook to	https://example.com/webhook
Fields	Fields to include in the Outbound Message.	Name, Phone, Email, etc.
Rule Criteria Filter	Filter criteria data structure to use with the rule, use this or Formula. See https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm#filteritem
Formula	Formula to evaluate. Use this input or Filter Criteria	OwnerId <> LastModifiedById
Integration User Email	The email of the user under which the payload is sent. If not provided, the current user will be used	jhon@doe.com
Outbound Message Name	Name of the Outbound Message	MyOutboundMessage
Trigger Event		onAllChanges
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "WorkflowRule": {
      "errors": [],
      "success": true,
      "fullName": "Account.TestRule"
    },
    "WorkflowOutboundMessage": {
      "errors": [],
      "success": true,
      "fullName": "Account.TestRule"
    }
  }
}

Subscribe to Record Changes

Subscribe to Record Changes in Salesforce using an outbound message action. | key: subscribeToRecordChanges

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	Dynamic Fields, provided by value collection config variable, to include in the Outbound Message
Endpoint URL	The endpoint URL to send the outbound message / webhook to	https://example.com/webhook
Fields	Fields to include in the Outbound Message.	Name, Phone, Email, etc.
Filter Formula	Optional formula to filter which records trigger the flow.	ISCHANGED(Email) && NOT(ISBLANK(Email))
Flow Metadata	Additional Flow metadata in JSON format. This will be merged with other inputs.
Prefix	Sets a prefix to the Flow Name and Outbound Messages created. Must start with a letter, can contain letters, numbers, underscores, and be at most 15 characters.	Acme_Services
Trigger Record Type	The Record Type that will trigger this integration flow.
Trigger On	When to trigger the flow (record creation, update, or both).	CreateAndUpdate
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "outboundMessageFullName": "My_Flow",
    "flowFullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Update Account

Update an existing account record | key: updateAccount

Input	Notes	Example
Billing City	The city of the object's billing address.	Cupertino
Billing Country	The country of the object's billing address.	CA
Billing Postal Code	The zip code of the object's billing address.	94024
Billing State	The state of the object's billing address.	CA
Billing Street Address	The street address of the billing object.	4 Privet Drive
City	The city of the object's address.	Cupertino
Connection	The Salesforce connection to use.
Country	The country of the object's address.	United States
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Number of Employees	The number of employees associated with the object.	30
Field Values	Name of a record's fields and their corresponding values
Industry	The industry of the account record.
Name	The name of the object.	myExampleObject
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Annual Revenue	The estimated annual revenue of the object.	38000
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Account Type	The type of account record.
Version	Salesforce API Version Number.	63.0
Website	Provide a valid URL for the website of the object.	website-example.com

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Update Contact

Update an existing contact record | key: updateContact

Input	Notes	Example
Assistant	Provide a string value that represents the name of the contact's assistant.	Jane Doe
Assistant's Phone	Provide a string value that represents the phone number of the contact's assistant.	18005555555
Billing City	The city of the object's billing address.	Cupertino
Billing Country	The country of the object's billing address.	CA
Billing Postal Code	The zip code of the object's billing address.	94024
Billing State	The state of the object's billing address.	CA
Billing Street Address	The street address of the billing object.	4 Privet Drive
Birthdate	Provide a string value that represents the birthdate.	YYYY-MM-DD
City	The city of the object's address.	Cupertino
Connection	The Salesforce connection to use.
Country	The country of the object's address.	United States
Department	Provide a string value that represents the name of the contact's department.	Sales
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address	The email address for the object.	someone@example.com
Fax	Provide a string value for the fax number.	18008999372
Field Values	Name of a record's fields and their corresponding values
First Name	The first name of the contact at the company	John
Last Name	The last name of the contact at the company	Smith
Mobile Phone	The mobile phone number for the object.	18005555555
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Title	The title of the object.	Example Title
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Update Customer

Update an existing customer record | key: updateCustomer

Input	Notes	Example
Connection	The Salesforce connection to use.
Customer Status Type	The status of the customer account.	Active
Last Reference Date	The timestamp for when the current user last viewed a record related to this record.	2021-09-01T00:00:00.000Z
Last Viewed Date	The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.	2021-09-01T00:00:00.000Z
Name	Name of this customer.	myExampleObject
Owner Id	The ID of the user who owns the record.	00570000001a2fF
Party Id	Represents the individual object related to this customer record.	0697000000K2g5AAAR
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Total Lifetime Value	The total revenue amount gained from this customer.	1000
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Update Flow

Update an existing Flow in Salesforce by name | key: updateFlow

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Updated description for the Flow.	This is a description of the object
Flow Metadata	Additional Flow metadata in JSON format. This will be merged with other inputs.
Flow Name	The name for the Flow. Accepts both display names and API names. Display names are automatically converted to API format, while API names are used as is.
Flow Status	The status of the Flow.
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "fullName": "My_Flow",
    "success": true,
    "errors": []
  }
}

Update Lead

Update a Salesforce Lead Record | key: updateLead

Input	Notes	Example
City	The city of the object's address.	Cupertino
Company	The name of the company	Widgets Inc.
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Email Address	The email address for the object.	someone@example.com
Number of Employees	The number of employees associated with the object.	30
Field Values	Name of a record's fields and their corresponding values
First Name	The first name of the contact at the company	John
Last Name	The last name of the contact at the company	Smith
Lead Source	Provide a value for the source of the lead.	Web
Lead Status	The status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted.	Converted
Phone	The primary phone number for the object.	18005555555
Postal Code	The zip code of the object's address.	94024
Rating	The rating for the lead.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Annual Revenue	The estimated annual revenue of the object.	38000
State	The state of the object's address.	CA
Street Address	The street address of the object.	4 Privet Drive
Title	The title of the object.	Example Title
Version	Salesforce API Version Number.	63.0
Website	Provide a valid URL for the website of the object.	website-example.com

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Update Metadata

Update one or more metadata components. | key: updateMetadata

Input	Notes	Example
Connection	The Salesforce connection to use.
Metadata	Check https://jsforce.github.io/document/#update-metadata for related documentation
Metadata Type	The type of metadata to act upon.	CustomObject
Version	Salesforce API Version Number.	63.0

{
  "data": null
}

Update Opportunity

Update an existing opportunity record | key: updateOpportunity

Input	Notes	Example
Account ID	The ID of the account to reference.	0017000000hOMChAAO
Amount	Provide a number that represents the opportunity amount.	38000
Close Date	The date the sale will close.	YYYY-MM-DD
Connection	The Salesforce connection to use.
Description	Provide a string value for the description of the object.	This is a description of the object
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Lead Source	Provide a value for the source of the lead.	Web
Name	The name of the object.	myExampleObject
Next Step	Provide a string value for the next step of the sale.	Follow up with the client
Opportunity Type	Provide a value for what type of opportunity this is.
Probability	The probability of the success of the sale.	50
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Stage	The stage the sale is currently in.	Prospecting
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Update Profile

Update a Salesforce Profile | key: updateProfile

Input	Notes	Example
Connection	The Salesforce connection to use.
Description	Description of the profile.
Name	The name of the profile.
Permissions	Key/value object with permission name keys and boolean value indicating if a permission is granted or not. Use 'Describe Permissions' to retrieve the permissions of a Record Type.
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Update Record

Updates an existing Salesforce Record | key: updateRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
Record ID	The ID of a Salesforce Record	0017000000hOMChAAO
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Update User

Update a Salesforce User | key: updateUser

Input	Notes	Example
Connection	The Salesforce connection to use.
Dynamic Fields	A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Field Values	Name of a record's fields and their corresponding values
User Name	Provide a User Name.	JohnDoe
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true
  }
}

Upload Bulk Job Data

Uploads data for a job using CSV data you provide. | key: uploadJobData

Input	Notes	Example
Bulk Job Id	The ID of the Bulk Job. This is the ID returned from the Create Bulk Job action.	750R0000000zlh9IAA
Connection	The Salesforce connection to use.
File	The file to be uploaded
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "750R0000000zlh9IAA",
    "operation": "query",
    "object": "Account",
    "createdById": "005R0000000GiwjIAC",
    "createdDate": "2018-12-10T17:50:19.000+0000",
    "systemModstamp": "2018-12-10T17:51:27.000+0000",
    "state": "JobComplete",
    "concurrencyMode": "Parallel",
    "contentType": "CSV",
    "apiVersion": 46,
    "jobType": "V2Query",
    "lineEnding": "LF",
    "columnDelimiter": "COMMA",
    "numberRecordsProcessed": 500,
    "retries": 0,
    "totalProcessingTime": 334,
    "isPkChunkingSupported": true
  }
}

Upload File

Uploads a file to Salesforce ContentVersion | key: uploadFile

Input	Notes	Example
Connection	The Salesforce connection to use.
File	The file to be uploaded
Path On Client	The complete path of the document. One of the fields that determines the FileType. Specify a complete path including the path extension in order for the document to be visible in the Preview tab.	path/to/file.csv
Version	Salesforce API Version Number.	63.0

{
  "data": {
    "id": "06Q606ExampleId",
    "success": true,
    "errors": []
  }
}

Upsert Record

Updates a Salesforce Record if it exists, otherwise creates a new Salesforce Record | key: upsertRecord

Input	Notes	Example
Connection	The Salesforce connection to use.
External ID Field Name	The name of the column that refers to the External ID Field	ExtId__c
Records	The records to be upserted
Record Type	The type of Salesforce Record.	Account
Version	Salesforce API Version Number.	63.0

{
  "data": [
    {
      "id": "00190000001pPvHAAU",
      "errors": [],
      "success": true,
      "created": true
    }
  ]
}

Validate Connection

Returns a boolean value that specifies whether the provided Connection is valid | key: validateConnection

Input	Notes	Example
Connection	The Salesforce connection to use.
Version	Salesforce API Version Number.	63.0

Changelog

2026-02-04

Added OAuth 2.0 Client Credentials connection for server-to-server authentication without user interaction.

2025-10-17

Enhanced Flow management and data selection capabilities:

Improved the Flow Outbound Message Trigger to verify Namespace prefix settings for deploying and deleting outbound messages
Added Delete Instanced Flows and Outbound Messages action for cleanup of flows and outbound messages associated with a specific endpoint URL
Enhanced Subscribe to Record Changes action with improved flow creation and webhook subscription management
Improved record type selection with inline data source functionality and filter query capability for better data selection

2025-09-15

Added comprehensive Flow management actions as a functional replacement for workflow rules:

Create Flow - Create record triggered flows with outbound message functionality
Activate Flow - Activate existing flows
Deactivate Flow - Deactivate active flows
Update Flow - Update flow metadata and configuration
Delete Flow - Remove flows from the org
Get Flow - Retrieve flow details
List Flows - List all flows in the org
Flow Outbound Message Trigger - Webhook trigger that receives Salesforce outbound messages from flows, providing real time event processing for record changes

2025-05-09

Added inline data sources for bulk jobs, contacts, customers, leads, opportunities, profiles, record types, and users to enhance data selection capabilities

Query, create, update or delete Salesforce records

Description​

API Documentation​

Listening for events in Salesforce​

Example integration​

Connections​

Basic Authentication​

OAuth 2.0​

OAuth 2.0 Client Credentials​

Enable Client Credentials Flow​

Configure Run As User​

Configure the Connection​

Triggers​

Flow Outbound Message Webhook​

New and Updated Records​

Webhook​

Workflow Outbound Message Webhook (Deprecated)​

Data Sources​

Record Type Field Preview​

Record Type Field Value Preview​

Record Type Fields​

Record Types​

Record Types With Fields​

Select Bulk Job​

Select Contact​

Select Customer​

Select Flow​

Select Lead​

Select Opportunity​

Select Outbound Message​

Select Profile​

Select Record Type​

Select User​

Actions​

Abort Bulk Job​

Abort Bulk Query Job​

Activate Flow​

Add Attachment​

Add User Permission Set​

Bulk Insert Records​

Bulk Upsert Records​

Complete Upload Bulk Job​

Composite Requests​

Create Account​

Create Bulk Job​

Create Bulk Query Job​

Create Contact​

Create Customer​

Create Flow​

Create Lead​

Create Metadata​

Create Metadata Fields​

Create Opportunity​

Create Outbound Message​

Create Profile​

Create Record​

Create User​

Create Workflow Rule (Deprecated)​

Deactivate Flow​

Delete Account​

Delete Bulk Job​

Delete Bulk Query Job​

Delete Contact​

Delete Customer​

Delete Flow​

Delete Instanced Flows and Outbound Messages​

Delete Lead​

Delete Metadata​

Delete Opportunity​

Delete Profile​

Delete Record​

Delete Workflow Outbound Message​

Delete Workflow Rule (Deprecated)​

Describe Customer SObject​

Describe Object​

Describe Permissions​

Find Record​

Find Records​

Get Attachment​

Get Bulk Job Failed Record Results​