Authentication

To authenticate the User.com 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:

   https://Subdomain.user.com/api/ApplicationKey/credentials/

   So with the example credentials above our URL would be: https://example.user.com/api/ABC123/credentials/

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

   

Connector Setup

1. Locate the User.com connector

   Cyclr Console > Connectors > Connector Library > User.com

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.

Webhooks

You have the ability to configure webhooks, triggered upon the completion of specified events.

In this example we will configure a webhook that is triggered upon the creation of a new user. We will then retrieve that user’s details.

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

   

2. From the Automations page, Create automation

   

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

   

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

   

   

5. Now back within Cyclr, drag the User Created webhook and Get User By ID method onto the workflow builder

   

   

6. Click ‘Step setup’ (the cog icon) for the User Created webhook. This will expose it’s URL

   

7. Now back within the User.com automation builder, click the API call module to configure it’s settings

8. Enter the webhook’s URL and add the header Content-Type: application/json. Click ‘Save’

   

9. From the top-right corner of the automation builder, click ‘Save and exit’

   

10. 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 click ‘Save’

    

11. Back in Cyclr’s workflow builder, select ‘Field Discovery’ for the User Created webhook. This will activate the field discovery action

    

    

12. We need to create a test user which will be sent to the webhook, providing it with a user object to extract the fields from

13. From the User.com dashboard navigate to Data > People

    

14. Click ‘Create user’, enter some dummy data and click ‘Save’

    

15. You should receive a notification within the Cyclr workflow builder that the fields have been successfully received

    

16. You can now map the required User ID within Get User By ID’s step setup.

    

17. Now that the workflow has been configured click ‘Run’ in the top-left corner of the workflow buider

The workflow is now active. Each time a user is created, the webhook will be triggered and the new user’s details will be retrieved.

Tags: connector

Edit me