Create a Developer Application
The first step when building an integration is to create a new Developer Application in the Developer Portal. The information you'll need to provide is as follows:
Field | Required? | Description |
---|---|---|
Name | true | The name of your app. This will appear on the OAuth approval page during user authorization. |
Description | false | A description of your app. This will appear on the OAuth approval page during user authorization. |
Icons | false | The icon will appear on the OAuth approval page during user authorization. If your app uses custom actions, you can provide a Custom Action Icon to appear in dropdown menus within Clio Manage. |
Website URL | true | The URL for your site or app. This will appear on the OAuth approval page during user authorization. |
Support URL | false | A URL to your app's support page. |
Redirect URIs | true | One or more URLs to which the user will be redirected after they complete the OAuth authorization flow. |
Deauthorization Callback URL | false | An optional URL which can receive notifications when a user deauthorizes your application from within Clio. See "Deauthorization Callback" for more information. |
Developer Terms of Service | true | You must accept the Developer Terms of Service to build an integration with Clio. |
App Permissions | true | Select the access permissions your application will need. See the permissions doc for more information. |
If your app operates in multiple Clio regions, you will need a Clio account and Developer Application in each region. See the regions section of the Partner Handbook for more information.
Finding Your App ID
Each Clio Developer Application has an App ID which uniquely identifies the app in Clio Manage. This is not the same value as your App Key mentioned above. When contacting API Support, you should always provide your app ID to enable quicker troubleshooting.
To locate your App's App ID:
- Navigate to the Developer Portal using the Clio Account with which you created your application.
- Locate your application in the list of apps. The App ID is listed in the table.
Note: Application IDs are different for each region of Clio Manage your app is available in. For example, apps created in app.clio.com and eu.app.clio.com have different IDs.