Cyclr Connector Guides give details on how to setup and install Connectors.
Go to Connector Guides homepage
Some Connectors may require external setup outside of Cyclr such as obtaining credentials, generating an API Key, or creating an OAuth app, which is explained in the Connector Guides.
There may also be further action to take or values to provide when installing and authenticating a Connector within Cyclr.
To view the Connector Guide for a specific Connector, you can open the Settings page for the Connector and select the Setup Guide button, or you can search in the Connector Guides section of the documentation.
Requirements #
In order to connect with a third party application, you may need a specific type of account within that application, or may need to adjust your settings and permissions. The Connector Guide for that specific Connector should specify what’s required.
Console-level Setup #
Some details around authentication and setup can be provided at the Cyclr Console level.
If a system uses particular types of OAuth to authenticate, details such as the Client ID and Client Secret can be stored in your Cyclr Console for that Connector so that whenever it’s installed, Cyclr will use those details as part of the authentication process. This allows you to create a single OAuth app which will always be used as the “tube” by that type of Connector when Cyclr accesses any of your customers’ data.
Alternatively, you can decide to leave the Console-level values blank, in which case every time a Connector of that type is installed, Cyclr will request those values from the user installing it. This gives you the option to have each customer create their own OAuth app and to then provide their own Client Id and Client Secret values.
Typically with OAuth Authorization flows, the Client ID and Client Secret values only indicate to the external system which “app” is accessing them and additional authentication/consent is required from the end-user when actually installing the Connector to allow that “app” to access their data.
Account-level Setup #
Some Connectors don’t have the option for any Console-level values to be provided, or might have more fields available when the Connector is being installed.
