FreshBooks Classic

Overview
Register as a Consumer
Authentication
Create Instance
Transform Data
Events
Bulk APIs
Error Codes
Querying
Tips
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.

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

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

instance JSON with events enabled:

{
  "element": {
    "key": "FreshBooks Classic"
  },
  "providerData": {
       "oauth_token": "<OAUTH_TOKEN_RETURNED_IN_OAUTH_EXCHANGE>",
       "oauth_verifier": "<OAUTH_VERIFIER_RETURNED_IN_OAUTH_EXCHANGE>",
       "secret": "<SECRET_RETURNED_IN_OAUTH_EXCHANGE>"
   },
  "configuration": {
    "oauth.api.key":"<INSERT_FreshBooks Classic_API_KEY>",
    "oauth.api.secret":"<INSERT_FreshBooks Classic_API_SECRET>",
    "FreshBooks Classic.site.address":"<INSERT_FreshBooks Classic_SITE_ADDRESS>",
    "event.notification.enabled": "true",
    "event.notification.callback.url": "<INSERT_YOUR_APPS_CALLBACK_URL>"
  },
  "tags": [
    "<INSERT_TAGS>"
  ],
  "name": "<INSERT_INSTANCE_NAME>"
}