Skip to main content

​
Prerequisites

Before you can add the connection, you must gather the following from your Collaboflow account.
1
Log in to Collaboflow as an administrator.
2
Open the System Management Area > App Management and note the App Cd (app code) of the workflow application you want to connect to.
3
Note your Instance, which is the instance name in your Collaboflow API URL. The URL format is https://cloud.collaboflow.com/{instance}/api/index.cfm, so the Instance is the segment between the domain and /api/index.cfm (for example, mycompany in https://cloud.collaboflow.com/mycompany/api/index.cfm).

​
Setup Guide

Follow these steps to connect Collaboflow to your Connect AI account:
1
Open the Sources page of the Connect AI navigation menu.
2
Click + Add Connection in the upper-right corner.
3
Type Collaboflow into the search field, then click the data source name.
4
On the Basic Settings tab of the new connection, enter a connection name or keep the default name.
5
Enter the App Cd obtained from Collaboflow.
6
Enter the Instance, which is the instance portion of your Collaboflow URL.
7
Enter the URL of the Collaboflow API endpoint, in the format https://cloud.collaboflow.com/{instance}/api/index.cfm (for example, https://cloud.collaboflow.com/mycompany/api/index.cfm).
8
Select the Auth Scheme, then proceed to the relevant section and follow those instructions.

​
Authentication Methods

To use API Key authentication, you must generate an API key from your Collaboflow administrator account:
1
Open the System Management Area > Environment Settings.
2
Scroll to the REST API section. Enter a client name, select HTTP Header Authentication, then click + Issue API Key. Copy the API Key and store it securely.
In Connect AI:
1
Enter the API Key generated from your Collaboflow admin account.
2
Enter the User, which is the Collaboflow username used to authenticate.
3
At the top of the Connect AI Add Connection page, click Save & Test.
  • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.
  • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.
  • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.