Salesforce

Salesforce module for RobinPath.

Package: @robinpath/salesforce | Category: Crm | Type: Integration

Authentication

salesforce.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the salesforce module when you need to:

• query -- Use salesforce.query to perform this operation
• getRecord -- Use salesforce.getRecord to perform this operation
• createRecord -- Use salesforce.createRecord to perform this operation
• updateRecord -- Use salesforce.updateRecord to perform this operation
• deleteRecord -- Use salesforce.deleteRecord to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure salesforce credentials.	object
query	query	object
getRecord	getRecord	object
createRecord	createRecord	object
updateRecord	updateRecord	object
deleteRecord	deleteRecord	object
upsertRecord	upsertRecord	object
describeObject	describeObject	object
listObjects	listObjects	object
search	search	object
createLead	createLead	object
createContact	createContact	object
createOpportunity	createOpportunity	object
createAccount	createAccount	object
createTask	createTask	object
createCase	createCase	object
getReport	getReport	object
listReports	listReports	object
bulkQuery	bulkQuery	object
getUser	getUser	object
listUsers	listUsers	object
getOrganization	getOrganization	object
runApex	runApex	object
getRecentRecords	getRecentRecords	object
searchRecords	searchRecords	object

Functions

setCredentials

Configure salesforce credentials.

Module: salesforce | Returns: object -- API response.

salesforce.setCredentials

Parameter	Type	Required	Description
instanceUrl	string	Yes	instanceUrl
accessToken	string	Yes	accessToken

---

query

query

Module: salesforce | Returns: object -- API response.

salesforce.query

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getRecord

getRecord

Module: salesforce | Returns: object -- API response.

salesforce.getRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createRecord

createRecord

Module: salesforce | Returns: object -- API response.

salesforce.createRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateRecord

updateRecord

Module: salesforce | Returns: object -- API response.

salesforce.updateRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteRecord

deleteRecord

Module: salesforce | Returns: object -- API response.

salesforce.deleteRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

upsertRecord

upsertRecord

Module: salesforce | Returns: object -- API response.

salesforce.upsertRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

describeObject

describeObject

Module: salesforce | Returns: object -- API response.

salesforce.describeObject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listObjects

listObjects

Module: salesforce | Returns: object -- API response.

salesforce.listObjects

Parameter	Type	Required	Description
input	string	No	Input parameter

---

search

search

Module: salesforce | Returns: object -- API response.

salesforce.search

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createLead

createLead

Module: salesforce | Returns: object -- API response.

salesforce.createLead

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createContact

createContact

Module: salesforce | Returns: object -- API response.

salesforce.createContact

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createOpportunity

createOpportunity

Module: salesforce | Returns: object -- API response.

salesforce.createOpportunity

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createAccount

createAccount

Module: salesforce | Returns: object -- API response.

salesforce.createAccount

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTask

createTask

Module: salesforce | Returns: object -- API response.

salesforce.createTask

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createCase

createCase

Module: salesforce | Returns: object -- API response.

salesforce.createCase

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getReport

getReport

Module: salesforce | Returns: object -- API response.

salesforce.getReport

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listReports

listReports

Module: salesforce | Returns: object -- API response.

salesforce.listReports

Parameter	Type	Required	Description
input	string	No	Input parameter

---

bulkQuery

bulkQuery

Module: salesforce | Returns: object -- API response.

salesforce.bulkQuery

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

Module: salesforce | Returns: object -- API response.

salesforce.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listUsers

listUsers

Module: salesforce | Returns: object -- API response.

salesforce.listUsers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getOrganization

getOrganization

Module: salesforce | Returns: object -- API response.

salesforce.getOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

runApex

runApex

Module: salesforce | Returns: object -- API response.

salesforce.runApex

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getRecentRecords

getRecentRecords

Module: salesforce | Returns: object -- API response.

salesforce.getRecentRecords

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchRecords

searchRecords

Module: salesforce | Returns: object -- API response.

salesforce.searchRecords

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Salesforce API error (${res.status}): ${t}	Check the error message for details
salesforce.setCredentials requires instanceUrl, accessToken.	Check the error message for details
salesforce.updateRecord requires an ID.	Check the error message for details
salesforce.deleteRecord requires an ID.	Check the error message for details
Salesforce: "..." not configured. Call salesforce.setCredentials first.	Check the error message for details

@desc "Query and validate result"
do
  set $result as salesforce.query
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Record

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Get record and iterate results"
do
  set $result as salesforce.getRecord
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createRecord

Create a new resource and capture the result.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Create record"
do
  set $result as salesforce.createRecord
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Create record and update record"
do
  set $created as salesforce.createRecord
  # Update the created item
  salesforce.updateRecord
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Get record and create record"
do
  set $existing as salesforce.getRecord
  if $existing == null
    salesforce.createRecord
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Salesforce workflow

Chain multiple salesforce operations together.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Query, get record, and more"
do
  set $r_query as salesforce.query
  set $r_getRecord as salesforce.getRecord
  set $r_createRecord as salesforce.createRecord
  print "All operations complete"
enddo

6. Safe query with validation

Check results before proceeding.

@desc "Setup authentication"
do
  salesforce.setCredentials $token
enddo

@desc "Query and validate result"
do
  set $result as salesforce.query
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• hubspot -- HubSpot module for complementary functionality
• pipedrive -- Pipedrive module for complementary functionality
• freshdesk -- Freshdesk module for complementary functionality
• intercom -- Intercom module for complementary functionality
• zoho -- Zoho module for complementary functionality