Authenticate an Element Instance with Events

This section provides a summary of how to authenticate an element instance with events. Each element is different, so take a look at the Events section of the specific Element guide. You can authenticate via Cloud Elements or APIs. Use the UI/API switch at the top of this page to switch between UI or API steps.

Authenticate an Element Instance with Polling

Authenticating an element instance with events works the same as authenticating an instance, you just need to turn on events and set a few more parameters.

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

To authenticate an element instance with polling:

1. Enter the Name of the element instance and any configuration parameters need to authenticate the element instance.
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. If the element supports both polling and webhooks, select polling in Event Type.
5. Add an Event Notification Callback URL to receive information about the events.
6. Use the Event poller refresh interval (mins) slider or enter a number in minutes to specify how often Cloud Elements should poll for changes.

7. Click to select a resource to poll.

   The code view on the right updates the event.poller.configuration JSON object with the default polling configuration. You can change the polling configuration for each authenticated instance.

8. Optionally, click to update the polling configuration, which appears in the Event Poller Configuration pane on the right.

   Note: The default polling configuration represents the optimal configuration. Although you can change anything in the poller configuration, we recommend that you do so rarely and in conjunction with Cloud Elements support.

9. In the Event Poller Configuration pane, you can update any of the fields, including the date fields under Advanced Filtering. After you make changes, click Save.

Your polling configuration is complete and you can authenticate the element instance. Use the events to build formulas to accomplish a wide variety of workflows.

Polling Parameters

Labels and buttons on the UI correspond to parameters in the JSON. The table below shows UI labels and buttons in bold and the equivalent parameters in the configuration JSON object in code formatting.

Authenticate an Element Instance with Webhooks

Authenticating an element instance with events works the same as authenticating an instance, you just need to turn on events and set a few more parameters.

To authenticate an element instance with webhooks:

1. Enter the Name of the element instance and any configuration parameters need to authenticate the element instance.
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. If the element supports both polling and webhooks, select webhooks in Event Type.

5. Add an Event Notification Callback URL to receive information about the events.

   Note: In most cases you must set up the event callback URL as part of API provider's webhook setup, and what you enter here should match.

Your webhooks configuration is complete and you can authenticate the element instance. Use the events to build formulas to accomplish a wide variety of workflows.

Webhook Parameters

Labels and buttons on the UI correspond to parameters in the JSON. The table below shows UI labels and buttons in bold and the equivalent parameters in the configuration JSON object in code formatting.