Salesforce Component

Query, create, update or delete Salesforce records
Component key: salesforce#
DescriptionSalesforce is a customer relationship management (CRM) platform. This component gives you the ability to manage sales leads and records within the Salesforce platform.
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.
#
Salesforce Connections#
Salesforce Basic ConnectionIf you select Basic Auth, you will need to supply your Salesforce username and a password. Depending on your Salesforce setup, your password may have a security token attached to it. If security tokens in your Salesforce account are disabled, the password you need to supply is simply your Salesforce password. If security tokens are enabled in your Salesforce account, then the password you need to enter is the concatenation of your password and your security token.
For example, if your Salesforce password is p@$sw0rD
and the security token that Salesforce provides is ExAmPlE0000000000ExAmPlE
, then you should enter p@$sw0rDExAmPlE0000000000ExAmPlE
as your password in Prismatic.
You can manage security tokens by clicking your profile picture on the top-right of Salesforce, select My Settings, and then open Personal -> Reset My Security Token.
Input | Notes | Example |
---|---|---|
Input Login URL string / Required | Notes Your SalesForce Login URL - required for Basic Auth | Example https://my-company.my.salesforce.com/ |
Input Password string / Required | Notes The password of the Salesforce account | Example |
Input Username string / Required | Notes The username of the Salesforce account | Example |
#
Salesforce OAuth 2.0If you select OAuth 2.0, you will need to create and configure a Connected App within Salesforce. When you create your "Connected App" be sure to check Enable OAuth Settings, and enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Consult Salesforce to determine the proper OAuth Scopes to assign - to grant your integrations the same permissions that the user authenticating through OAuth has, select Full access (full). Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Once the app has been created, you will be provided with a Consumer Key and Consumer Secret. Take note of these keys:

Now, configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.
- For Client ID and Client Secret enter the Consumer Key and Consumer Secret that you noted previously
- Leave Scopes blank
- For Authorization URL enter https://login.salesforce.com/services/oauth2/authorize
- For Access Token URL enter https://YOUR-COMPANY.my.salesforce.com/services/oauth2/token, replacing YOUR-COMPANY with your Salesforce URL.

