Act! Essentials

Overview
Endpoint Setup
Authentication
Create Instance
Transform Data
Events
Error Codes
Querying
API Docs

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.

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

Cloud Elements supports polling events for Act! Essentials.

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

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

NOTE: The objects in the event.poller.configuration are the default configurations we support. Feel free to remove any objects that do not fit your needs.

instance JSON with polling events enabled:

{
  "element": {
    "key": "actessentialsoauth"
  },
  "configuration": {
    "oauth.api.key": "<INSERT_ACT_ESSENTIALS_API_KEY>",
    "oauth.api.secret": "<INSERT_ACT_ESSENTIALS_API_SECRET>",
    "oauth.callback.url": "<INSERT_OAUTH_CALLBACK_URL>",
    "event.notification.enabled": "true",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>",
    "event.poller.configuration": {
      "campaigns": {
        "url": "/hubs/crm/campaigns?where=sendDate>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      },
      "opportunities": {
        "url": "/hubs/crm/opportunities?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      },
      "contacts": {
        "url": "/hubs/crm/contacts?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      },
      "lists": {
        "url": "/hubs/crm/lists?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      },
      "metadata": {
        "url": "/hubs/crm/metadata?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ssXXX"
        }
      },
      "activities": {
        "url": "/hubs/crm/activities?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      },
      "interactions": {
        "url": "/hubs/crm/interactions?where=lastUpdated>'${date:yyyy-MM-dd'T'HH:mm:ss.SSS'Z'}'",
        "idField": "id",
        "datesConfiguration": {
          "updatedDateField": "lastUpdated",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateField": "created",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"
        }
      }
    }
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}