The following pages and posts are tagged with

Title Type Excerpt
Custom Connector Examples Page Example 1: standard connector The below JSON is taken from a MailChimp connector. {   "Name": "MailChimp",   "Description": "This connector provides basic functionalities for connecting to MailChimp.",   "Version": "v3",   "AuthType": "OAuth2",   "OAuth2Type": "AuthorisationCode",   "Methods": [     {      ...
Custom Connector Fields Page Field Properties ConnectorField – the name of the field as used by the remote application’s API. Use Cyclr notation to locate the value, e.g. [records].EmailAddress when receiving an array and retrieving the EmailAddress _attribute from an element within that array (see _RequestFormat / ResponseFormat documentation). SystemField – the name to use internally within Cyclr. Use the...
Custom Connector Introduction Page What is a 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. A...
Custom Connector Methods Page 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 nouns/verbs, lowercase for minor words (like “a” or “to”), e.g. “Delete Emails”, “Get All Contacts”, “Send to List”. Description – this is the...
OpenAPI Page Introduction In this guide, you will learn how to create your own custom connectors in Cyclr. Importing an API Our powerful OpenAPI discovery tool lets you import your existing API specification into Cyclr. After signing into the Console, select Connectors > My Connectors > Generate From OpenAPI Specification. <img...
Custom Connectors 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...
Custom Connectors Parameters and Triggers Page Overview You can make connectors more usable by using parameters and triggers. Examples include: An add contact to list step can show available lists in a drop down A get contacts step can be made into a get updates contacts step Parameters Parameters are used to...
Custom Connector Properties Page Name Provides a name for the connector to be shown in the Cyclr UI. CreatedOnUtc The date and time when the Connector file was created (in GMT timezone). Will be used to identify when a Connector should be updated in Cyclr. Format: “2015-12-14T11:20:00.000Z”. Leave the seconds and milliseconds...
Custom Connector Reference Page A connector is a JSON formatted text file made up of the following parts. Authentication – how the connector should connect to the target API (e.g. OAuth, API key, login, etc). Properties – the description, version, icon, etc. Methods – the endpoints for the API. Fields – the fields used in the methods....
Custom Connector Scripting Page Events Events are triggered at certain points allowing you to modify data. Script can be added at both the Connector & Method levels; Connector level event handlers will be called for all methods where as method level will only be called for that method. To add an event handler...
Edit me