HighLevel

Introduction

This guide explains how to set up HighLevel for use with Cyclr, as well as how to obtain authentication details and install a HighLevel Connector.

Setup & Authentication

Overview

Cyclr Partner setup:

• Create an App in your HighLevel account.

• Store your Client ID and Secret in your Cyclr Partner Console.

Remote Setup in HighLevel - performed by Cyclr Partner

Navigate to the HighLevel Marketplace login and log in with your HighLevel developer credentials.

If you have not yet signed up as a developer, you can do so at the above link.

Once logged in you should select “Create App” and provide the required values:

• Select a Distribution Type of “Sub-Account” as the HighLevel Connector works at the Sub-Account level.

Please see the HighLevel documentation to understand more about App Types and Distribution Types.

Once created you should be redirected to the App’s configuration page, here you can choose to provide additional elements for your app such as company details, logo, etc.

To configure the authentication, you will need to select Advanced Settings and then select Auth:

You will be presented with the authentication configuration.

You will need to provide a list of scopes that your app will request from authenticated users. For a full list of scopes see the HighLevel Documentation.

Make a note of the scopes you set as these will need to be entered into the Connector.

We recommend adding the following Scopes to use all of the Methods in the Contacts category of the HighLevel Connector:

contacts.readonly contacts.write locations/customFields.readonly

In the Redirect URL field enter the Callback URL of your Cyclr Partner Console and select Add
The URL is in this format: https://{Your Cyclr Service Domain}/connector/callback

Next, you will need to select to add a client key.

Once you have provided a name for the key, a popup window will be displayed showing your client ID and client secret.

Make a note of these as the client secret will only be shown one and both details will be required when setting up the Connector.

Select Save at the bottom of the page to activate your HighLevel app.

Partner Setup in Cyclr Console

Having created a Marketplace App within HighLevel, navigate to your Cyclr Partner Console:

1. Go to Connectors > Application Connector Library.

2. Use the search box to locate the HighLevel Connector entry.

3. Select the Pencil button.

4. Select the Settings tab.

5. Enter the below values:

6. Select Save Changes.

If you leave these values blank, they must be provided each time the Connector is installed.

Cyclr Connector Installation

When installing the HighLevel Connector, it is recommended that the user authenticating is already signed in to HighLevel, to make the process smoother.

If the user is not signed in, they’ll see the following message:

Selecting the Login button takes the user to a page to sign in, and then redirects to their HighLevel dashboard within the popup, without completing authentication of the Cyclr Connector.

To continue, the user should close the window and begin the Cyclr process again to have HighLevel recognize the user as having an active session and take them on through the process.

The user should then see a list of Sub-Accounts (sometimes referred to as “Locations”) to choose from:

For the HighLevel Connector to function, a Sub-Account must be selected, not an Agency.

You should only see a list of Sub-Accounts as your HighLevel app’s “Distribution Type” setting should have been set to only “Sub-Account”, and not “Agency”.

After selecting a Sub-Account, the popup will close and the HighLevel Connector should then be authenticated and ready for use.