The new App Integrations page in Clio Manage lets customers easily discover and add applications to their Clio account, entirely from within the Clio Manage UI. Customers no longer have to leave Clio Manage and search the Clio App Directory site to discover available integrations. Additionally, the App Integrations page allows customers to access the Add to Clio feature, enabling them to easily add integrations from within Clio Manage.
Together, these features make it easier than ever for Clio users to find your app, understand its benefits and features, see how much it costs, and install it in their Clio account.
myFirmData, a Clio third-party integration, as featured on the App Integrations page.
How do Clio users add applications to Clio Manage via the App Integrations page?
When a user clicks the Add to Clio button for an application on the App Integrations page, a new browser window is opened, which will point to the Add to Clio URL of your application. This URL should prompt the user to log into or sign up for your application, if needed, and then perform the OAuth authorization flow needed to connect your application to the user’s Clio account.
For an in-depth guide to supporting the Add to Clio flow, see "Implementing 'Add to Clio'".
A new browser window with your application’s login page appears after clicking the Add to Clio button.
Once the user successfully authorizes your application, the new browser window will close and the user’s App Integrations page will refresh to reflect the integration’s connected state for the user.
How do Clio users access their integrated applications via the App Integrations page?
Once a user has successfully integrated your application with their Clio account, your application will appear under the user’s My Integrations tab within their App Integrations page. From here, the user can open your application or revoke your application’s access to their Clio account as they please.
After integrating with your application, the user can now open your application directly from Clio Manage.
When a user clicks the Open app button, your Application URL will be loaded in a new browser tab. As the user has already been authenticated during the initial process of integrating with your application, the user should be seamlessly redirected. If the user’s login session for your application has expired, your application should redirect them to its login page.
How can I have my app listed on the App Integrations page?
First: your app must either be either listed on the Clio App Directory already, or you’ve been approved to be listed. See “Launching your app in the Clio App Directory” for more information.
You must also ensure your integration supports the Add to Clio authorization flow for users. Refer to our article on Implementing Add to Clio for more information, and reach out to api@clio.com if you have questions.
Once these steps are complete and you've tested Add to Clio, reach out to us at api.partnerships@clio.com to have your app listed in the Clio Manage App Integrations section. Please provide the listing URL and your application name in the email – if you need more information about these, refer to the implementation guide.
Test Cases
When testing your Add to Clio flow, it's important to consider multiple use cases and user flows. Below is an example set of test cases that should be used, at minimum, to test your application's Add to Clio implementation:
Test Case |
Test Steps |
Expected Outcome |
Adding the app from Clio Manage App Integrations app listing page |
1. Check that "Add to Clio" button is shown on the app's App Integrations listing page. |
1. "Add to Clio" is button is displayed |
2. Cick the "Add to Clio" button. |
2. The app's Add to Clio URL should be opened in a new tab |
|
3. If required, authenticate via the app's page |
3. The app should redirect back to Clio's OAuth scopes authorization page |
|
4. Accept the scopes |
4. After Clio redirects the user back to the application, the window is closed. |
|
5. Check that the app is added to the "My Integrations" page in Clio Manage. |
5. The app is shown under "My Integrations". "Open app", "Remove access" and "View access permissions" are shown. |
|
6. Click "Open App" |
6. The app is opened |
|
7. Navigate to the app's App Integrations listing page. |
7. The "Add to Clio" button should be replaced by the "Open App" button. |
|
8. Click "Open App" |
8. The app is opened |
|
9. Confirm that the app has been connected to Clio successfully and behaves as expected |
9. Requests to Clio Manage should be successful |
|
Removing the app from Clio Manage My Integrations page |
1. Locate the app in the list on "My Integrations", choose "Remove access" and confirm the removal in the dialog. |
1. The app should be removed from the list and should no longer be able to communicate with the Clio account. |
Reinstall an app that has been removed |
1. Repeat the steps to add the app using the "Add to Clio" button (TC-1) |
1. The app should be reinstalled successfully if it was previously removed |
These tests will also be run by members of Clio's API teams. Once passed, the listing will be made live on Clio Manage's App Integrations page for customers.