Skip to main content

SALESFORCE Library

The SALESFORCE Library is an importable library containing functions to connect, authenticate, and interact with the Salesforce API. This library is used in the Salesforce Adapter.

Import the SALESFORCE library into your project. Typically only the SALESFORCEclient module needs to be required in order to create the client and access the API methods.

require "SALESFORCE.SALESFORCEclient"

How it works:​

Use the Translator's built in help to review how to use each function:

SALESFORCEclient - sets up the adapter framework

Creates the Salesforce adapter framework, adding the various method modules to a metatable and storing the configurations added to the custom fields.

SALESFORCEcustom - makes API requests and returns the response

Takes in any API requests and parameters to make the API call and return the response. It also performs the OAuth2.0 authentication workflow to obtain the token to be used in subsequent requests.

The methods are set up so they're independent of salesforce objects, so they can be used for any custom objects you may have in your Salesforce setup.

SALESFORCEquery

By default, retrieves all the fields for a given object, up to 200 fields. Can be customized by using the query parameter.

SALESFORCEmodify

Creates or updates a Salesforce object by passing the object name, id and a table of fields and values to be created or updated in the object.

SALESFORCEmodifyBatch

Creates or updates a batch of Salesforce objects by passing a list of operations to be performed on Salesforce objects as table of parameters.

SALESFORCEdelete

Deletes a Salesforce object by specifying an object name and id.