Salesforce Adapter

The Salesforce adapter facilitates communication with Salesforce from Integration Gateway (IG). Currently, the adapter supports Salesforce's REST API, Bulk API 1.0, and Bulk API 2.0.

For authentication, it's recommended to use an External Client App. For information on External Client Apps, see the Salesforce documentation.

Adapter Config

Field	Description	Example
Host	REQUIRED | The domain of a Salesforce org.	my-org.my.salesforce.com
Authentication Type	REQUIRED | The method of authenticating with Salesforce. Available methods are: Client Credentials (recommended) and Password.	Client Credentials
Client ID	REQUIRED | The Customer Key for an External Client App.	3MVG9dAEux2v1sLu1nEMEi2A0gJw6yQyZTbXuAUzDT7yRSe5R05pzQ.UR3bBAemuOCEctQ5ppm5YK5Z4laKCj
Client Secret	REQUIRED | The Customer Secret for an External Client App.	16D1B629C81A9D002243906E3F8D5DF36841CD770DA8F00C0C0A663A6CD6DE6D
Username	OPTIONAL | The username of a Salesforce user. This is only required when "Authentication Type" is Password.	my_username
Password	OPTIONAL | The password for a Salesforce user. This is only required when "Authentication Type" is Password.	my_password
Salesforce API Version	REQUIRED | The version of the Salesforce API to use for REST API calls. Defaults to v45.0.	v45.0
Bulk Upload Poll Interval (seconds)	REQUIRED | The interval at which Bulk Uploads are polled. Defaults to 2 seconds.	2
Bulk Upload API Version	REQUIRED | The version of the Salesforce API to use for Bulk API uploads. Defaults to v45.0.	v45.0
Bulk Query Poll Interval (seconds)	REQUIRED | The interval at which Bulk Queries are polled. Defaults to 2 seconds.	2
Bulk Query API Version	REQUIRED | The version of the Salesforce API to use for Bulk API queries. Defaults to v45.0.	v45.0
Connection Timeout (seconds)	REQUIRED | The number of seconds before an API call times out. Defaults to 2100.	2100

Field Mappings

The Field Mappings for the Salesforce adapter differ depending on the Service Name passed to the Service Request.

Currently, the following Service Names are supported: BULK_UPLOAD and BULK_QUERY for Bulk API 1.0, BULK_UPLOAD_2 and BULK_QUERY_2 for Bulk API 2.0, and anything else for the REST API.

Any non-adapter-specific Field Mappings are automatically included in the request body.

REST API

Service Name: Any

Field	Description	Example
method	REQUIRED | The HTTP method. Any of: GET, POST, PUT, PATCH, or DELETE.	GET
url	REQUIRED | The REST API endpoint. The endpoint is appended to the host specified in the adapter config.	/services/data/v67.0/sobjects/Account/
allOrNone	OPTIONAL | A flag indicating that, for a composite request, all sub-requests must succeed; otherwise, all requests are rolled back.	false

Bulk API 1.0

Service Name: BULK_QUERY

Field	Description	Example
operation	REQUIRED | The type of operation to perform. The following operations are supported: query and queryAll.	query
q	REQUIRED | The SOQL query.	SELECT Id, Name FROM Account
object	REQUIRED | The Salesforce object being queried.	Account

Service Name: BULK_UPLOAD

Field	Description	Example
operation	REQUIRED | The type of operation to perform. The following operations are supported: insert, update, upsert, delete, and hardDelete.	upsert
object	REQUIRED | The Salesforce object being inserted, updated, or deleted.	Account
headers	REQUIRED | A list of strings, where each string represents a field/column on the Salesforce object.	["Id", "Name"]
records	REQUIRED | A list of lists, where each sublist contains the field values for a record of the Salesforce object in the order specified by headers.	[[1, "John Doe"]]

Bulk API 2.0

Service Name: BULK_QUERY_2

Field	Description	Example
operation	REQUIRED | The type of operation to perform. The following operations are supported: query and queryAll.	query
q	REQUIRED | The SOQL query.	SELECT Id, Name FROM Account

Service Name: BULK_UPLOAD_2

Field	Description	Example
operation	REQUIRED | The type of operation to perform. The following operations are supported: insert, update, upsert, delete, and hardDelete.	upsert
object	REQUIRED | The Salesforce object being inserted, updated, or deleted.	Account
headers	REQUIRED | A list of strings, where each string represents a field/column on the Salesforce object.	["Id", "Name"]
records	REQUIRED | A list of lists, where each sublist contains the field values for a record of the Salesforce object in the order specified by headers.	[[1, "John Doe"]]