Events

Cloud Elements supports events via polling or webhooks depending on the API provider. If you would like to see more information on our Events framework, please see the Event Management Guide.

Supported Events and Resources

Cloud Elements supports webhook events for ConnectWise CRM. For more information about webhooks at ConnectWise CRM including the currently available webhooks, see ConnectWise CRM's webhooks documentation.

Webhooks

You can configure webhooks through the UI or in the JSON body of the /instances API request .

Configure Webhooks Through the UI

For more information about each field described here, see Parameters.

To authenticate an element instance with webhooks:

1. Complete the [authentication steps(authenticate.html#authenticate-through-the-ui)] up to entering the Shopify URL.
2. To enable hash verification in the headers of event callbacks, click Show Optional Fields, and then add a key to Callback Notification Signature Key.
3. Enable events: Switch Events Enabled on.
4. Add an Event Notification Callback URL.
5. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
6. Click Create Instance.
7. Provide your ConnectWise CRM credentials, and then allow the connection.

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 resource, or use it in a formula template.

Configure Webhooks Through API

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

To authenticate an element instance with webhooks:

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

   {
     "element": {
       "key": "connectwisecrm"
     },
     "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. See the Overview for details.

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": "connectwisecrm"
  },
  "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.