DocuSign 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 Events Overview.

Cloud Elements supports polling and webhook events for DocuSign.

DocuSign Documents and Envelopes are currently supported within the Events Framework.

Polling

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>"

instance JSON with polling events enabled:

{
  "element": {
    "key": "docusign"
  },
    "configuration": {
    "username": "<INSERT_DOCUSIGN_USERNAME>",
    "password": "<INSERT_DOCUSIGN_PASSWORD>",
    "oauth.api.key": "<INSERT_DOCUSIGN_INTEGRATOR_KEY>",
    "docusign.environment": "<INSERT_DOCUSIGN_ENVIRONMENT>",
    "event.notification.enabled": "true",
    "vendor.event.type": "polling",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>"
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}

Webhooks

Cloud Elements supports webhooks when creating an envelope. With webhooks enabled, a notification will be sent upon successful creation of an envelope. See the DocuSign documentation or more information on DocuSign webhooks.

In order to enable webhooks, add these three 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": "docusign"
  },
    "configuration": {
    "username": "<INSERT_DOCUSIGN_USERNAME>",
    "password": "<INSERT_DOCUSIGN_PASSWORD>",
    "oauth.api.key": "<INSERT_DOCUSIGN_INTEGRATOR_KEY>",
    "docusign.environment": "<INSERT_DOCUSIGN_ENVIRONMENT>",
    "event.notification.enabled": "true",
    "vendor.event.type": "webhooks",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>"
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}