Skip to main content
Skip table of contents


To authenticate the connector you will need your application's subdomain and API Key.

Obtaining Your Authentication Credentials

  1. Login or create an account

  2. Select an existing application or create a new one. You must provide a subddomain for your application upon it's creation

  3. From your selected application's dashboard, navigate to Settings > Setup & integrations

  4. You will be redirected to a page where your application's key and subdomain are presented. (Note: This API Key is not to be confused with the API Key used for authentication, the API Key used for authentication will be a 64 character length string)

  5. Using the credentials obtained in step 4, you can now access your Public REST API Key (used for authentication) at the following location:

    So with the example credentials above our URL would be:

  6. Your Public REST API key should be present, if not you can generate a new one

Connector Setup

  1. Locate the connector

    Cyclr Console > Connectors > Connector Library >

  2. From the Edit Connector interface click 'Setup'

  3. Enter your Subdomain, click 'Next'

  4. Enter your API Key (64 character Public REST API key), click 'Next'

The connector is now authenticated and ready to use.


You can configure webhooks so that the completion of specific events triggers the step.

In this example, the creation of a new user triggers the webhook, and you can use the cycle to retrieve that user's details.

Create automation

To configure the a webhook, you need to create an automation within :

  1. From your selected application's dashboard, go to Automations.

  2. From the Automations page, select Create automation.

  3. From the Triggers menu, drag the New user trigger onto the automation builder.

  4. From the Actions menu, drag the Api call action onto the automation builder.

Get the Webhook URL in Cyclr

  1. In the template builder, drag the User Created webhook and Get User By ID method onto the grid.

  2. Select Step setup on the User Created webhook to show the URL.

Configure the automation in

  1. In the automation builder, select the API call module to configure it's settings

  2. Enter the webhook's URL, add the header Content-Type: application/json, and select Save.

  3. From the top-right corner of the automation builder, select Save and exit.

  4. Enter a name for the automation. From the Timing drop-down, select Each time the condition is met, make sure Run this action - enable is activated, and select Save.

Set up the webhook in Cyclr

  1. In the Cyclr template builder, select Field Discovery for the User Created webhook. This activates the field discovery action.

  2. Create a test user in to send to the webhook, to provide the webhook it with a user object to extract fields from.

  3. From the dashboard navigate to Data > People

  4. Select Create user, enter test data and select Save.

![user dot com interface](./images/userdotcom_20.png)
  1. Check for a notification within the Cyclr workflow builder that the fields have been successfully received.

  2. Map the required User ID within the Get User By ID's step setup.

  3. Select Run in the top-left corner of the workflow builder.

When the cycle is active, each time a user is created, the webhook triggers the cycle to retrieve the new user's details.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.