Skip to main content

Salesforce

Salesforce is a leading customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer service, and analytics through cloud-based applications and services.

Salesforce icon

Power end-to-end data operations for your Salesforce API with Nexla. Our bi-directional Salesforce connector is purpose-built for Salesforce, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Salesforce or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Salesforce workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to Salesforce over OAuth 2.0. You sign in to Salesforce and approve access — Nexla never asks for or stores a Salesforce password. Before you begin, check that:

  • Your Salesforce edition includes API access. Enterprise, Unlimited, Performance, and Developer editions include it. Professional Edition requires the API add-on. If you aren't sure, ask your Salesforce administrator.

  • Your Salesforce user has the API Enabled permission. This is standard on most profiles, but restricted profiles sometimes have it turned off. An administrator can enable it under Setup > Users, on the user's profile or an assigned permission set, under System Permissions.

  • That user can see the data you want to move. Nexla operates under the permissions of whoever authorizes the connection, so it can read and write exactly what that person can. For production flows, authorize with a dedicated integration user rather than a personal account.

Set up Salesforce​

Nexla connects either through an app you create in your own Salesforce org, or through Nexla's Salesforce app. Each needs a one-time action from a Salesforce administrator. After that, creating credentials in Nexla is the same either way.

Your own Salesforce appNexla's Salesforce app
One-time Salesforce setupAn administrator creates an external client appAn administrator approves Nexla for your org
Scopes, token policies, and IP restrictionsSet by you, in your orgSet by Nexla
Choose this ifYour security team wants control over the app's permissions and policiesYou want to connect without creating an app

Ask your Salesforce administrator to follow these steps and send you the resulting Consumer Key and Consumer Secret. Everything happens in Salesforce Setup — no Nexla access is needed.

  1. Go to Setup. In the Quick Find box, enter External Client, select External Client App Manager, and click New External Client App.

  2. Enter a name that identifies the integration, such as Nexla, and a Contact Email. Set Distribution State to Local, which keeps the app private to your org.

  3. Expand the API (Enable OAuth Settings) section and select Enable OAuth.

  4. In the Callback URL field, enter both of these, one per line:

    https://dataops.nexla.io/oauth2Auth
    https://dataops.nexla.io/nexla-api/oauth/callback

    Each has to match exactly, or Salesforce rejects the authorization with a redirect_uri_mismatch error. If your organization runs a dedicated Nexla installation, replace https://dataops.nexla.io with your own Nexla address.

  5. From Available OAuth Scopes, move these three to Selected OAuth Scopes:

    • Manage user data via APIs (api) — reads and writes your Salesforce records over the REST and Bulk API 2.0 endpoints.
    • Perform requests at any time (refresh_token, offline_access) — keeps scheduled flows running without anyone re-authorizing.
    • Access the identity URL service (id, profile, email, address, phone) — confirms which user and org the credential is connected to.

    These cover standard and custom objects, which is what most flows use. Other Salesforce products need their own scope on top — CRM Analytics (wave_api), Data Cloud (cdp_query_api, cdp_ingest_api), or Account Engagement (pardot_api), for example. If you aren't sure what your team will connect to later, it's reasonable to add the ones that match products you own.

  6. In the same section, set the three security options:

    • Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows — enable. Nexla sends a PKCE challenge on every authorization.
    • Require Secret for the Web Server Flow — leave disabled. Nexla uses PKCE instead of a client secret at this step, so enabling this stops the authorization from completing.
    • Require Secret for Refresh Token Flow — enable. Nexla does send the client secret when it refreshes a token.

  7. Click Create. Salesforce may ask you to verify your identity by email.

  8. Open the new app, select the Settings tab, expand OAuth Settings, and click Consumer Key and Secret. These are the two values to send back — in Nexla they're entered as Client ID and Client Secret.

