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...
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. You can update an existing Account Connector with this Cyclr API Request where AuthValue is set to the API...
Create an account Page A Cyclr account can contain account connectors and integrations, and typically has a one to one relationship with an account in your application. If an account doesn’t already exist, you can create one. Request POST /v1.0/accounts Authorization: Bearer 0000000000000000000000000000000000000000000000000000000000000000 { "Name": "Test Account 001",...
Activate a cycle 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: Request: <div class="language-http...
Map fields 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. Request: GET /v1.0/steps/{Step ID}/fieldsformapping Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 X-Cyclr-Account: 00000000-0000-0000-0000-000000000000 Response:...
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. Request: GET /v1.0/cycles/{Cycle Id}/prerequisites Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000...
Get list of available templates Page Templates are integrations built by you in the Console’s drag-and-drop builder, they can be installed in your end user’s account. Your app would present a list or library of available templates to your end users. Retrieve a list of all public templates within the Partner console. Request: <div...
HTTP basic authentication Page For connectors that use HTTP Basic authentication. Your user’s username and password will need to be collected by your application then passed to Cyclr as follows: Concatenate the username and password as “username:password”. Base64 encode the concatenated username and password value, giving something this: “dXNlcm5hbWU6cGFzc3dvcmQ=” That string should...
Install a cycle Page A Cycle is an instance of a template you install within an account. Install a template with the Cyclr API Request: POST /v1.0/templates/{Template ID}/install Authorization: Bearer **************************************************************** X-Cyclr-Account: 00000000-0000-0000-0000-000000000000 Response: { "Id":...
Map fields 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: Request: GET /v1.0/steps/{Step ID}/fieldmappings/{Field ID} Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 X-Cyclr-Account: 00000000-0000-0000-0000-000000000000 Response: <span...
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. You’ll need to create an Account Sign-In Token for...
Map parameters 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: Request: GET /v1.0/steps/{Step ID}/parameters/{Parameter ID} Authorization...
Map fields with static values 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: Request: PUT /v1.0/steps/{Step ID}/fieldmappings/{Field...
Set up steps 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. Request: <span...
Cycle introduction Page When you install a template into an account, Cyclr: * Adds the required account connectors with the same releases the template uses. * Creates a cycle that's an exact copy of the template so each step uses the same release as its matching step in the template. ## Connector installation...
Map fields from list of values Page **_Fields within a step may contain a set of pre-defined values that can be selected from, returned in the “Values” array below:_** Request: ````http GET /v1.0/steps/{Step ID}/fieldmappings/{Field ID} Authorization Bearer 0000000000000000000000000000000000000000000000000000000000000000 X-Cyclr-Account: 00000000-0000-0000-0000-000000000000 ```` Response: ````json { "Field": { "Id": 283792, "Name": "Email", "Description": null, "IsOptional": false, "DataType": "Undefined", "TriggerName":...
Edit me