Events Overview

The Sugar Integrate Events Framework provides a uniform mechanism for subscribing to events from API providers like Salesforce, HubSpot, QuickBooks, and Dropbox. Our Events Framework gives you the flexibility to receive notifications to your app regarding user activity by having our adapters subscribe to API provider events. API providers publish changes to notify the adapters that events have occurred. 

For example, a user creates an event (e.g create/update/delete a file) to their Dropbox account using the Dropbox user interface. This event will generate a notification that will be published to your Dropbox adapter. The notification will include as default some of our Sugar Integrate-standardized fields as objectType, objectId, eventType, elementKey, etc while from the vendor, the user could have additional information like name, path, size, etc. An Event Notification can contain up to 10 (for polling) or 20 (for webhook) events objects inside depending on the vendor response.  

In the context of events-triggered procedures, only a single event object can be referenced from the trigger event, even if the event may have been part of a larger event notification. After the notification of the event, the Dropbox adapter notifies your app that a new file has been uploaded. Your app can then be updated with the most current data making it that much more cooperative and powerful.

Event Configuration Types

Sugar Integrate currently supports building integrations with polling or webhooks capability.

With Polling, Sugar Integrate executes a configured query every n minutes and captures the changed information.

With Webhooks, the API provider lets Sugar Integrate know what information has changed. Some API providers require some additional configuration setup for Event Management. Instructions and screen shots for these configurations can be found in the Adapter Guides under Events for each API provider.

Receiving Events

Events can be sent to your application by setting the Event Notification Callback URL (event.notification.callback.url) configuration value to your application's URL during provisioning, such as You can also return events to the adapters with an Event Notification Callback URL like<Adapter-Key>/.

To update an active instance use the PATCH /instances or PATCH /instances/{id}/configuration/{configurationId} endpoints to add an Event Notification Callback URL.