The following pages and posts are tagged with

Title Type Excerpt
Connector Introduction Page What is a Cyclr Custom Connector? A custom connector allows you to integrate apps that aren’t in our connector library. You can even add connectors for your own private apps and websites. Our Connector Manager makes this task quicker and easier to maintain than writing a traditional coded integration....
Connector Settings Page Custom Conectors With certain Cyclr price plans, it is possible to create Custom Connectors. These connectors are private to the Partner Organisation that created them. Connector Basics A connector may have various Releases. When you add a new connector only certain basic naming details are entered. The main...
Connector Authentication Page Authentication Types Cyclr supports various authentication types and, sometimes with the addition of scripting, it is possible to establish a connection with any API. Method Description ApiKey  The user should provide an API key as the HTTP header for the connector. ...
Connector Rate Limits Page Rate Limits Cycle allows you to enter any limitations on the frequency with which API calls will be accepted by an applicaiton. These settings can be made for the connector overall and, if required, differnt rates can be set for specific methods. When setting up a connected you can...
Connector Methods Page Settings These are descriptions of the API endpoints in a standard format. Property Description Standards Name  The name of the method to appear in the Cyclr UI for the user to see. Should be short and snappy and have initial caps for...
Connector Parameters Page Purpose Parameters are used to define a range of HTTP fields, e.g. HTTP headers, mergefields, query string parameters, etc. You can define parameters at the connector level or method level. If a parameter is defined at the connector level, it will be global for all methods in the connector....
Connector Triggers Page Triggers Triggers are used for dynamic lookups. For example, if you want to provide a lookup of ‘Acount IDs’ you must have already defined a method in the connector to ‘list accounts’. The trigger will then use the method once the connector is authenticated to allow a look up...
Connector Scripting Page Scripting Cyclr supports Javascript as its scripting language, allowing you to manipulate data before it’s sent as well as after it’s been retrieved. This can be useful when moving data between applications as what’s valid in one, may not be valid in another. Also, sometimes data just doesn’t quite...
Connector Paging Page Inbound and Outbound Paging So that Cyclr can retrieve more objects than a remote API may allow in one request (some restrict this to 100 objects, for example), it can take advantage of an API’s paging functionality. This is referred to as Inbound Paging. Cyclr will repeatedly request pages of...
Auto Installing Webhooks Page Automatically Installing Webhooks via API Calls When an API supports setting up a webhook, this is often the best option to choose, as it allows the user to create webhooks without having to leave Cyclr. This method requires three methods to be created: one will create the webhook...
Dynamic Custom Fields Page Adding Custom Fields Dynamically Cyclr can add custom fields dynamically to an authenticated connector, removing the need to add them manually for each installation. There are two ways to do this: If the API you are accessing has methods for retrieving object metadata, these can be used to...
Edit me