Salesforce
App Vendor: Salesforce
App Category: Case/Ticket Management
Connector Version: 1.2.0
API Version: v56.0
About App
Salesforce is a cloud-based Customer Relationship Management (CRM) software that helps businesses connect with and get more information about their customer base.
The Salesforce app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Create Account | This action creates an account. |
Create Case | This action creates a case. |
Create Contact | This action creates a contact. |
Create Contact Role | This action creates a contact role. |
Create Opportunity | This action creates an opportunity. |
Create Opportunity Line Item | This action creates an opportunity line item. |
Generic Action | This is a generic action to perform any additional use case on Salesforce. |
Get Account Details | This action retrieves the details of an account. |
Get Case Details | This action retrieves the details of a case. |
Get Opportunity Details | This action retrieves the details of an opportunity. |
List Opportunities | This action retrieves a list of opportunities. |
Query All Results | This action performs a query of all results. |
Query on Salesforce | This action performs a query using SQL parameters. |
Update Account | This action updates an account. |
Update Case | This action updates a case. |
Update Opportunity Stage | This action updates the stage of an opportunity. |
Configuration Parameters
The following configuration parameters are required for the Salesforce app to communicate with the Salesforce enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Consumer Key | Enter the consumer key. | Text | Required |
|
Client Secret | Enter the client secret. | Password | Required |
|
Username | Enter the username. | Text | Required |
|
Password | Enter the password. | Password | Required |
|
Security Token | Enter the security token. | Password | Required |
|
Production Mode | Enter true to activate production mode. | Boolean | Required | Allowed values:
|
Action: Create Account
This action creates an account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create an account. Example: $JSON[{"Name":"Prod Account"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"Prod Account"
}
}
]Action: Create Case
This action creates a case.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create a case. Example: $JSON[{"Name":"Users Case"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"Users Case"
}
}
]Action: Create Contact
This action creates a contact.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create a contact. Example: $JSON[{"Name":"Email Demographics"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"Email Demographics"
}
}
]Action: Create Contact Role
This action creates a contact role.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create a contact role. Example: $JSON[{"Name":"Administrators"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"Administrators"
}
}
]Action: Create Opportunity
This action creates an opportunity.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create an opportunity. Example: $JSON[{"Name":"New Customer"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"New Customer"
}
}
]Action: Create Opportunity Line Item
This action creates an opportunity line item.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to create an opportunity line item. Example: $JSON[{"Name":"Product Opportunity"}] | Any | Required |
|
Example Request
[
{
"payload":{
"Name":"Product Opportunity"
}
}
]Action: Generic Action
This is a generic action to perform any additional use case on Salesforce app.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload in JSON format to perform a generic action. Example: $JSON[{"name":"Prod account"}] | Any | Required |
|
Endpoint | Enter the endpoint to send the request. Example: "/services/data/v54.0/sobjects/account/" | Text | Required |
|
Query Params | Enter the query parameters to filter the result. Example: "select+id+from+account+limit+1" | Text | Required |
|
Method | Enter the method to perform generic action. | Text | Required | Allowed values:
|
Example Request
[
{
"payload":{
"Name":"Prod account",
"endpoint":"/services/data/v54.0/sobjects/account/",
"query_param":"select+id+from+account+limit+1"
}
}
]Action: Get Account Details
This action retrieves the details of an account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account ID | Enter the account ID to retrieve the details of an account. Example: "0015500000WO1ZiAAL" | Text | Required | You can retrieve the Account ID using the Query on Salesforce action. |
Example Request
[
{
"account_id":"0015500000WO1ZiAAL"
}
}
]Action: Get Case Details
This action retrieves the details of a case.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Case ID | Enter a case ID to get the details of a case. Example: "5003000000D8cuI" | Text | Required | You can retrieve the Case ID using the Query on Salesforce action. |
Example Request
[
{
"case_id":"5003000000D8cuI"
}
}
]Action: Get Opportunity Details
This action retrieves the details of an opportunity.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Opportunity ID | Enter the opportunity ID to retrieve the details. Example: "0065i000002ipqhaai" | Text | Required | You can retrieve the Opportunity ID using the List Opportunities action. |
Example Request
[
{
"opportunity_id":"0065i000002ipqhaai"
}
}
]Action: List Opportunities
This action retrieves a list of opportunities.
Action Input Parameters
This action does not require any input parameter.
Action: Query on Salesforce
This action performs a query using the SQL parameters.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the query in Structured Query Language (SQL) to retrieve data. Example: "SELECT StageName FROM Opportunity" | Text | Required |
|
Consume All Results | Enter true to consume all the records. | Boolean | Optional | Default value: false. |
Example Request
[
{
"query":"SELECT StageName FROM Opportunity"
}
}
]Action: Update Account
This action updates an account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload to update an account. Example: {"Name":"Prod account"} | Key Value | Required | |
Account ID | Enter an account ID to update the account. Example: "0015500000WO1ZiAAL" | Text | Required | You can retrieve the Account ID using the Query on Salesforce action. |
Example Request
[
{
"payload":{"Name":"Prod account"},
"account_id":"0015500000WO1ZiAAL"
}
}
]Action: Update Case
This action updates a case.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload to update the case. Example: {"Name":"Prod account"} | Key Value | Required | |
Case ID | Enter a case ID to update the case. Example: "5003000000D8cuI" | Text | Required | You can retrieve the Case ID using the Query on Salesforce action. |
Example Request
[
{
"payload":{"Name":"Prod account"},
"case_id":"5003000000D8cuI"
}
}
]Action: Update Opportunity Stage
This action updates the stage of an opportunity.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Payload | Enter the payload to update the stage of an opportunity. Example: {"Name":"Prod account"} | Key Value | Required | |
Opportunity ID | Enter an opportunity ID to update the stage of an opportunity. Example: "0065i000002ipqhaai" | Text | Required | You can retrieve the Opportunity ID using the List Opportunities action. |
Example Request
[
{
"payload":{"Name":"Prod account"},
"opportunity_id":"0065i000002ipqhaai"
}
}
]