ConnectWise REST Events

On this page

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports polling events for ConnectWise REST. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with ConnectWise REST and create an element instance with polling enabled.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To authenticate an element instance with polling:

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

    {
      "element":{
        "key":"connectwisecrmrest"
      },
      "providerData":{
        "code": "<AUTHORIZATION_GRANT_CODE>"
      },
      "configuration":{
        "oauth.api.key": "<CLIENT_ID>",
        "oauth.api.secret": "<CLIENT_SECRET>",
        "oauth.callback.url": "<CALLBACK_URL>",
        "event.notification.enabled": true,
        "event.notification.callback.url": "http://mycoolapp.com",
        "event.poller.refresh_interval": "<minutes>",
        "event.poller.configuration":{
          "contacts":{
            "url":"/hubs/crm/contacts?where=lastUpdated>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
            "idField":"id",
            "datesConfiguration":{
              "updatedDateField":"_info.lastUpdated",
              "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
              "updatedDateTimezone":"GMT",
              "createdDateField":"_info.lastUpdated",
              "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
              "createdDateTimezone":"GMT"
            }
          }
        }
      },
      "tags":[
        "<Add_Your_Tag>"
      ],
      "name":"<INSTANCE_NAME>"
    }
    
  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 JSON with Polling

instance JSON with polling events enabled:

{
  "element":{
    "key":"connectwisecrmrest"
  },
  "providerData":{
    "code":"1c6ff4089d58d80e86482ab7d5b97f15dd7b041d"
  },
  "configuration":{
    "baseUrl": "https://api-cloudelements/v4_6_release/apis/3.0",
    "company": "cloudelements",
    "public.key": "xxxxxxxx",
    "private.key": "xxxxxxxxxxxxxxxxxx",
    "event.notification.enabled":true,
    "event.notification.callback.url":"http://mycoolapp.com",
    "event.poller.refresh_interval":"15",
    "event.poller.configuration":{
      "contacts":{
        "url":"/hubs/crm/contacts?where=lastUpdated>'${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
        "idField":"id",
        "datesConfiguration":{
          "updatedDateField":"_info.lastUpdated",
          "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
          "updatedDateTimezone":"GMT",
          "createdDateField":"_info.lastUpdated",
          "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
          "createdDateTimezone":"GMT"
        }
      }
    }
  },
  "tags":[
    "Test"
  ],
  "name":"API_Polling"
}

Parameters

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

ParameterDescriptionData 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
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the element instance.
Default: false.
boolean
Event Notification Callback URL
event.notification.callback.url
The URL where you want Cloud Elements to send the events.string
Event poller refresh interval (mins)
event.poller.refresh_interval
A number in minutes to identify how often the poller should check for changes.number
Configure Polling
event.poller.configuration
Optional*. Configuration parameters for polling.JSON object
contactsThe polling event configuration of the contacts resource.JSON object
URL
url
The url to query for updates to the resource.String
ID Field
idField
The field in the resource that is used to uniquely identify it.String
Advanced Filtering
datesConfiguration
Configuration parameters for dates in pollingJSON Object
Updated Date Field
updatedDateField
The field that identifies an updated object.String
Updated Date Format
updatedDateFormat
The date format of the field that identifies an updated object.String
Created Date Field
createdDateField
The field that identifies a created object.String
Created Date Format
createdDateFormat
The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string