# Salesforce data source configuration

This is a reference guide for system administrators to set up and configure your Salesforce data for access by Orbit Connect.

> [!NOTE]
>
> For end-user documentation in Orbit Connect, see [Salesforce data source](<https://help.apteco.com/en/orbit/connect/data-sources/salesforce/index.md>).

> [!WARNING]
>
> As of the Spring '26 Salesforce release, you can no longer create new Connected Apps. Salesforce has introduced **External Client Apps** (ECAs) as the replacement, offering improved security and packaging. This guide covers the ECA setup process.
>
> Existing Connected Apps are not affected—they continue to work and can still be edited, installed, and deleted. However, Salesforce intends to move toward full end of support for Connected Apps in future releases and recommends starting to transition now.
>
> If you need to migrate an existing Connected App, see [Migrating an existing Connected App](<https://help.salesforce.com/s/articleView?id=xcloud.connected_app_to_external_client_app_migration.htm&amp;type=5>).

## Prerequisites

Administrator access within your Salesforce organisation.

## Finding your domain address

To find your domain address:

1. Select the cog icon in the top-right corner, then select **Service Setup**.

The My Domain page displays your domain address. Always prefix it with `https://`, for example: `https://yourdomainname.my.salesforce.com`

## Checking for an existing external client app

To check whether an ECA already exists:

1. Select the cog icon in the top-right corner, then select **Setup**.
2. Navigate to **Platform Tools** \> **Apps** \> **External Client Apps** \> **External Client App Manager**.
3. Review the list of apps:

   - If an ECA is present, go to [Retrieving your Consumer Key and Consumer Secret](<#retrieving-your-consumer-key-and-consumer-secret>) below.
   - If no ECA is present, go to [Creating an external client app](<#creating-an-external-client-app>) below.

## Creating an external client app

### Create the app

To create a new External Client App:

1. Navigate to **Platform Tools** \> **Apps** \> **App Manager**.
2. Select **New External Client App**.
3. Complete the following fields:

   - **External Client App Name**
   - **API Name**: populated automatically from the app name
   - **Contact Email**
   - **Distribution State**: leave as **Local**
4. Select **Create**.
5. Enter a callback address. Salesforce recommends `https://openidconnect.herokuapp.com/callback`.
6. Add the following OAuth scopes:

   - Manage user data via APIs (`api`)
   - Manage user data via web browsers (`web`)
   - Access unique user identifiers (`openid`)

### Enable client credentials flow

1. In the **Flow Enablement** section, tick **Enable Client Credentials Flow**.
2. Select **OK**.
3. In the **Security** section:

   - Deselect **Require Proof Key for Code Exchange (PKCE) extension for Supported Authorisation Flows**.
   - Leave **Require Secret for the Web Server Flow** and **Require Secret for Refresh Token Flow** selected.
4. Select **Save**.

### Configure OAuth policies

1. Go to the **Policies** tab and select **Edit**.
2. Expand **OAuth Policies**.
3. In the **OAuth Flows and External Client App Enhancements** sub-section:

   - Tick **Enable Client Credentials Flow**.
   - Enter the email address of the user whose access permissions the app will inherit.
4. Select **Save**.

## Retrieving your consumer key and consumer secret

1. Complete the identity verification steps.
2. Use the **Copy** buttons to copy your **Consumer Key** and **Consumer Secret**.

You've now successfully set up and configured Salesforce as a data source. For more information on using it, see the [Salesforce data source user documentation](<https://help.apteco.com/en/orbit/connect/data-sources/salesforce/index.md>).

## Migrating an existing connected app

If you need to migrate an existing Connected App to an External Client App, follow the [Salesforce migration documentation](<https://help.salesforce.com/s/articleView?id=xcloud.migrate_connected_app_to_external_client_app.htm&amp;type=5>).

## Reference

- [Salesforce Help: Create a local external client app](<https://help.salesforce.com/s/articleView?id=xcloud.create_a_local_external_client_app.htm>)