Skip to main content

How to Connect Sweep Through Your Own External Client App

Written by Yahel Gaver

By default, Sweep connects to Salesforce using our own Connected App. If your organization prefers tighter control over the connection, such as owning the credentials, managing your own security settings, or auditing the app independently, you can connect Sweep using your own External Client App (ECA) instead.

This guide walks through creating that app in Salesforce and connecting it in Sweep.

Before you start

Create an External Client App (ECA) in the Salesforce org you plan to connect to Sweep.

Step 1: Create the app in Salesforce

In Salesforce:

  • Setup → External Client Apps → External Client App Manager → New External Client App

Basic Information

Field

What to enter

Notes

External Client App Name

Sweep Integration

Any name works, this is shown on the OAuth consent screen

API Name

Sweep_Integration

Fills in automatically

Contact Email

Your admin email address

Distribution State

Local

API (Enable OAuth Settings)

  • Enable OAuth Settings

App Settings

OAuth Scopes

  • Manage user data via APIs (api)

  • Perform requests at any time (refresh_token, offline_access)

Flow Enablement

  • Leave unchecked

Security

  • Require secret for Web Server Flow

  • Require secret for Refresh Token Flow

  • Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows

  • Enforce Refresh Token IP Allowlist: leave unchecked unless your security policy requires it. Sweep's server egress IP: 52.207.71.182

SAML Settings, Canvas App Settings, Mobile App Settings, Push Notification Settings, Notification Settings

  • Leave unchecked

Click Create.

Step 2: Retrieve the Consumer Key and Secret

  • On the app detail page, open the Settings tab.

  • Scroll down and click OAuth Settings --> Consumer Key and Secret

  • Salesforce opens a new tab and asks you to verify your identity with a code emailed to your user's address.

  • Copy both values somewhere safe for the next step: the Consumer Key becomes your Client ID in Sweep, and the Consumer Secret becomes your Client Secret.

Step 3: Open Connect Environment in Sweep

  • Go to Environments

  • Click Connect / Add environment

  • Choose Salesforce

Step 4: Choose your environment type and enable your own ECA

Pick one:

  • Production

  • Sandbox

  • Development
    ​

  • Check Use my own External Client App

  • Paste in:

    • Client ID (Consumer Key)

    • Client Secret (Consumer Secret)

Step 5: Complete the Salesforce OAuth flow

  • Click Connect

  • Sweep will open the Salesforce OAuth window using your app instead of Sweep's default app

  • Log in to the correct Salesforce org and approve access

  • Wait for the window to close. Your environment will then show as connected.


Need help? If your connection fails partway through, double check that your callback URL is exactly https://app.sweep.io/salesforce-oauth2-redirect, and that your OAuth scopes include both api and refresh_token.

Did this answer your question?