Events

Cloud Elements supports events via polling or webhooks depending on the endpoint. If you would like to see more information on our Events framework, please see the Event Management Guide.

Supported Events and Resources

Cloud Elements supports polling events for Sage One.

You can set up polling for the customers resource. You can also copy the customers configuration to poll other resources. See Configure Polling Through API for more information.

Alternatively, if there are multiple supported resources, you can go with something like this:

You can set up events for the following resources:

• Account
• Lead
• Contact
• Opportunity
• Other objects that include created, updated, and deleted data.

Polling

You can configure polling through the UI or in the JSON body of the /instances API call.

Configure Polling Through the UI

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

To authenticate an element instance with polling:

1. Sign in to Cloud Elements, and then search for Sage One in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. Switch Events Enabled on.
5. Add an Event Notification Callback URL.
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. Select the resources to poll.
8. Advanced users can further configure polling:
   • Click to edit the polling configuration JSON directly.
   • Click to access the poller configuration.
9. Click Create Instance.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Configure Polling Through API

Use the /instances endpoint to authenticate with Sage One and create an element instance with polling enabled.

To authenticate an element instance with polling:

1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

2. Construct a JSON body as shown below (see Parameters):

   {
     "element":{
       "key":"sageone"
     },
     "providerData":{
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration":{
       "oauth.api.key": "<CLIENT_ID>",
       "oauth.api.secret": "<CLIENT_SECRET>",
       "signature.secret": "<SIGNING_SECRET>",
       "apim.subscription.key": "<SUBSCRIPTION_PRIMARY_KEY_or_APIM_SUBSCRIPTION_KEY>",
       "country": "<COUNTRY_CODE>",
       "oauth.callback.url": "<CALLBACK_URL>",
       "event.notification.enabled": true,
       "event.notification.callback.url": "http://mycoolapp.com",
       "event.poller.refresh_interval": "<minutes>",
       "event.poller.configuration":{
         "customers":{
           "url":"/hubs/finance/customers?where=lastModifiedDate>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' and attributes='created_at,updated_at",
           "idField":"id",
           "datesConfiguration":{
             "updatedDateField":"updated_at",
             "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
             "updatedDateTimezone":"GMT",
             "createdDateField":"created_at",
             "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
             "createdDateTimezone":"GMT"
           }
         }
       }
     },
     "tags":[
       "Test"
     ],
     "name":"API_Polling"
   }
   

   Note: To poll additional resources, copy the customers configuration and replace customers with the name of the resource.

3. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

4. Locate the token and id in the response and save them for all future requests using the element instance.

Example JSON with Polling

instance JSON with polling events enabled:

{
  "element":{
    "key":"sageone"
  },
  "providerData":{
    "code":"1c6ff4089d58d80e86482ab7d5b97f15dd7b041d"
  },
  "configuration":{
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx",
    "signature.secret": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "apim.subscription.key": "xxxxxxxxxxxxxxxxxxxxxxxxx",
    "country": "US",
    "oauth.callback.url": "https://mycoolapp.com",
    "event.notification.enabled":true,
    "event.notification.callback.url":"http://mycoolapp.com",
    "event.poller.refresh_interval":"15",
    "event.poller.configuration":{
      "customers":{
        "url":"/hubs/finance/customers?where=lastModifiedDate>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}' and attributes='created_at,updated_at",
        "idField":"id",
        "datesConfiguration":{
          "updatedDateField":"updated_at",
          "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
          "updatedDateTimezone":"GMT",
          "createdDateField":"created_at",
          "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
          "createdDateTimezone":"GMT"
        }
      }
    }
  },
  "tags":[
    "Test"
  ],
  "name":"API_Polling"
}

Parameters

API parameters not shown in Cloud Elements are in code formatting.