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 Constant Contact.

You can set up events for the following resources:

• campaigns
• contacts
• lists

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. Enter the basic information required to create an element instance as described in Authenticate with Constant Contact .
2. Enable events: Switch Events Enabled on.
3. Add an Event Notification Callback URL.
4. Use the Event poller refresh interval (mins) slider or enter a number in minutes to specify how often Cloud Elements should poll for changes.
5. Select the resources to poll.
6. Advanced users can further configure polling:
   • Click to edit the polling configuration JSON directly.
   • Click to access the poller configuration.
7. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
8. Click Create Instance.
9. If using the earlier UI, optionally add tags.
10. Note the Token and ID and save them for all future requests using the element instance.
11. Take a look at the documentation for the element resources now available to you.

Configure Polling Through API

Use the /instances endpoint to authenticate with Constant Contact 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":"constantcontact"
     },
     "providerData":{
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration":{
       "oauth.api.key": "<CLIENT_ID>",
       "oauth.api.secret": "<CLIENT_SECRET>",
       "oauth.callback.url": "<CALLBACK_URL>",
       "event.notification.enabled": true,
       "event.notification.callback.url": "http://mycoolapp.com",
       "event.poller.refresh_interval": "<minutes>",
       "event.poller.configuration":{
         "campaigns":{
           "url":"/hubs/marketing/campaigns?where=modified_since='${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
           "idField":"id",
           "datesConfiguration":{
             "updatedDateField":"modified_date",
             "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
             "createdDateField":"modified_date",
             "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'"
           }
         }
       }
     },
     "tags":[
       "<Add_Your_Tag>"
     ],
     "name":"<INSTANCE_NAME>"
   }
   

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":"constantcontact"
  },
  "providerData":{
    "code":"1c6ff4089d58d80e86482ab7d5b97f15dd7b041d"
  },
  "configuration":{
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx",
    "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":{
      "campaigns":{
        "url":"/hubs/marketing/campaigns?where=modified_since='${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
        "idField":"id",
        "datesConfiguration":{
          "updatedDateField":"modified_date",
          "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'",
          "createdDateField":"modified_date",
          "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      }
    }
  },
  "tags":[
    "Test"
  ],
  "name":"API_Polling"
}

Parameters

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