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 Adobe Sign.

In order to enable polling, add these 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": "adobe-esign"
  },
  "providerData": {
    "code": "Code on Return the URL"
  },
  "configuration": {
    "oauth.api.key": "<INSERT_ADOBE_ESIGN_CLIENT_ID>",
    "oauth.api.secret": "<INSERT_ADOBE_ESIGN_CLIENT_SECRET>",
    "oauth.callback.url": "https://www.mycoolapp.com/auth",
    "oauth.scope": "agreement_read:account agreement_send:account agreement_write:account library_read:account library_write:account user_login:account user_read:account user_write:account widget_read:account widget_write:account workflow_read:account workflow_write:account",
    "event.notification.enabled": "true",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>",
    "event.poller.configuration": {
      "agreementAssetEvents": {
        "url": "/hubs/esignature/agreementAssetEvents?where=startDate='${date:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "agreementAssetId"
      }
    },
    "tags": [
      "<INSERT_TAGS>"
    ],
    "name": "<INSERT_INSTANCE_NAME>"
  }
}