Connectwise Integration - REST API

Avatar
Stephen Spiegel
  • Updated
Follow

Requirements 

  • Available on all Crewhu plans
  • A Connectwise license and permissions to "add" API members
  • Access to edit Crewhu survey settings

Integration Description

The Connectwise REST API has been updated from their older SOAP API.  Crewhu development associated with our Connectwise integration will use only the Rest API starting March 2018.  

New Crewhu Clients 

Follow the instructions below to activate your Connecwise Integration using REST.

Existing Clients 

You will change your "Integration Partner" from Connectwise to Connectwise REST. (Important Note you will need to replace your SOAP Crewhu survey snippets with REST Crewhu survey snippets within Connectwise). Before you change the integration partner and snippets, follow the same instructions below to create a "Public" and "Private" key that will be necessary to activate your Connectwise integration using REST.

4 Steps to activate integration

  1. Create a role ID and set permissions
  2. Create an API member called Crewhu
  3. Generate the public and private keys
  4. Activate integration

 ConnectwiseREST.png

Create a Role ID in Connectwise

  1. Create a role ID in Connectwise for Crewhu REST API.  The role ID will define what permissiions Crewhu will need.

    Go to Systems > Security Role and press "+" button and name role ID "Crewhu"- configure security role called "Crewhu."

    connectwise_role_id.png

  2. Create access to the following Security Role in Companies dropdown:

    Companies > Company Surveys - Add, Edit, Delete and Inquire Level: All

     perm_company.png

  3. Create access to the following Security Role in Service Desk dropdown:

    Project > Project Tickets - Add, Edit, Delete and Inquire Level

    perm_project.png

  4. Create access to the following Security Role in Service Desk dropdown:

    Service Desk > Close Service Tickets - Add, Edit Delete and Inquire Level: All 

    Service Desk > Service Tickets - Add, Edit, Delete and Inquire Level: All

    perm_service.png

  5. Create access to the following Security Role in System dropdown:

    System > API Reports - Inquire Level: All 

    System> Table Setup - Add, Edit, Delete and Inquire Level : All (nothing is required in the customize button)

    perm_sys.png
  6. Click save

Create an API member called  Crewhu

 

  1. In Connectwise, go to System > Members > API Members tab then press “+”.  


  2. Fill in required API Login fields. The fields in bold are mandatory:

Profile:

Member ID = Crewhu

Member Name = Crewhu Bot

Time Zone =  select Connectwise default Time Zone from the drop-down menu

Email = this field is not mandatory, you can leave it blank

 

System:

Role ID = Crewhu - select Crewhu from the drop-down menu

Level = select the top level from the drop-down menu

Name = select the top level from the drop-down menu

Location = select any of the options from the drop-down menu

Default Territory = select any of the options from the drop-down menu

 


Service Defaults:

Default Board = this field is not mandatory, you can leave it blank

Restrict Board Access = this field is not mandatory, you can leave it blank

 

3. Click "Save".


Generate Public and Prvate Keys

  1. System > Members >API Members > Click Crewhu (API Member) > API Keys tab Click "+" > type "Crewhu in description.

    API_Key_Crewhu.png
  2. Click "Save the "Public Key" and "Private key."  (*note: The private key is only available at the time the key is created.  Please save the keys on a text editor to use in next step).

    API_Crewhu_Generate.png

     

 

Activate Integration

  1. Log into your Crewhu account

  2. Go to Settings > Survey

    settings_survey.png

  3. Choose integration partner "Connectwise (REST)" & add the following:

    1. Integrator server
    2. Company Name
    3. Public Key - copy key you just created and paste into Crewhu
    4. Private Key - copy key you just created and paste into Crewhu
      rest_api_in_crewhu.png
  4. Test Integration.  If  click "Save."successful


    test_integration.png


Once your Connectwise REST API is activated you will have access to all features available in your plan that utilizes the Connectwise REST API.