Skip to main content

How to Connect Your Salesforce Org to Sweep

Connect Salesforce to Sweep using your own External Client App, with an optional dedicated integration user.

Written by Yahel Gaver

This guide shows you how to connect your Salesforce org to Sweep using your own External Client App (ECA). It has three parts:

  1. Create your External Client App in Salesforce

  2. Create a dedicated integration user (optional, see below)

  3. Connect Sweep using that app, so the scan can start

Part 1: Create your External Client App

Step 1: Create the app

  1. In Setup, type External Client App Manager in Quick Find and open it.

  2. Click New External Client App.

Basic Information

Field

What to enter

Notes

External Client App Name

Sweep Integration

Any name works. It's shown on the login approval screen.

API Name

Sweep_Integration

Fills in automatically

Contact Email

Your admin email

Distribution State

Local

API (Enable OAuth Settings)

Check Enable OAuth, then set:

Setting

What to do

Callback URL

https://app.sweep.io/salesforce-oauth2-redirect

OAuth Scopes

Add both:
• Manage user data via APIs (api)
• Perform requests at any time (refresh_token, offline_access)

Flow Enablement

Leave everything unchecked

Security

Check:
• Require secret for Web Server Flow
• Require secret for Refresh Token Flow
• Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows
Leave Enforce Refresh Token IP Allowlist unchecked unless your security policy requires it. If it does, allow Sweep's IP: 52.207.71.182

SAML, Canvas, Mobile, Push Notification and Notification settings

Leave unchecked

Click Create.

Step 2: Copy the Consumer Key and Secret

  1. On the app's detail page, open the Settings tab.

  2. Scroll to OAuth Settings and click Consumer Key and Secret.

  3. Salesforce opens a new tab and emails you a verification code. Enter it.

  4. Copy both values somewhere safe:

    • Consumer Key → this is your Client ID in Sweep

    • Consumer Secret → this is your Client Secret in Sweep

Part 2: Create a dedicated integration user (optional)

Which user should connect Sweep? The Salesforce user that connects Sweep through your External Client App needs at least the permissions listed in Step 8. You can either:

  • Use a System Administrator. Admins already have these permissions, so you can skip Part 2.

  • Create a dedicated integration user. If your organization prefers a user with only the minimum permissions, follow Part 2 to create one from scratch.

Before you start this part, make sure you have:

  • One free Salesforce Integration user license. Check in Setup → Company Information → User Licenses. Enterprise, Unlimited and Performance editions include 5 at no cost.

  • An email inbox you can access for the integration user. You'll need it to set the user's password and receive verification codes.

Step 3: Create an integration profile

  1. In Salesforce Setup, type Profiles in Quick Find and click Profiles.

  2. Click New Profile.

  3. For Existing Profile, select Minimum Access - API Only Integrations.

  4. For Profile Name, enter Sweep Integration Profile.

  5. Click Save.

The user license (Salesforce Integration) is set automatically by the profile you cloned. You don't need to pick it here.

Step 4: Confirm API access is enabled

  1. On the new profile, click Edit.

  2. Under Administrative Permissions, make sure API Enabled is checked.

  3. Click Save.

Step 5: Add or create the integration user

  1. In Setup, go to Users → Users and click New User.

  2. User License: Salesforce Integration

  3. Profile: The profile you created above

  4. Click Save.

Step 6: Assign the permission set licenses

  1. On the integration user's detail page, scroll to Permission Set License Assignments and click Edit Assignments.

  2. Check Salesforce API Integration.

  3. Only if Salesforce CPQ is installed, also check Salesforce CPQ License and Salesforce CPQ AA License.

  4. Click Save.

Step 7: Create a permission set for Sweep

  1. In Setup, type Permission Sets in Quick Find and click Permission Sets.

  2. Click New.

  3. For Label, enter Sweep Integration Permissions.

  4. Leave License set to --None--.

  5. Click Save.

Step 8: Add the required permissions

These permissions let Sweep read your org's full configuration and data model so the scan is complete. In the permission set, open System Permissions, click Edit, check each permission below, and click Save. Then open App Permissions and do the same.

Section

Permission to check

System Permissions

• Modify Metadata Through Metadata API Functions
• View Roles and Role Hierarchy
• View Setup and Configuration
• Customize Application
• Manage Custom Permissions
• Manage Profiles and Permission Sets
• Approve Uninstalled Connected Apps
• Manage Sharing
• View All Data (automatically adds View Event Log Files, View Dashboards in Public Folders, View Reports in Public Folders)
• Manage Reports in Public Folders (automatically adds View Reports in Public Folders, Create Report Folders, Edit My Reports)

App Permissions

• Manage Flow

Step 9: Assign the permission set to the integration user

  1. On the Sweep Integration Permissions permission set, click Manage Assignments.

  2. Click Add Assignment.

  3. Select the Sweep Integration user, click Next, then click Assign.

Part 3: Connect Sweep

Step 10: Add the environment in Sweep

  1. Log in to Sweep and go to Environments.

  2. Click Connect New and choose Salesforce.

  3. Choose the environment type: Production, Sandbox or Development.

  4. Check Use my own External Client App.

  5. Paste the Client ID (Consumer Key) and Client Secret (Consumer Secret) from Step 2.

Step 11: Log in and approve access

  1. Click Connect. A Salesforce login window opens.

  2. Log in with the integration user's username and password (or your own admin login, if you skipped Part 2).

  3. If Salesforce asks for a verification code, check the integration user's email inbox.

  4. Click Allow to approve access.

  5. Wait for the window to close. Your environment now shows as Connected, and Sweep starts scanning your org.

Did this answer your question?