Optional hardening. On the app's Policies tab, you can also:

  • Set Permitted Users to Admin approved users are pre-authorized, then assign the profiles or permission sets allowed to connect Nexla.
  • Enable Refresh Token Rotation, and set Refresh Token Policy to expire the refresh token if it isn't used for 30 days. Nexla refreshes tokens continuously, so an active credential is never affected.
  • Set IP Relaxation to Enforce IP restrictions, and add Nexla's addresses — 34.231.167.112, 54.209.27.1, and 35.245.202.207 — to the login IP ranges of the profiles permitted to use the app.

A sandbox has its own external client apps. To connect a sandbox, repeat these steps in the sandbox org — a consumer key from your production org won't work there.

Authenticate​

Credentials required​

Connect using Nexla's shared Salesforce app — no app setup required. A Salesforce admin must approve Nexla for your org once. Works with production and sandbox.

FieldRequiredSecretDescription
Salesforce Instance TypeNoNoSalesforce Instance you wish to connect to. Allowed values: Production; Sandbox

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Salesforce

SalesforceCred_2.png

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Select the authentication method from the Authentication Type pulldown menu, and follow the corresponding instructions below.

Configure Authentication Settings

Connect to a production org using the external client app created in your Salesforce org.

  1. Enter the Consumer Key of your external client app in the Client ID field, and the Consumer Secret in the Client Secret field. Your Salesforce administrator obtains both when they create the app.
  2. Click the Authorize button, sign in to Salesforce, and approve access. Sign in as the user whose permissions this connection should operate under.
  3. Click Save. Nexla checks the connection before saving, so any configuration problem surfaces now rather than when a flow first runs.
  1. The credential now appears as a tile on the Authenticate screen and can be selected for any Salesforce data source or destination.

Nexla refreshes Salesforce access tokens automatically, so scheduled flows keep running without anyone re-authorizing. If a credential does stop working — because an administrator revoked access, or the refresh token expired under your org's policy — Nexla flags it, and reconnecting is a matter of opening the credential and clicking Authorize again. The flows using it are unaffected.

Use as a data source​

With Nexla's bi-directional connectors, users can quickly and easily add Salesforce as a data source in a FlexFlow or DirectFlow data flow to begin ingesting data from your Salesforce instance.

