Skip to main content
Skip table of contents

Salesforce: Integration Step By Step Instructions

SalesForce Integration Setup

This is an outline of the steps required to enable the integration between Engage and Salesforce.  The integration process is usually completed by a member of the Proteus team being put in touch with someone in your organization who has a Salesforce Administrator user account. Then the connection can either be completed together on a call or via e-mail.

Items to Consider

  1. The Engage Salesforce integration is only available for Salesforce instances that have API access. Here are two articles from Salesforce to help you know which editions have API access and how to know which edition your organization has.
  2. Does the Salesforce Org have Lightning Experience enabled?  These steps assume so; otherwise, the integration will be done differently (no custom component in Salesforce). Please contact directly.
  3. When Engage uses the Salesforce API, it will be operating as the SalesForce user account that was used to authorize ProteusEngage as a “Connected App”.  The user that completes the /admin/sfa-setup setup is the relevant user.  
  4. There are separate instructions for setting up SAML SSO using Salesforce as the identity provider here.

One Day Before the Call (or earlier)

  1. The ProteusEngage Lightning Web Components requires the Salesforce organization to be configured with a custom domain.  The custom domain setup process takes time to complete. (Up to 12 hours.) It is a two-step process:


During Call

  1. (If applicable) Install the ProteusEngage Salesforce Package that includes our LWC component to provide the "Add Workspace" and "View Workspace" buttons. User with Salesforce admin access clicks this link: 
    1. Production Org:  (version 1.2)
    2. Sandbox Org:  (version 1.2)
  2. (If applicable) Install the ProteusEngage Salesforce Package that includes our LWC components to embed the Workspace UIs in Salesforce. (Note: If upgrading to 1.1 from 1.0 to get additional components, please update the Canvas app url to   A user with Salesforce admin access can click the link:  

    1. Production Org:  (version 1.1)
    2. Sandbox Org:  (version 1.1)
  3. Create a Connected App 
    1. Click on App Manager
    2. Click Create a New Connected App (see Screenshot 1)
    3. Enter ProteusEngage as the app name and API name (see Screenshot 1)
    4. Enter for the Connected email (see Screenshot 1)
    5. Check Enable OAuth Settings checkbox in API (Enable OAuth Settings) area
    6. Fill in the Callback URL using Customer’s URL:
      1. Note: If connecting to the Engage Stage environment then use this instead:  

  4. Under the API section mark Access and Manage your data and Perform Requests on your behalf at any time (see below) 
    • Note: Salesforce could change the verbiage of the OAuth Scopes. The latest update verbiage for these two options are "Perform requests at any time (refresh_token, offline_access)" and "Manage user data via APIs (api)".

  5. If using the embedded file management component:
    1. Select the checkbox "Canvas"
    2. Enter the Canvas URL:  (or 
    4. Add "Lightning Component" under Locations
  6. Copy the consumer key and secret key into a Word or text document to be used later
    1. Press save
  7. (If using the embedded file management component)  After saving the connected app, navigate to 

    "Manage Connected Apps :: Edit Engage App"  and set “Permitted Users” so that admin can preauthorize users.

  8. Look up the SalesForce Organization ID under “Company Information” in SalesForce Setup. Save this out to the same document as the Consumer Key and Secret Key (see below for location of ID)

  9. Configure a CSP Trusted Site for *
    1. Go to Salesforce Setup
    2. Search for CSP and click on CSP Trusted Sites
    3. Select New Trusted Site (near the middle of the page above “Created By”)
    4. Name the trusted site ProteusEngage
    5. Enter the URL for the trusted site: *  (or * if connecting to the Engage staging environment)
    6. Click Save

  10. In Salesforce, configure the ProteusEngage component onto an Opportunity Detail Page (following these steps but on the Account Detail Page if workspaces are created from SF accounts)
    1. Open an Opportunity Detail Page
    2. Click on the gear icon towards the top of the page to go to Edit Page
    3. Look for the Custom Component named ProteusEngage towards the bottom of the left-hand side, under components (if it does not show up, click Deploy My Domain and then click “Deploy to Users” and repeat steps 2a and 2b)
    4. Drag that button to the desired location on the page
    5. Select it and on the right-hand side paste in the SalesForce Org ID copied previously
    6. Change the ProteusEngage URL to (or if connecting to Engage Staging environment)
    7. Click Assign as Org Default after pop up and choose both Desktop and Phone
    8. Click Save and then click the back button

  11. (If using the embedded file management component) Also add the ProteusEngageWorkspaceFiles to a the same page you created above
  12. In Salesforce, configure which users are allowed to access the ProteusEngage Connected App.  This is normally done via "Profiles" or "Permission Sets" and you can manage the settings in the "Manage Connected App" screen.   The user who does the connection in the next step as well as any users of the "Engage Workspace Files" component will need to have access to the app.
  13. In Engage, configure the Connected App via  (or for Engage staging environment)
    1. Fill in the Salesforce Organization Name as whatever you prefer
    2. Paste the saved consumer key, secret key, and SalesForce Organization ID into the Engage Initial Setup UI page

  14. It can take 10-15 minutes after the app is created above before the Connected App is ready to use in Salesforce, but should be ready by now.

  15. (Optional) Test the link between Engage and Salesforce by using (creating if necessary) a testing Opportunity in Salesforce and using the SalesForce component to create a Workspace for it in Engage.

  16. Discuss the process for linking existing Workspaces to Salesforce Opportunities.

  17. Discuss how the Workspace statuses should work with respect to Opportunity Stages (if applicable). 

Things to consider

If the integration is carried out between an Engage non-production environment, such as Engage Stage, and a Salesforce non-production environment, such as Salesforce sandbox, please keep in mind some of the limitations, not exhausting list:

  • The Engage URLs provided above are to Engage production environment. Engage Client Success Manager must consult with the engineering team on which Engage testing environment can be used.
  • Engage non-production environment might not be turned on 24/7.  Engage Client Success Manager must consult with the engineering team to leave it turn on during the testing duration.
  • A disconnection between Salesforce sandbox and Engage Stage happens for known (refresh token expired, connected user account disabled, etc) or unknown reasons. You will notice that no activities are sent from Engage to Salesforce nor new workspaces/contacts can be created in Engage from Salesforce. When this happens, two things must be done for reconnection:
    1. disconnect the Salesforce sandbox to the Engage testing site (Engage Client Success Manager must consult with the engineering team to disconnect the Salesforce sandbox).
    2. reconfigure the Connected App on Engage testing site again – repeating the above step 10

Questions? Please click the "HELP?" button in the upper right corner of your Engage screen or contact support.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.