ConnectWise REST Authenticate an Element Instance

Last Modified on 02/01/2019 11:06 am MST

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 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.

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:

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}}