You should now be able to authenticate a user through Salesforce using OAuth 2.0.
Input | Default | Notes |
---|---|---|
Input Authorize URL string / Required Hidden Field | Default https://login.salesforce.com/services/oauth2/authorize | Notes The OAuth 2.0 Authorization URL for Salesforce |
Input Consumer Key string / Required | Default | Notes |
Input Consumer Secret password / Required | Default | Notes |
Input Revoke URL string / Required | Default https://login.salesforce.com/services/oauth2/revoke | Notes The OAuth 2.0 Revocation URL for Salesforce |
Input Scopes string Hidden Field | Default | Notes A space-delimited set of one or more scopes to get the user's permission to access. |
Input Token URL string / Required | Default https://login.salesforce.com/services/oauth2/token | Notes The OAuth 2.0 Token URL for Salesforce |
#
Triggers#
WebhookTrigger 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 Prismatic 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.
#
Actions#
Add User Permission SetAdds a Permission Set to the specified User | key: addUserPermissionSet
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Permission Set string / Required | Default | Notes Provide the name of the Permission Set | Example |
Input User Name string / Required | Default | Notes Provide a User Name | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create AccountCreate a Salesforce Account Record | key: createAccount
Input | Default | Notes | Example |
---|---|---|---|
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Industry string / Required | Default | Notes The type of account record | Example |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Account Type string / Required | Default | Notes The type of account record | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create ContactCreate a Salesforce contact | key: createContact
Input | Default | Notes | Example |
---|---|---|---|
Input Assistant string | Default | Notes Provide a string value that represents the name of the contact's assistant | Example |
Input Assistant's Phone string | Default | Notes Provide a string value that represents the phone number of the contact's assistant | Example |
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input Birthdate string | Default | Notes Provide a string value that represents the birthdate | Example YYYY-MM-DD |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Department string | Default | Notes Provide a string value that represents the name of the contact's department | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Email Address string / Required | Default | Notes The email address for the object | Example someone@example.com |
Input Fax string | Default | Notes Provide a string value for the fax number | Example 18008999372 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input First Name string | Default | Notes The first name of the contact at the company | Example John |
Input Last Name string | Default | Notes The last name of the contact at the company | Example Smith |
Input Mobile Phone string | Default | Notes The mobile phone number for the object | Example 18005555555 |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Title string | Default | Notes The title of the object | Example Example Title |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create CustomerCreate a Salesforce customer account | key: createCustomer
Input | Default | Notes | Example |
---|---|---|---|
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Fax string | Default | Notes Provide a string value for the fax number | Example 18008999372 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Industry string / Required | Default | Notes The type of account record | Example |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Rating string | Default | Notes The rating for the lead. | Example |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create LeadCreate a Salesforce Lead Record | key: createLead
Input | Default | Notes | Example |
---|---|---|---|
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Company string / Required | Default | Notes The name of the company | Example Widgets Inc. |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Email Address string / Required | Default | Notes The email address for the object | Example someone@example.com |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input First Name string | Default | Notes The first name of the contact at the company | Example John |
Input Last Name string | Default | Notes The last name of the contact at the company | Example Smith |
Input Lead Source string | Default | Notes Provide a value for the source of the lead. | Example Web |
Input Lead Status string / Required | Default | Notes The status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted | Example Converted |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Rating string | Default | Notes The rating for the lead. | Example |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Title string | Default | Notes The title of the object | Example Example Title |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create OpportunityCreate a Salesforce Opportunity Record, which is a sale or pending deal | key: createOpportunity
Input | Default | Notes | Example |
---|---|---|---|
Input AccountId string | Default | Notes The Id of the account to reference | Example |
Input Amount string | Default | Notes Provide a number that represents the opportunity amount. | Example 38000 |
Input Close Date string / Required | Default | Notes The date the sale will close. | Example YYYY-MM-DD |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Lead Source string | Default | Notes Provide a value for the source of the lead. | Example Web |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Next Step string | Default | Notes Provide a string value for the next step of the sale. | Example |
Input Opportunity Type string / Required | Default | Notes Provide a value for what stage the sales process is in. | Example |
Input Probability string | Default | Notes The probability of the success of the sale | Example 09/01/2021 |
Input Stage string / Required | Default | Notes The stage the sale is currently in. | Example Prospecting |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create RecordCreate a Salesforce Record | key: createRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Create UserCreate a Salesforce User | key: createUser
Input | Default | Notes | Example |
---|---|---|---|
Input Alias string / Required | Default | Notes Provide an Alias for the User | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Email Address string / Required | Default | Notes The email address for the object | Example someone@example.com |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input First Name string | Default | Notes The first name of the contact at the company | Example John |
Input Last Name string | Default | Notes The last name of the contact at the company | Example Smith |
Input Profile string / Required | Default | Notes Provide the name of the User Profile | Example |
Input Time Zone string / Required | Default | Notes Time Zone in the format of 'America/New_York' | Example |
Input User Name string / Required | Default | Notes Provide a User Name | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Create Workflow Outbound MessageCreate a Workflow Outbound Message | key: createWorkflowOutboundMessage
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes Dynamic Fields, provided by value collection config variable, to include in the Outbound Message | Example |
Input Endpoint URL string / Required | Default | Notes The endpoint URL to send the outbound message / webhook to | Example |
Input Fields string Value List | Default | Notes Fields to include in the Outbound Message | Example |
Input Integration User Email string / Required | Default | Notes The email of the user under which the payload is sent | Example |
Input Name string / Required | Default | Notes Name for the component | Example |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Create Workflow RuleCreate a Workflow Rule | key: createWorkflowRule
Input | Default | Notes | Example |
---|---|---|---|
Input Active boolean | Default true | Notes Determines if this Rule is active | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Filter Criteria code / Required | Default | Notes Filter Criteria data structure to use with the Rule | Example |
Input Outbound Message Actions string Value List | Default | Notes Full Names of the Outbound Message Actions for this Rule to fire | Example |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Rule Name string / Required | Default | Notes Name of the Workflow Rule | Example |
Input Trigger Type string / Required | Default onAllChanges | Notes Conditions in which the trigger fires | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete AccountDelete an existing account record | key: deleteAccount
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete ContactDelete an existing contact record | key: deleteContact
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete CustomerDelete an existing customer account record | key: deleteCustomer
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete LeadDelete a Salesforce Lead Record | key: deleteLead
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Record ID string / Required | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
#
Delete OpportunityDelete an existing opportunity record | key: deleteOpportunity
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete RecordDelete an existing Salesforce Record | key: deleteRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete Workflow Outbound MessageDelete a Workflow Outbound Message | key: deleteWorkflowOutboundMessage
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Full Name Identifier string / Required | Default | Notes Unique identifier for Metadata/Workflow objects | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Delete Workflow RuleDelete a Workflow Rule | key: deleteWorkflowRule
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Full Name Identifier string / Required | Default | Notes Unique identifier for Metadata/Workflow objects | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Find RecordFind a single Salesforce Record | key: findRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Types string Key Value List | Default | Notes For each item, provide the key and the type of the corresponding field Value you entered above. | Example |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Find RecordsFind and fetch Salesforce Records | key: findRecords
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Types string Key Value List | Default | Notes For each item, provide the key and the type of the corresponding field Value you entered above. | Example |
Input Page Number string | Default | Notes Provide an integer value for which page to return when paginating results. | Example 3 |
Input Page Size string | Default | Notes Provide an integer value for the maximum results returned per page when paginating results. | Example 20 |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Get Current UserReturn information about the current session's user | key: getCurrentUser
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Get RecordGet a single Salesforce Record by Id | key: getRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
List Workflow Outbound MessagesList all Workflow Outbound Messages | key: listWorkflowOutboundMessages
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
List Workflow RulesList all Workflow Rules | key: listWorkflowRules
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Raw RequestIssue a raw HTTP request with the configured connection | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Data string | Default | Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean | Default | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input Form Data string Key Value List | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string | Default | Notes | Example |
Input Query Parameter string Key Value List | Default | Notes 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. | Example |
Input Response Type string | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example binary |
Input Retry Delay (ms) string | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Retry On All Errors boolean | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Timeout string | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required | Default | Notes This is the URL to call. | Example /sobjects/Account |
Input Use Exponential Backoff boolean | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Remove User Permission SetRemoves a Permission Set from the specified User | key: removeUserPermissionSet
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Permission Set string / Required | Default | Notes Provide the name of the Permission Set | Example |
Input User Name string / Required | Default | Notes Provide a User Name | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Salesforce QueryRun an SOQL Query Against SalesForce | key: query
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input SOQL Query string / Required | Default | Notes A SalesForce Object Query Language (SOQL) query | Example SELECT Id, Name FROM Opportunity |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Update AccountUpdate an existing account record | key: updateAccount
Input | Default | Notes | Example |
---|---|---|---|
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Industry string / Required | Default | Notes The type of account record | Example |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Account Type string / Required | Default | Notes The type of account record | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Update ContactUpdate an existing contact record | key: updateContact
Input | Default | Notes | Example |
---|---|---|---|
Input Assistant string | Default | Notes Provide a string value that represents the name of the contact's assistant | Example |
Input Assistant's Phone string | Default | Notes Provide a string value that represents the phone number of the contact's assistant | Example |
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input Birthdate string | Default | Notes Provide a string value that represents the birthdate | Example YYYY-MM-DD |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Department string | Default | Notes Provide a string value that represents the name of the contact's department | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Email Address string / Required | Default | Notes The email address for the object | Example someone@example.com |
Input Fax string | Default | Notes Provide a string value for the fax number | Example 18008999372 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input First Name string | Default | Notes The first name of the contact at the company | Example John |
Input Last Name string | Default | Notes The last name of the contact at the company | Example Smith |
Input Mobile Phone string | Default | Notes The mobile phone number for the object | Example 18005555555 |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Title string | Default | Notes The title of the object | Example Example Title |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Update CustomerUpdate an existing customer account record | key: updateCustomer
Input | Default | Notes | Example |
---|---|---|---|
Input Billing City string | Default | Notes The city of the object's billing address | Example Cupertino |
Input Billing Country string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Postal Code string | Default | Notes The zip code of the object's billing address | Example 94024 |
Input Billing State string | Default | Notes The state of the object's billing address | Example CA |
Input Billing Street Address string | Default | Notes The street address of the billing object | Example 4 Privet Drive |
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Connection connection / Required | Default | Notes | Example |
Input Country string | Default | Notes The country of the object's address | Example United States |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Fax string | Default | Notes Provide a string value for the fax number | Example 18008999372 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Industry string / Required | Default | Notes The type of account record | Example |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Rating string | Default | Notes The rating for the lead. | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Update LeadUpdate a Salesforce Lead Record | key: updateLead
Input | Default | Notes | Example |
---|---|---|---|
Input City string | Default | Notes The city of the object's address | Example Cupertino |
Input Company string / Required | Default | Notes The name of the company | Example Widgets Inc. |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Email Address string / Required | Default | Notes The email address for the object | Example someone@example.com |
Input Number of Employees string | Default | Notes The number of employees associated with the object. | Example 30 |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input First Name string | Default | Notes The first name of the contact at the company | Example John |
Input Last Name string | Default | Notes The last name of the contact at the company | Example Smith |
Input Lead Source string | Default | Notes Provide a value for the source of the lead. | Example Web |
Input Lead Status string / Required | Default | Notes The status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not Converted | Example Converted |
Input Phone string | Default | Notes The primary phone number for the object | Example 18005555555 |
Input Postal Code string | Default | Notes The zip code of the object's address | Example 94024 |
Input Rating string | Default | Notes The rating for the lead. | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Annual Revenue string | Default | Notes The estimated annual revenue of the object | Example |
Input State string | Default | Notes The state of the object's address | Example CA |
Input Street Address string | Default | Notes The street address of the object | Example 4 Privet Drive |
Input Title string | Default | Notes The title of the object | Example Example Title |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
Input Website string | Default | Notes Provide a valid URL for the website of the object | Example website-example.com |
#
Update OpportunityUpdate an existing opportunity record | key: updateOpportunity
Input | Default | Notes | Example |
---|---|---|---|
Input AccountId string | Default | Notes The Id of the account to reference | Example |
Input Amount string | Default | Notes Provide a number that represents the opportunity amount. | Example 38000 |
Input Close Date string / Required | Default | Notes The date the sale will close. | Example YYYY-MM-DD |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description of the object | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Lead Source string | Default | Notes Provide a value for the source of the lead. | Example Web |
Input Name string / Required | Default | Notes The name of the object | Example myExampleObject |
Input Next Step string | Default | Notes Provide a string value for the next step of the sale. | Example |
Input Opportunity Type string / Required | Default | Notes Provide a value for what stage the sales process is in. | Example |
Input Probability string | Default | Notes The probability of the success of the sale | Example 09/01/2021 |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Stage string / Required | Default | Notes The stage the sale is currently in. | Example Prospecting |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Update RecordUpdates an existing Salesforce Record | key: updateRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Record ID string / Required | Default | Notes The ID of a Salesforce Record | Example 0017000000hOMChAAO |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Update UserUpdate a Salesforce User | key: updateUser
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input User Name string / Required | Default | Notes Provide a User Name | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Output Example Payload{ "data": { "id": "06Q606ExampleId", "success": true }}
#
Upsert RecordUpdates a Salesforce Record if it exists, otherwise creates a new Salesforce Record | key: upsertRecord
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Dynamic Fields data | Default | Notes A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable. | Example |
Input External ID Field Name string / Required | Default | Notes The name of the column that refers to the External ID Field | Example ExtId__c |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record | Example |
Input Record Type string / Required | Default | Notes The type of Salesforce Record | Example Account |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |
#
Validate ConnectionReturns a boolean value that specifies whether the provided Connection is valid | key: validateConnection
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Version string | Default 51.0 | Notes Salesforce API Version Number | Example 51.0 |