Create a New Data Flow​

  1. To create a new FlexFlow or DirectFlow data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the FlexFlow or DirectFlow option from the list of flow types, and click the Create button.

  2. Select the Salesforce connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Salesforce instance, and click Next; or, create a new Salesforce credential for use in this flow.

  3. In Nexla, Salesforce data sources can be created using pre-built endpoint templates, which expedite source setup for common Salesforce endpoints. Each template is designed specifically for the corresponding Salesforce endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Salesforce sources can also be configured manually, allowing you to ingest data from Salesforce endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Salesforce endpoints. Each template is designed specifically for the corresponding Salesforce endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed below. Click on a template to expand it, and follow the instructions to configure the endpoint settings.

    Bulk API 2.0 Query

    This template is designed for bulk API 2.0 queries that enable asynchronous processing of SOQL queries.

    • Enter the SOQL query that will be used to fetch data from Salesforce in the SOQL Query field. More information about creating and using bulk API 2.0 queries is available in Salesforce documentation.

    Bulk API 2.0 is designed for processing large volumes of data asynchronously. Queries are submitted as jobs that run in the background, making it ideal for extracting large datasets without blocking other operations. The Bulk API 2.0 supports both query and data manipulation operations. For complete information about Bulk API 2.0 queries, see the Salesforce Bulk API 2.0 Query Documentation.

    Bulk API 3.0 Object

    This template is designed for updated bulk API 3.0 queries that enable asynchronous processing of SOQL queries.

    Bulk API 3.0 provides enhanced capabilities for bulk data operations with improved performance and additional features compared to Bulk API 2.0. The API 3.0 supports the same asynchronous query processing model with additional optimizations. For complete information about Bulk API 3.0, see the Salesforce Bulk API 3.0 Documentation.

    Execute SOQL Query

    This template is designed to fetch resources using a SOQL query.

    1. Enter the SOQL query that will be used to fetch data from Salesforce in the SOQL Query to Be Executed field. More information and sample queries are available in Salesforce documentation.
    2. By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

    SOQL (Salesforce Object Query Language) is similar to SQL and is used to query Salesforce data. SOQL queries can retrieve records from standard and custom objects, filter results, and sort data. The REST API query endpoint executes SOQL queries synchronously and returns results immediately. For complete information about SOQL queries, see the Salesforce SOQL Query Documentation.

    Fetch All Accounts

    This template uses a predefined SOQL query to fetch basic information about all accounts, including the name, ID, account number, annual revenue, and industry.

    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.
      More information about using SOQL queries with Salesforce is available here.

    This template provides a quick way to extract account data from Salesforce. The predefined query retrieves common account fields including name, ID, account number, annual revenue, and industry. For complete information about Salesforce Account objects and fields, see the Salesforce Account Object Documentation.

    Fetch All Contacts

    This template uses a predefined SOQL query to fetch basic information about all contacts, including the name & ID.

    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.
      More information about using SOQL queries with Salesforce is available here.

    This template provides a quick way to extract contact data from Salesforce. The predefined query retrieves basic contact information including name and ID. For complete information about Salesforce Contact objects and fields, see the Salesforce Contact Object Documentation.

    Fetch All Metadata for Object

    This template uses a predefined SOQL query to completely describe the individual metadata at all levels for the specified standard Salesforce object.

    • Select or enter the name of the standard object for which metadata will be fetched in the Standard Object Name field.
      More information about using SOQL queries with Salesforce is available here.
    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

    Object metadata includes information about fields, relationships, and object properties. This template uses the describe API to retrieve comprehensive metadata for a specified object. For complete information about Salesforce object metadata, see the Salesforce Describe Global Documentation.

    Fetch All Opportunities

    This template uses a predefined SOQL query to fetch basic information about all opportunities, including the name, ID, type, amount, description, and probability fields.

    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.
      More information about using SOQL queries with Salesforce is available here.

    This template provides a quick way to extract opportunity data from Salesforce. The predefined query retrieves common opportunity fields including name, ID, type, amount, description, and probability. For complete information about Salesforce Opportunity objects and fields, see the Salesforce Opportunity Object Documentation.

    Fetch Object Records: All Fields

    This template is designed to retrieve all fields of all records associated with a specified object.

    A Nexla Data API Nexset is required to generate the relevant query for this endpoint.

    • Enter or select the name of the object for which records will be fetched in the Object Name field.
    • Enter the URL of the Nexla data feed API that generates query snippets containing the relevant Salesforce fields for the selected object in the Nexset Data Feed URL: API Proxy field.

    This template dynamically generates SOQL queries based on the object's field structure. The Nexla Data API Nexset provides the field information needed to construct the query. This approach ensures that all available fields are included in the query, even if new fields are added to the object later. For complete information about Salesforce object fields and SOQL queries, see the Salesforce SOQL Query Documentation.

    Fetch Object Records: All Fields – Incremental Load

    This template is designed to retrieve all fields of all records associated with a specified object that have been modified since the previous day.

    A Nexla Data API Nexset is required to generate the relevant query for this endpoint.

    • Enter or select the name of the object for which records will be fetched in the Object Name field.
    • Enter the URL of the Nexla data feed API that generates query snippets containing the relevant Salesforce fields for the selected object in the Nexset Data Feed URL: API Proxy field.

    Incremental load queries use the LastModifiedDate field to filter records that have been modified since a specific date. This approach is efficient for syncing only changed data rather than extracting all records each time. The template automatically filters records modified since the previous day. For complete information about incremental data loading with Salesforce, see the Salesforce SOQL Query Documentation.

    Fetch Opportunity by ID

    This template is designed to retrieve all fields of a specified Salesforce opportunity.

    More information is available in the Salesforce documentation.

    • Enter the ID of the opportunity for which fields will be fetched in the Opportunity ID field.
    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

    This template uses the REST API retrieve endpoint to fetch a single record by its ID. The retrieve endpoint returns all fields for the specified record, making it useful for getting complete record details. For complete information about retrieving records by ID, see the Salesforce Retrieve SObject Documentation.

    Get All Objects

    This template retrieves a list of all objects in the organization that are available to the logged-in user, as well as the organization encoding and the maximum batch size permitted in queries.

    More information about this endpoint is available in Salesforce documentation.

    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

    The describe global endpoint returns metadata about all available objects in your Salesforce organization, including standard objects, custom objects, and their properties. This is useful for discovering available objects before configuring more specific queries. For complete information about describing global objects, see the Salesforce Describe Global Documentation.

    Get Fields of Object: API Proxy

    This template creates a Nexla API proxy source that fetches all fields for a given custom or standard Salesforce object. Ideally, only one copy of this source is needed in your Nexla account.

    More information about this endpoint is available in Salesforce documentation.

    • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

    This template uses the describe endpoint to retrieve detailed field information for a specific object. The describe endpoint returns comprehensive metadata about object fields, including field types, relationships, and validation rules. This information can be used to build dynamic queries or understand object structure. For complete information about describing object fields, see the Salesforce Describe SObject Documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Salesforce data sources can be manually configured to ingest data from any valid Salesforce API endpoint.

