--- title: "External Client Apps" slug: "external-client-apps" tags: ["Admin", "Blue Yonder", "Border Connect", "Comdata Fuel Cards", "EDI REST API", "PubSub", "Trimble"] updated: 2026-10-02T13:56:01Z published: 2026-10-02T13:56:01Z canonical: "documents.revenova.com/external-client-apps" --- > ## Documentation Index > Fetch the complete documentation index at: https://documents.revenova.com/llms.txt > Use this file to discover all available pages before exploring further. # External Client Apps Several Revenova-supported integrations require a Salesforce External Client App to communicate data between the TMS and the integration partner. Create an External Client App for each third-party integration the customer uses. Run the app as the API User. ![Setup page displaying External Client App Manager with two enabled applications listed.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/External Client App Manager.png) For more information, see Salesforce documentation for [External Client Apps](https://help.salesforce.com/s/articleView?id=xcloud.external_client_apps.htm&type=5). ## Integration Partners The following partner integrations require an External Client App to send and receive information with a customer org: - [Blue Yonder](/v1/docs/summary) - [Border Connect](/v1/docs/border-connect) - [Comdata Fuel Cards](/v1/docs/comdata-fuel-cards) - [Highway Carrier Onboarding](/v1/docs/highway-carrier-onboarding-and-monitoring) - [Pub/Sub Accounting](/v1/docs/pubsub-api-accounting-integration) - [Trimble Maps](/v1/docs/trimble-maps) - [RevenovaWebService](/v1/docs/revenova-tms-web-services-guide) Follow the steps in the Set up External Client App Access heading to create a new External Client App. Some integrations require [additional setup](/v1/docs/external-client-apps#blue-yonder-additional-setup) before they can be used. > [!WARNING] > **Note**: If these integration partners were initially created as a Connected App, you can easily migrate the same setup into an External Client App. Follow these Salesfoce instructions for [migrating a Connected App to an External Client App](https://help.salesforce.com/s/articleView?id=xcloud.migrate_connected_app_to_external_client_app.htm&type=5). ### EDI Partner VANs The Revenova TMS uses REST endpoints to allow for EDI Partner VANs to send EDI transactions to each customer org. To successfully receive these EDI transactions, **each** Partner VAN must have an External Client App created. The TMS supports transactions from [Kleinschmidt](/v1/docs/kleinschmidt), [Cleo](/v1/docs/cleo), and a single [Custom EDI](/v1/docs/custom-edi) or other Partner VAN. Multiple connections are supported for a single org, but only with a **single** Custom EDI Partner. Refer to the [REST API Settings](/v1/docs/getting-started-with-edi-transactions#configuration) for more information on getting started with EDI transactions. > [!NOTE] > **Time Zone Note**: The time zone used by the REST API process is the Automated Process User’s time zone. Time zones are first determined based on the time zone specified in the EDI Transaction record. When a time zone is not specified or a location update does not contain a time zone, the time zone of the API User or other context user set for the VAN on the Load is used to determine the time zone. ## Best Practices - Create an External Client App for **each** required integration used in the customer org. - After creating the External Client App, ensure to **Review Controls** to confirm policy and settings are properly configured. - Create **one** API User and apply the appropriate packaged Permission Sets to that user for each required integration. - The RevenovaWebService integration does not include a packaged permission set. Create or add a permission set with the required permissions. - The API User requires a Revenova TMS license. ## API User Create an API User or Users to run the External Client Apps for a customer org. Add only the necessary permission sets for the integrations a customer is using. > [!WARNING] > **Note**: Each EDI Partner VAN requires a unique API User or context user to properly sort and process EDI transactions. Create an API User for **each** External Client App for a Partner VAN integration. All API Users require a Revenova TMS License to access records. ### Create the API User 1. Go to **Setup → Users**, select the **New User** button and create a User with the following values: - **First Name**: API - **Last Name**: User - **Email**: Set to the System Administrator’s email address - **Username**: Automatically generated, change if necessary - **User License**: Salesforce Integration - **Profile**: Minimum Access - API Only Integrations - **Active**: *Checked* 2. Set the remaining required User fields as desired. 3. Select **Save**. 4. Go to **Setup** → **Users**, select the API User. 5. In the Permission Set Assignments section, select the **Edit Assignments** button. 6. Select each permission set for **all** integrations the customer uses. Click the **Add** button to add the permission sets to the **Enabled Permission Sets** column. The following table of permission sets are packaged in the TMS and intended for use with the associated integration. 7. Select **Save.** > [!NOTE] > Copy the API User username for later when creating the External Client App. | Integration | Permission Set | | --- | --- | | Border Connect | Border Connect API User | | Comdata Fuel Cards | Comdata API User | | Highway Carrier Onboarding | Highway API User | | Pub/Sub Accounting | TMS Accounting Integration | | Blue Yonder | TMS Blue Yonder API | | Kleinschmidt, Cleo, and Custom EDI | TMS EDI API | | Trimble Maps | Trimble API User | ![User detail page showing API user information and permission set assignments.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/API User Settings.png) ## Organization ID Setup Several integrations require an 18-character Organization ID, [Consumer Key](/v1/docs/external-client-apps#step-2-access-the-consumer-key-and-consumer-secret), and [Consumer Secret](/v1/docs/external-client-apps#step-2-access-the-consumer-key-and-consumer-secret) to complete setup. Typically, the Consumer Key and Consumer Secret must be sent to Revenova along with the 18-character Organization ID to complete the setup. Some integrations that require the 18-character Organization ID are: - [Trimble Maps](/v1/docs/trimble-maps#setup-external-client-appapi-user) - [Border Connect](/v1/docs/border-connect#setup-external-client-appapi-user) - [Comdata Fuel Cards](/v1/docs/comdata-fuel-cards#setup-external-client-appapi-user) > [!WARNING] > **Note**: The Organization ID is only required for Comdata’s fuel card integration. No other Comdata payment integration supports entering an Organization ID. - [Highway Carrier Onboarding](/v1/docs/highway-carrier-onboarding-and-monitoring#setup-external-client-appapi-user) Refer to the specific integration articles to determine if this information is required before completing the following steps. To retrieve the 18-character Organization ID, complete the following steps: 1. Select the **Setup Menu** (Gear) button → **Developer Console**. 2. Select the **Query Editor** tab. 3. Enter `SELECT Id FROM Organization` into the SOQL query field. 4. Click the **Execute** button. 5. Copy the 18-character Organization ID for later use. ![SQL query execution showing results for 'SELECT Id FROM Organization'.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Get Organization ID from Developer Console.png) ## Set up External Client App Access External Client Apps allow third-party applications to integrate with Salesforce via APIs that use standard protocols to authenticate and authorize them. Create an External Client App for **each** partner integration that requires one. While the API User is used by multiple External Client Apps, a single app does not work for multiple partner integrations. Refer to the Salesforce documentation about [External Client Apps](https://help.salesforce.com/s/articleView?id=xcloud.external_client_apps.htm&type=5) to learn more. Create all required External Client Apps by following these steps. ### Step 1: Create a New External Client App This example uses the Border Connect integration to demonstrate how to create an External Client App. 1. Go to **Setup → App Manager**, and select the **New External Client App** button. > [!WARNING] > **Note**: If there is already an existing External Client App, you can also go to **Setup** → **External Client App Manager** to create a new app. 2. Once the External Client App Manager opens, click the drop-down arrow (caret) under the *Basic Information* section and enter the following fields: 1. **External Client App Name** 2. **Contact Email** > [!NOTE] > The **API Name** field auto-populates while entering the **External Client App Name** field. Additionally, the **Contact Email** field should be set to the System Administrator’s email address. All other fields, such as Contact Phone and Icon URL, can be entered optionally. 1. Click the drop-down (caret) under the *API (Enable OAuth Settings)* section and *check* the box for the **Enable OAuth** field. 2. After the Enable OAuth box is *checked*, the *App Settings* section appears. In the **Callback URL** field, enter [**https://login.salesforce.com**.](https://login.salesforce.com.) 1. In the **OAuth Scopes** field, move the option *Manage user data via APIs (api)* from the **Available** multi-picklist to the **Selected** multi-picklist. 3. In the *Flow Enablement* section, *check* the box for the **Enable Client Credentials Flow** field. 4. In the *Security* section, the **Enable Refresh Token Rotation** field should be *checked* by default. 1. The **Limit Idle Refresh Token Time-to-Live (TTL) to 30 Days** field should also be *checked* by default. 2. *Check* the box for the **Enforce Refresh Token IP Allowlist** field. 5. Click **Create**. ![Configuration settings for External Client App Manager with highlighted security options.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/External Client App - 1.jpg) ### Step 2: Set Client Credentials Flow Run As User 1. Go to **Setup → External Client App Manager**. 2. Select the External Client App to view the details of the app. 3. Select the **Policies** tab and select **Edit**. 4. Open the **OAuth Policies** expander and *check* **Enable Client Credentials Flow**. 5. Enter the **Username** of the API User to set the **Run As** user. 6. Click **Save**. ![Configuration settings for Border Connect app in Salesforce, highlighting OAuth policies and permissions.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Set Client Credentials Flow Run As User.png) ### Step 3: Access the Consumer Key and Consumer Secret To get the Consumer Key and Consumer Secret, complete the following steps: 1. Go to **Setup** → **External Client App Manager**. 2. Select the External Client App to view the details of the app. 3. Select the **Settings** tab and open the **OAuth Settings** expander. 4. Click the **Consumer Key and Secret** button. ![Settings page for Border Connect app with OAuth and basic information sections.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Access Consumer Key and Secret for an External Client App.png) 5. Salesforce sends a verification email to the System Admin’s email address. Enter this code in the **Verify Your Identity** page. 6. Copy the **Consumer Key** and **Consumer Secret** for later use. 7. Select the **Switch to Lightning Experience**. ![Salesforce interface displaying Consumer Key and Consumer Secret fields for Border_Connect app.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Copy Consumer Key and Secret.png) ## Cleo EDI REST Additional Setup Complete the following steps when configuring the External Client App for EDI REST users integrating with the Cleo EDI Partner VAN. Users of the **Cleo onPrem** product must receive their IP Addresses in the implementation stage. Complete the steps below and instead of the IP Addresses shown below, enter those provided by Cleo. For **Cleo CIC** users, follow steps below and enter the values included below. ### **Add Refresh Token IP Allowlist** 1. Go to **Setup → External Client App Manager**. 2. Select the *Cleo EDI* app. 3. Select the **Settings** tab and select **Edit**. 4. Open the **OAuth Settings** section. 5. Scroll to the *Refresh Token IP Allowlist* section. 6. Click the **Add** + button. 7. In the modal, enter the following IP Address values. For single IP values, enter the address into both the **Start IP Address** and **End IP Address** fields. Click **Save** for each value and then click the **Add** + button until all values below are added. 1. 192.245.195.1 (Start IP Address) 2. 192.245.195.3 (End IP Address) > [!NOTE] > If desired and/or multiple IPs are listed, enter an optional description in the Description field. 1. Click **Save**. ## Blue Yonder Additional Setup Complete the following additional steps to finish the Blue Yonder integration setup. ### **Add Trusted IP Range for OAuth Web Server Flow** 1. Go to **Setup → External Client App Manager**. 2. Select the *Blue Yonder* app. 3. Select the **Settings** tab and select **Edit**. 4. Open the **OAuth Settings** section. 5. Scroll to the *Trusted IP Ranges for OAuth Web Server Flow* section. 6. Click the **Add** + button. 7. In the modal, enter the following IP Address values. Enter the address into both the **Start IP Address** and **End IP Address** fields. Click **Save** for each value and then click the **Add** + button until all values below are added. - 20.122.40.48 - 52.177.14.131 - 52.247.78.106 8. Click **Save**. ![Table displaying trusted IP ranges for OAuth web server flow with addresses listed.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Blue Yonder Trusted IP Ranges for OAuth Web Server Flow.png) ### Domain URL The following endpoints are sent to Blue Yonder for setup within their system: - **OAuth authorization endpoint**: https://{domain}/services/oauth2/token - **Quote request endpoint**: https://{domain}/services/apexrest/rtms/blueyonderloadservice - **Tender request endpoint**: https://{domain}/services/apexrest/rtms/blueyondertenderservice Each org must send these endpoints to Blue Yonder to complete setup. > [!NOTE] > **Note**: {domain} can be found under **Setup → My Domain → Current My Domain URL**. ## Pub/Sub Accounting Additional Setup The accounting partner requires the domain for setup within their system. Each org must send its domain to the accounting partner to complete the setup. > [!NOTE] > **Note**: {domain} can be found under **Setup → My Domain → Current My Domain URL**. ![Salesforce My Domain settings page displaying current domain URL and configuration options.](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/Current My Domain URL.png)