ConnectWise Automate REST API integration instructions

This article provides instructions on how to integrate ConnectWise Automate into Lifecycle Manager to pull configuration items from ConnectWise Automate.

ConnectWise doesn't expose assets (e.g., VMWare hosts) in the plugin_vm_esxhosts in their REST API.

Prerequisites

The following is required for integrating ConnectWise Automate with Lifecycle Manager:

  • You must have Administrator user credentials for your ConnectWise Automate account

  • You must have Administrator user credentials for your Lifecycle Manager account or member permissions of Manage Sync Settings selected

Optional: To enable Two-Way Synchronization of warranty dates, you must create a custom purchase date and warranty expiration date fields in ConnectWise Automate. See the Create custom fields in ConnectWise Automate for two-way sync article for steps on how to accomplish this.

To successfully integrate ConnectWise Automate with Lifecycle Manager, please follow these steps in each article section:

Integration steps in ConnectWise Automate

Integration steps in Lifecycle Manager

Integration steps in Connectwise Automate

Create a new user class

  1. Open the ConnectWise Automate Control Center application and sign in using your ConnectWise Automate server address and credentials.

  2. Within the ConnectWise menu, navigate to the System menu in the bottom-left corner.

  3. In the System menu, click Users and Contacts User Class Manager.

  4. On the User Class Manager screen, click the + (Add User Class) button to create a new user class.

  5. On the Add User Class screen, enter a unique user class name and click OK.

Add permissions to User Class

Once the User Class is saved, select the newly created User Class to set the permissions. You are required to grant permissions to the user class for full functionality.

  1. On the User Class Manager screen, select the newly created User Class.

  2. Click on the Core menu to enable/disable permission before adding this class to a user.

  3. In the Permissions module, enable the following permission for each:

    1. Clients

      1. Show All - Access permission

    2. Computers

      1. Update - The Update permission must be enabled if you plan on using Two-Way sync.

      2. Show All - Access permission

    3. Contacts

      1. Read permission

    4. Locations

      1. Show All - Access permission

  4. Click Save and close the User Class Manager screen.

Create a Lifecycle Manager user in ConnectWise Automate

  1. Create a new ConnectWise Automate user, dedicated to the Lifecycle Manager integration

  2. If not already signed in to ConnectWise Automate, then sign in.

  3. Within the ConnectWise menu, navigate to the System menu in the bottom-left corner.

  4. From the System menu, click Users and Contacts Users. You can add and manage users in the Users view.

  5. Click the + Add button.

  6. On the Add a New User screen, enter the required information:

    1. Under the General tab, enter the following:

      1. UserName

      2. Password

      3. Confirm Password

      4. Email address

    2. Under the Permissions tab,

      1. Select the user's user class by right-clicking in the User Classes section and selecting the recently created User Class.

    3. Under the Groups and Clients tab, in the Available Groups section.

      1. Select and double-click All Clients to move them to the Member Of section.

  7. Ensure the Integrator checkbox is selected for this newly created user.

  8. Click the Add New button.

Setting location data for clients

To sync location data, you need to add Locations - Read permissions for the Lifecycle Manager class for each client.

Location data is synced by double-clicking on a client & adding Locations-Read permissions. You can copy permissions from a “benchmark” client to all clients to ensure they have the same permissions.

  1. To set up a "benchmark" client, click the Browse menu option

  2. Under the Clients tab, double-click on a client

  3. Click the Permissions tab

  4. Under the Permissions tab,

    1. Add the user class by right-clicking in the User Classes section and selecting the appropriate User Class.

    2. Select the added User Class.

    3. In the Permissions section, select Locations Read permission only.

  5. Click Save and close the screen.

  6. Back under the Clients tab, right-click on the “benchmark” client and click Permissions Clear All Permissions. This clears permissions for all clients but the one selected.

    1. Click the Clear button to confirm the clear all permissions.

  7. Under the Clients tab, right-click on the “benchmark” client and click Permissions Copy Permissions. This copies the permissions from the “benchmark” client to all clients without permissions.

    1. Click the Copy button to copy permissions

All clients now have the same permissions as the benchmark client and location data is available to be synced.

Integration steps in Lifecycle Manager

Add ConnectWise Automate credentials to Lifecycle Manager

  1. From Lifecycle Manager, navigate to Integrations and click the Add integration button.

  2. The Add integration page will open. Select ConnectWise Automate REST.

  3. Enter your Username and Password into the ConnectWise Automate REST add integration page.

  4. Enter your ConnectWise Server Hostname

    1. Your hostname should look something like automate.yourcompany.com

  5. If a multi-factor authorization was set up, enter the MFA Authentication code

  6. Click Save ConnectWise Automate REST Setup.

 

When you click Save ConnectWise Automate REST Setup, Lifecycle Manager performs a full sync. When finished, you should be able to view your hardware assets in your account.

What's next?