With manual configuration, you can also create more complex Salesforce sources, such as sources that use chained API calls to fetch data from multiple endpoints.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Salesforce API from the Method pulldown menu.

API Endpoint URL​

  1. Enter the URL of the Salesforce API endpoint from which this source will fetch data in the Set API URL field.

Salesforce API URLs typically follow the format: https://{instance}.salesforce.com/services/data/v{version}/query?q={SOQL} for queries, or https://{instance}.salesforce.com/services/data/v{version}/sobjects/{ObjectName} for object operations. Replace {instance} with your Salesforce instance URL, {version} with the API version (e.g., v59.0), and {ObjectName} with the object name. Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For complete information about Salesforce API endpoints, see the Salesforce REST API Documentation.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter {now-4} to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data.
    • For responses in XML format, enter the XPath that points to the object/array containing relevant data.
    Path to Data Example:

    If the API response is in JSON format and includes a top-level array named data that contains the relevant data, the path to the response would be entered as $.data[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For example, when a request call is used to fetch a list of items, the API response will typically include an array of records along with metadata. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Authentication headers (OAuth 2.0 access tokens) are automatically included from your credentials. However, you may need to include additional headers for specific Salesforce API features. The Content-Type header should be set to application/json for most Salesforce API requests.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Salesforce data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow or DirectFlow data flow that sends data to a Salesforce location.

  1. Click the + icon on the Nexset that will be sent to the Salesforce destination, and select the Send to Destination option from the menu.

  2. Select the Salesforce connector from the list of available data destinations. Then, select the credential that will be used to connect to the Salesforce organization, and click Next; or, create a new Salesforce credential for use in this flow.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Salesforce endpoints. Each template is designed specifically for the corresponding Salesforce endpoint, making destination setup easy and efficient.

Salesforce Destination Template
Example: Batch Update Objects

SF_Dest1.png
  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu; then, follow the instructions in the corresponding section below to configure additional endpoint settings.

Batch Update (Upsert) Objects​

Select this template to update the fields of an existing Salesforce object with data from the Nexset records using an upsert operation. This endpoint triggers a PATCH request, so only the fields that are present in each record will be updated.

  1. Enter the API name of the Salesforce object that will be updated in the API Name of Object to be Updated field.

    • For standard Salesforce objects, the API name is the name of the standard object (e.g., Account, Contact, Opportunity).

    • For custom Salesforce objects, the API name is the name of the custom object with the suffix __c—for example, if a custom object is named "Inventory", the API name of this object would be Inventory__c.

  2. By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

The upsert operation will update existing records if a matching external ID is found, or create new records if no match exists. Upsert operations are efficient for syncing data when you're not sure whether records already exist. The PATCH method ensures that only provided fields are updated, leaving other fields unchanged. For complete information about Salesforce upsert operations, see the Salesforce Upsert SObject Documentation.

Create New Opportunities​

Select this template to create new Salesforce opportunities with data from the Nexset records. This template is designed to create new opportunities; it will not update existing opportunities.

  • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

This template uses the REST API create endpoint to insert new opportunity records. Each record in your Nexset will create a new opportunity in Salesforce. Required fields for opportunities (such as Name, StageName, and CloseDate) should be included in your Nexset data. For complete information about creating Salesforce records, see the Salesforce Create SObject Documentation.

Update Fields of an Opportunity​

Select this template to update the fields of an existing Salesforce opportunity with data from the Nexset records. To use this template, the Nexset must include an attribute named Id, and its value for each record must be the ID of the opportunity to be updated with data from that record.

Batch Update (Upsert) Objects template can provide better performance for updating multiple opportunities.

  • By default, Nexla will execute this query using the latest available Salesforce API version. To use a different version, enter the API version in the format of v59.0 in the Salesforce API Version field.

This template uses the REST API update endpoint to modify existing opportunity records. The Id field in each record identifies which opportunity to update. Only fields included in the Nexset data will be updated; other fields remain unchanged. For complete information about updating Salesforce records, see the Salesforce Update SObject Documentation.

Configure Manually​

Salesforce destinations can be manually configured to send Nexset data to any valid Salesforce API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Salesforce API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Salesforce API from the Method pulldown menu. The most common methods for Salesforce destinations are:

    • POST: For creating new records
    • PATCH: For updating existing records (upsert operations)
    • PUT: For updating existing records

Data Format​

  1. Select the format in which the Nexset data will be sent to the Salesforce API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Salesforce API accepts JSON in request bodies and returns JSON in response bodies. Ensure you select JSON as the content format for Salesforce API destinations. For complete information about Salesforce API request formats, see the Salesforce REST API Documentation.

API Endpoint URL​

  1. Enter the URL of the Salesforce API endpoint to which you want to send the Nexset data in the URL field. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Salesforce API URLs typically follow the format: https://{instance}.salesforce.com/services/data/v{version}/sobjects/{ObjectName} for create operations, or https://{instance}.salesforce.com/services/data/v{version}/sobjects/{ObjectName}/{Id} for update operations. Replace {instance} with your Salesforce instance URL, {version} with the API version (e.g., v59.0), {ObjectName} with the object API name, and {Id} with the record ID for updates. For upsert operations, use https://{instance}.salesforce.com/services/data/v{version}/sobjects/{ObjectName}/{ExternalIdField}/{ExternalId}. For complete information about Salesforce API endpoints, see the Salesforce REST API Documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Authentication headers (OAuth 2.0 access tokens) are automatically included from your credentials. However, you may need to include additional headers for specific Salesforce API features. The Content-Type header should be set to application/json for Salesforce API requests.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Salesforce destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Record batching is particularly useful for Salesforce's Composite API, which allows you to execute multiple operations in a single API call. Batching can significantly improve performance when sending large volumes of data to Salesforce. The Salesforce API supports batch sizes up to 200 records for most operations. For complete information about Salesforce batch operations, see the Salesforce Composite API Documentation.

Response Webhook​

Optional

Nexla can automatically send the response received from the Salesforce API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Response webhooks are useful for tracking the success or failure of Salesforce API operations. Salesforce API responses include status information, record IDs for created records, and any errors that occurred during processing. Capturing these responses allows you to monitor data synchronization and handle errors appropriately. For complete information about Salesforce API responses, see the Salesforce REST API Documentation.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Salesforce API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Salesforce API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Salesforce API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to Salesforce, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Salesforce until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.