The following pages and posts are tagged with

Title Type Excerpt
Authenticate Account Connector Page Your users will be required to provide authentication information before Cycles can be run. Cyclr supports three types of connector authentication: API Key Your user will provide an API Key from the third party application that gives access to the third party API HTTP Basic Your...
API Key Authentication Page For connectors that are authenticated using an API key provided by the 3rd party app. Your user’s API Key will need to be collected in your application and sent to Cyclr like below, this can be done for both unauthenticated and authenticated connectors. PUT /v1.0/account/connectors/{Account Connector ID}...
HTTP Basic Authentication Page For connectors that are authenticated HTTP basic authentication. Your user’s username and password will need to be collected in your application and sent to Cyclr like below Concat the username and password like “username:password” Base64 encode the concated username and password “dXNlcm5hbWU6cGFzc3dvcmQ=”, use this as the value to send to...
Create Account User Page Users exist in Cyclr either to enable your end users to access our user interface directly, or for your app to access a Cyclr account on their behalf via our REST API. A user should be created and given access to the new Account, so that we can generate an...
Create Account Page A Cyclr account contains Account Connectors and Integrations and will typically have a one to one relationship with an account in your application. If an Account does not already exist, one should be created. POST /v1.0/accounts Authorization: Bearer 0000000000000000000000000000000000000000000000000000000000000000 { "Name": "Test Account 001", "Description": "An account we...
Cycle Activation Page When a cycle is installed in an account they are in a Paused state and must be activated to before any step requests will be processed. When a Cycle has been installed and all of it’s prerequisites have been provided, the cycle can be activated like below: <pre...
Field Mapping with Step Data Page A Step Data mapping uses a value from a previous step response as the value for this steps request. Cyclr provides an endpoint to discover valid field mapping options for a given step. GET /v1.0/steps/{Step ID}/fieldsformapping Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 Response: [{ "Id":...
Get Cycle Prerequisites Page A Cycle installed in an Account from a Template may have prerequisites that need to be fulfilled before the Cycle can be activated. The Cyclr API can provide information on the prerequisites for a Cycle to run. GET /v1.0/cycles/{Cycle Id}/prerequisites Authorization Bearer 2890edffcb964e8aab038cf4efc340ab62a4f604bd5a41369654086f5bd25519 Response <div...
List Available Templates Page Templates are integrations built by you in the Console’s drag-and-drop builder, they can be installed in our end user’s account. Your app would present a list or library of available templates to your end users. Retrieve a list of templates available to the Account you wish to install one for....
Install a Template Page A Cycle is an instance of a Template installed within an Account. Install a new Cycle into an Account, based on one of the available Templates. POST templates/{Template ID}/install Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 Response: 200 OK { "Id": "cf636e9c-13dd-47ea-b0e8-88a5bf7f7b00", "CreatedOnUtc": "2017-12-06T16:21:46.0499829Z", "TasksUsed": 0, "ErrorCount":...
Set Step Field Mapping Page Field Mappings are passed to the third party API as the request body. For each Missing field mapping returned in the Step prerequisites request in step 7: GET /v1.0/steps/{Step ID}/fieldmappings/{Field ID} Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 Response: { "Field": { "Id": 283792, "Name": "Email", "Description":...
OAuth Authentication Page For connectors that require your user to be taken through an OAuth flow. Connectors using OAuth require that the user goes through a webflow where they are sent to the third party application to sign in and grant access to Cyclr. This process is simpler than it sounds. First of...
Obtain a Partner Authorization Token Page Before a new user and account can be created in Cyclr, a Console admin user OAuth token must be obtained. Partner OAuth tokens are used to perform operations within the scope of the Partner Console. Request: POST https://yourCyclrInstance/oauth/token Content-Type: application/x-www-form-urlencoded client_id=XXXXXXXXXXXXXXXXXXXX&grant_type=password&username=me@example.com&password=myPassword yourCyclrInstance Your Cyclr...
Obtain an Account Authorization Token Page User Account OAuth tokens are used to perform operations within the scope of an Account. Request: POST https://yourCyclrInstance/oauth/token Content-Type: application/x-www-form-urlencoded client_id=XXXXXXXXXXXXXXXXXXXX&client_secret=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&grant_type=password&username=me@example.com&password=myPassword yourCyclrInstance Your Cyclr instance URL.This could be one of the following: "api.cyclr.com" if your Cyclr account is hosted on our US instance;...
Set Step Parameter Page Step Parameters are passed as a header or part of the URL (hostname, path, or query string parameters) to the third party API endpoint. For each Missing parameter mapping returned by the step prerequisites request in step 7: GET /v1.0/steps/{Step ID}/parameters/{Parameter ID} Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 Response:...
Static Value Field Mapping Page A static value can be set as the field mapping, a static value is a value that will never change. This value should be obtained from your user, or automatically assigned by your application, then provided to Cyclr like below: POST /v1.0/steps/{Step ID}/fieldmappings/{Field ID} Authorization Bearer...
Step Setup Page Templates in Cyclr may include steps that require mapping or parameter values that are specific to your end user’s use of those templates. If the Cycle prerequisites method returned Steps that required mapping, you need to loop through them to determine what is required. GET /steps/{Step ID}/prerequisites...
Value List Mapping Page **_Fields within a step may contain a set of pre-defined values that can be selected from, returned in the “Values” array below:_** GET /v1.0/steps/{Step ID}/fieldmappings/{Field ID} Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 Response: { "Field": { "Id": 283792, "Name": "Email", "Description": null, "IsOptional": false, "DataType": "Undefined", "TriggerName": null, "Values": [ "List Option 1",...
Edit me