ConnectWise 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 webhook events for ConnectWise. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance. For more information about webhooks at ConnectWise including the currently available webhooks, see their webhooks documentation.

Configure Webhooks Through the UI

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

Configure Webhooks Through API

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

    {
      "element": {
        "key": "connectwisehd"
      },
      "configuration": {
        "helpdesk.connectwise.username": "<INSERT_CONNECTWISE_USERNAME>",
        "helpdesk.connectwise.password": "<INSERT_CONNECTWISE_PASSWORD>",
        "helpdesk.connectwise.server.url": "<INSERT_CONNECTWISE_SERVER_URL>",
        "helpdesk.connectwise.company": "<INSERT_CONNECTWISE_COMPANY>",
        "event.notification.enabled": true,
        "event.notification.callback.url": "<CALLBACK_URL>",
        "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>"
      },
      "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 cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "connectwisehd"
  },
  "configuration": {
    "helpdesk.connectwise.username": "xxxxxxxx",
    "helpdesk.connectwise.password": "xxxxxxxxxxxxxx",
    "helpdesk.connectwise.server.url": "http://api-cloudelements.connectwisedev.com",
    "helpdesk.connectwise.company": "cloudelements",
    "event.notification.enabled": true,
    "event.notification.callback.url": "https://mycoolapp.com/events",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in the 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
Server URL
helpdesk.connectwise.server.url
The url of your ConnectWise site with api- appended.string
Company
company
The company name that you use to log in.string
User Name
public.key
Your ConnectWise user name.string
Password
private.key
Your ConnectWise password.string
WSDL Path
helpdesk.connectwise.wsdl.path
The WSDL path appears in the URL that ConnectWise redirects you to after you log in. For example, in https://my.connectwise.com/v2017_2/ConnectWise.aspx?locale=en_US&session=..., the WSDL path is /v2017_2/apis/2.0/.string
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
Callback Notification Signature Key
event.notification.signature.key
Optional. A user-defined key for added security to show that events have not been tampered with.string
tagsOptional. User-defined tags to further identify the instance.string