The following pages and posts are tagged with

Title Type Excerpt
Custom 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 also use a custom connector to connect your own private apps and websites. Note: Not all price plans include access to the custom connector builder. If...
Settings Page Custom Connectors 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...
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. ...
Rate limits Page Rate Limits Cyclr allows you to enter any limitations on the frequency with which API calls will be accepted by an application. These settings can be made for the connector overall and, if required, different rates can be set for specific methods. When setting up a connector you can...
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...
Parameters Page Purpose Parameters can be used to define a number of different properties to be used in an HTTP Request or Response, e.g. HTTP headers, mergefields and querystring values. You can define Parameters at the Connector level or Method level. If a Parameter is defined at the Connector level, it...
Triggers Page Triggers Triggers are used for dynamic lookups. For example, if you want to provide a lookup of ‘Account 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...
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...
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...
Automatically install 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...
Enhanced objects Page To enable the copying of a category to be used for custom objects, please follow the steps below: In connector management, find the connector you wish to edit, select the ‘Methods’ tab and find the category you wish to enable custom objects for. Click on the new Edit...
Connector standards Page Cyclr Connector Standards Guide Connector Details Name should not include any version information Version should be same as API version Description should be from the product, google search result will likely give appropriate text Logo should be 400x400 and scale down nicely Connectors should only use 1...
Data types Page The following is a guide to the Data Types available at Request/Response body level, and those available when defining Connector Fields. Request/Response Data Types These data types can be set to define the format of the entire request/response. Data Type Description Unknown...
Last successful run date Page Last Successful Run Date If you have a need for a method that only pulls the latest information, you’re going to want to use Cyclr’s Last Successful Run Date functionality. You may for instance want List New Contacts or List Updated Accounts methods. Where a particular endpoint accepts a...
Edit me