ConnectWise REST Authenticate an Element

On this page

You can authenticate with ConnectWise to create your own instance of the ConnectWise REST element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the ConnectWise platform.

Authenticate Through the UI

Use the UI to authenticate with ConnectWise and create an element instance as described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you will need the credentials that you identified in API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated element instance with a token and id.

To authenticate an element instance:

  1. Construct a JSON body as shown below (see Parameters):

    {
      "element": {
        "key": "connectwisecrmrest"
      },
      "configuration": {
        "baseUrl": "https://api-<MYCONNECTWISE.COM>/v4_6_release/apis/3.0",
        "company": "<COMPANY_NAME>",
        "public.key": "<PUBLIC_KEY>",
        "private.key": "<PRIVATE_KEY>"
      },
      "tags": [
        "Docs"
      ],
      "name": "ConnectWise_Instance"
    }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'Authorization: User <INSERT>, Organization <INSERT>'  \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "connectwisecrmrest"
  },
  "configuration": {
    "baseUrl": "https://api-<MYCONNECTWISE.COM>/v4_6_release/apis/3.0",
    "company": "cloudelements",
    "public.key": "xxxxxxxx",
    "private.key": "xxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "ConnectWise_Instance"
}
'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Note: Event related parameters are described in Events.
HeadingHeadingData Type
'key'The element key.
connectwisecrmrest
string
Name
name
The name for the element instance created during authentication.Body
Connectwise URL
baseUrl
The url of your ConnectWise site with api- appended.
Be sure to add your url only to the siteURL section of the entire URL, so the entire value looks like: https://<api-myconnectwise.com>/v4_6_release/apis/3.0.
Where <api-myconnectwise.com> is one of the following:
  • api-eu.myconnectwise.net
  • api-au.myconnectwise.net
  • api-na.myconnectwise.net
  • api-staging.connectwisedev.com
string
Company
company
The company name that you use to log in.string
Public Key
public.key
The Public Key from ConnectWise. See API Provider Setupstring
Private Key
private.key
The Private Key from ConnectWise. See API Provider Setupstring
Filter null values from the response
filter.response.nulls
Optional. Determines if null values in the response JSON should be filtered from the response. Yes or true indicates that Cloud Elements will filter null values.
Default: true
boolean

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 3012,
      "name": "Connectwise CRM REST Beta",
      "key": "connectwisecrmrest",
      "description": "Add a ConnectWise Instance to connect your existing ConnectWise account to the CRM Hub, allowing you to manage contacts, organizations and incidents across multiple Element. You will need your ConnectWise account and ConnectWise information to add an instance.",
      "image": "elements/provider_connectwise.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": false,
      "authentication": {
          "type": "custom"
      },
      "extended": false,
      "hub": "crm",
      "protocolType": "http",
      "parameters": [  ],
      "private": false
    },
    "elementId": 3012,
    "tags": [
      "Docs"
      ],
    "provisionInteractions": [  ],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "configuration": {    },
    "eventsEnabled": false,
    "eventsNotificationCallbackUrl": "false",
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}