General settings
Option | Documentation |
|---|---|
Application Icon | Your application icon. Displayed in the navigation bar if Cyclr is used as a white-labelled service. 40x40 pixel PNG image with a transparent background. |
Sign In Logo | Logo to use on the User Login Page. PNG image, suggested dimensions of 300x100 pixels. |
Fav Icon | Web browser “favicon” to use in Cyclr. |
Application Display Name | Display name for your application. |
Cycle Noun | Noun for calling cycles in the UI. Default to “Cycle”. |
Cycle Create Verb (Launch) | Verb for creating cycles in LAUNCH and Marketplace. Default to “Create”. |
Service Domain | This is the unique domain that your Console is hosted at. More information can be found in this section. |
Enable Anonymous Accounts | Allows end users to open cycle and connector seeds links without having a Cyclr account. |
Enable Beta/Planned Connectors | Allows beta and planned (coming soon) connectors to be displayed in the connector list. |
Enable Custom Connectors | Allows end user accounts to create their own custom connectors. |
Enable Cycle Sharing | Allows you to copy a cycle from an account as a template that you can use for multiple end user accounts. |
Enable Notification Emails | To enable notification emails please message our support team. |
Enable Notification Webhook | Makes an HTTP call when there is an issue with an account’s cycles. |
Notification Webhook URL | URL to use when Cyclr sends notifications for cycle issues. |
Enable Transaction Error Webhook | Makes an HTTP call when an error occurs in a transaction. Read more on handling errors. |
Enable User Login Page | Allows end users - your customers - to log in to Cyclr if you choose to give them direct access to their Accounts. |
Enable Cycle Form View | Sets the default cycle setup to be a linear form. The drag and drop builder can be toggled by going to the Advanced view. |
Enable iframe Embedding | Allows Cyclr to be embedded in an iframe. This will remove the X-Frame-Options header and set “SameSite=None; Secure” to all cookies. Your hosting webpage must be served over HTTPS. Note: that this will reduce the visible options in the Settings menu presented within Accounts. |
Help Link Type | Determines how to show Cyclr help links; show Cyclr help links, hide Cyclr help Links or use custom help links. Default to “Show Cyclr help links”. |
Custom Help Link URL | URL to use for all help links when Help Link Type is set to “Use custom help links”. |
Custom Help Email Address | Email address to use for all helpdesk mailto links when Help Link Type is set to “Use custom help links”. |
Host Source Whitelist | A comma separated list of host sources that can embed your Cyclr application using iframe. This value will be present in the Content-Security-Policy (CSP) header. |
Account Concurrent Transaction Limit | Maximum concurrent transactions allowed for an end user account. |
Service Domain
Each Cyclr Partner Console has a unique host name called the “Service Domain”.
The “default” Service Domain is typically: {YourCompany}-h.cyclr.com.
To view your Service Domain, go to your Console then Settings > General Settings.
Where is the Service Domain used?
Your Service Domain appears in the Callback URL (also known as a “Redirect URL”) of your Console and is often required when creating an OAuth App in a third-party system.
Your Service Domain is also used in any Cyclr webhook URLs.
For information on how to use a custom domain, see the custom Service Domains documentation.
Some API providers, such as Google, require you to verify you control the domain used by a Callback/Redirect URL in an app.
When using Connectors that use those APIs (e.g. Google Sheets and Google Calendar), you must therefore set up a custom Service Domain to a domain you have DNS control over.
Callback URL
This is a URL Cyclr listens on as part of installing a Connector that works against an API using OAuth authentication.
Some systems may refer to this as a “redirect URL”.
It uses the Cyclr Partner Console’s unique Service Domain.
You can see your Callback URL by going to your Console then Connectors > Application Connector Library and viewing any Connector entry with a Padlock button.
One example of this is the Google Sheets Connector:
