Setup
Connect to your HighLevel app for OAuth.
To setup your HighLevel app in Cobalt for OAuth, you will need the following credentials from your HighLevel Marketplace account:
- Client ID
- Client Secret
- Scopes
Pre-requisites
- Highlevel Marketplace account. You can create one here.
Required Settings
- Mandatory Scopes
- oauth.readonly
- oauth.write
Creating an app in HighLevel
To create a HighLevel app and aquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your HighLevel Marketplace account.
- Click on the
My Apps
tab in the top nav bar and click on+ Create App
button.
- Enter the
App Name
, chooseApp Type
as Private, check Agency and Sub-account inDistribution type
, choose White-label underListing Type
and click on Create App. - Go to your
Apps catalog
in Cobalt > Search forHigh Level
>Settings
>Use your credentials
>Callback Url
> Copy it. - Go to
Settings
in the left menu, scroll down to Redirect URLs and paste the copied Callback Url, click on+ Add
and click on theSave
button. - Select the mandatory scopes in the Scopes section, as provided in your Cobalt HighLevel settings page and click on the
Save
button.
- Scroll down to the Client Keys section in
Settings
, click on+ Add
button and give it a Name. Copy the Client ID and Client Secret displayed.Copy the Credentials now as the Client Secret will not be visible again.
Configuring credentials in Cobalt
App settings page lets you configure the authentication settings for an OAuth 2.0
based application. For your customers to provide you authorization to access their data,
they would first need to install your application. This page lets you set up your application credentials.
Cobalt lets you use pre-configured applications to play around. You can do so by selecting Use our credentials
. However, if you wish to use your own application,
select Use your own credentials
. Provide the aquired Client Id and Client secret and save it.
Configuring Scopes
Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes
section.
For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform.
Once the scopes has been added to the application in Cobalt, go to your HighLevel Marketplace account and update the scopes as added on Cobalt.
Select the OAuth App created for Cobalt > Click on Settings
in side menu > Add the scopes as added in Cobalt under Scopes section > Click on Save
.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform. And, the scopes selected here are identical to the ones selected in the platform.
HighLevel Single Webhook URL
To get the User Events through Webhooks in High Level, the OAuth app needs to be submitted for review and published.
If you wish to create an orchestration where a workflow is being triggered when some operation occurs in High Level, you’d need to subscribe to High Level’s Webhook. Cobalt provides a single webhook URL to manage such event triggers for all your customers.
To setup High Level webhook subscription:
- Select High Level from the application list in Cobalt, and select
Settings
. - Copy the
Single Webhook Url
- Go to
My Apps
> Choose your OAuth app >Settings
>Webhooks
. - Subscribe to the events for which you want to configure the Webhooks.
Webhook Events will be disabled in High Level app if the appropriate scopes are not added to the OAuth app.
- Scroll down, paste the
Single Webhook Url
inside the Webhook URL section and click onSave
.
To learn more about how to listen to Webhook Events in HighLevel, refer here.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using High Level actions and triggers. Following are the set of High Level actions and triggers supported by Cobalt.