Help Scout Events

Cloud Elements currently supports events via polling or webhooks depending on the endpoint.

  • Polling is a mechanism where Cloud Elements executes the configured query every n minutes and captures the changed information.
  • Webhooks are when the provider lets Cloud Elements know what information has changed. Note that additional endpoint setup may be required prior to creating your Element Instance.
Note: Cloud Elements normalizes only the objectId, objectType, and eventType event data. Event data also contains raw data, which the provider returns. The raw data varies based on the endpoint.

If you would like to see more information on our Events framework, please see the Events Overview.

Cloud Elements supports webhook events for Help Scout.

Follow these steps to setup webhooks.

  1. Log in to your Help Scout dashboard and select 'Apps' Help Scout Webhooks step 1

  2. Select Webhooks Help Scout Webhooks step 1

  3. Click 'Install App'

  4. Complete form

  5. Click 'Save' Help Scout Webhooks step 1

For more information on Help Scout webhooks, please see the Help Scout developer documentation.

In order to enable events, add these two extra configurations to your instance JSON:

"event.notification.enabled": "true",
"event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>"

instance JSON with polling events enabled:

{
    "element" : {
        "key" : "helpscout"
    },
  "configuration" : {
    "username": "<INSERT_HELPSCOUT_API_KEY>",
    "password": "<INSERT_HELPSCOUT_PASSWORD>",
    "mailbox.name": "<INSERT_HELPSCOUT_MAILBOX>",
    "event.notification.enabled": "true",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>"
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}