Setup
Connect to your FreshBooks app for OAuth.
To setup your FreshBooks app in Cobalt for OAuth, you will need the following credentials from your FreshBooks Developer account:
- Client ID
- Client Secret
- Scopes
Pre-requisites
- FreshBooks Developer account. You can create one here.
Creating an app in FreshBooks
To create a FreshBooks app and aquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your FreshBooks Developer account.
- Click on the
Create New App
button in the top right.
- Go to your
Apps catalog
in Cobalt > Search forFreshbooks
>Settings
>Use your credentials
>Callback Url
> Copy it. - Enter the Application Name, choose Type according to your requirement, paste the Callback Url under Redirect URIs and click on
Save
at the top. - Scroll down in the app after it has been created and copy the Client ID and Client Secret.
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 FreshBooks Developer account and update the scopes as added on Cobalt.
Select the OAuth App created for Cobalt > Scroll down to Scopes
section > Click on + Add Scope
> Select the scopes as added in Cobalt > Click on Save Settings
.
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.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using Freshbooks actions and triggers. Following are the set of Freshbooks actions and triggers supported by Cobalt.