Setup
Connect to your Keap app for OAuth.
To setup your Keap app in Cobalt for OAuth, you will need the following credentials from your Keap Developer account:
- Client ID
- Client Secret
- Scopes
Pre-requisites
- Keap Developer account. You can create one here.
Creating an app in Keap
To create a Keap app and acquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your Keap Developer account.
- Click on the
Username
in the top right and selectApps
button.
- Click on
+ New App
button in the top right. - Enter the App Name for your application, click on
Enable
button under APIs section and click onSave
. - Navigate to API Keys section and copy the
Key
(Client ID) andSecret
(Client Secret).
Configuring credentials in Cobalt
App settings page lets you configure the authentication settings for an OAuth2
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.
Provide the acquired Client ID and Client Secret under Settings of the app 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, the app will now request for access of the mentioned scopes.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using Keap actions and triggers. Following are the set of Keap actions and triggers supported by Cobalt.
Contact
Contact
- Create Contact - Create a new contact in Keap.
- Create Or Update Contact - Create or Update a Contact in Keap.
- Update Contact - Update a contact in Keap.
- Get Contact By Id - Get contact by its ID in Keap.
- Retrieve Contact Model - Get the custom fields and optional properties for the Contact object in Keap.
Note
Note
- Create Note - Create a new note in Keap.
Custom Field
Custom Field
- Create Custom Field - Create a new custom field in Keap.
Opportunity
Opportunity
- Create Opportunity - Create a new opportunity in Keap.
- Update Opportunity - Update an opportunity in Keap.
Tag
Tag
- List Tags - List tags in Keap.
- Create Tag - Create a new tag in Keap.
Others
Others
- HTTP Request - Make HTTP API calls to any Keap documented REST APIs.
- Add Tag To Contact - Add a tag to a contact in Keap.
Contact
Contact
- Create Contact - Create a new contact in Keap.
- Create Or Update Contact - Create or Update a Contact in Keap.
- Update Contact - Update a contact in Keap.
- Get Contact By Id - Get contact by its ID in Keap.
- Retrieve Contact Model - Get the custom fields and optional properties for the Contact object in Keap.
Note
Note
- Create Note - Create a new note in Keap.
Custom Field
Custom Field
- Create Custom Field - Create a new custom field in Keap.
Opportunity
Opportunity
- Create Opportunity - Create a new opportunity in Keap.
- Update Opportunity - Update an opportunity in Keap.
Tag
Tag
- List Tags - List tags in Keap.
- Create Tag - Create a new tag in Keap.
Others
Others
- HTTP Request - Make HTTP API calls to any Keap documented REST APIs.
- Add Tag To Contact - Add a tag to a contact in Keap.
- Contact Created - Triggers when a new contact is created on Keap.
- Opportunity Created - Triggers when a new opportunity is created on Keap.
- Contact Updated - Triggers when a contact is updated on Keap.
- Tag Associated with Contact - Triggers when a tag is associated with a contact on Keap.