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.
Cloud Elements supports polling events for Oracle Eloqua.
You can set up polling for resources that include created
, updated
, and deleted
data through our API.
You can configure polling through the UI or in the JSON body of the /instances
API request .
For more information about each field described here, see Parameters.
To authenticate an element instance with polling:
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.
Use the /instances
endpoint to authenticate with Oracle Eloqua and create an element instance with polling enabled.
To authenticate an element instance with polling:
Construct a JSON body as shown below (see Parameters):
{
"element":{
"key":"eloqua"
},
"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":{
"contacts":{
"url":"/hubs/marketing/contacts?where=lastUpdatedAt>='${date:10 digit integer Unix time}'",
"idField":"id",
"datesConfiguration":{
"updatedDateField":"C_DateModified",
"updatedDateFormat":"10 digit integer Unix time'",
"updatedDateTimezone":"GMT",
"createdDateField":"C_DateCreated",
"createdDateFormat":"10 digit integer Unix time",
"createdDateTimezone":"GMT"
}
}
}
},
"tags":[
"<Add_Your_Tag>"
],
"name":"<INSTANCE_NAME>"
}
Call the following, including the JSON body you constructed in the previous step:
POST /instances
Locate the token
and id
in the response and save them for all future requests using the element instance.
instance JSON with polling events enabled:
{
"element":{
"key":"sageone"
},
"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":{
"contacts":{
"url":"/hubs/marketing/contacts?where=lastUpdatedAt>='${518862600}'",
"idField":"id",
"datesConfiguration":{
"updatedDateField":"C_DateModified",
"updatedDateFormat":"518862600'",
"updatedDateTimezone":"GMT",
"createdDateField":"C_DateCreated",
"createdDateFormat":"518862600",
"createdDateTimezone":"GMT"
}
}
}
},
"tags":[
"Test"
],
"name":"API_Polling"
}
API parameters not shown in Cloud Elements are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
key |
The element key. eloqua |
string |
code |
The authorization grant code returned from the API provider in an OAuth2 authentication workflow. | string |
Namename |
The name for the element instance created during authentication. | Body |
oauth.callback.url |
The Callback URL for the connected app you created for Oracle Eloqua. This is the Callback URL that you recorded in API Provider Setup section. | |
oauth.api.key |
The key obtained from registering your app with the provider. This is the Client ID that you recorded in API Provider Setup section. | string |
oauth.api.secret |
The client secret obtained from registering your app with the provider. This is the Client Secret that you recorded in API Provider Setup section. | string |
Events Enabled event.notification.enabled |
Optional. Identifies that events are enabled for the element instance.Default: false . |
boolean |
Event Notification Callback URLevent.notification.callback.url |
The URL where you want Cloud Elements to send the events. | string |
Event poller refresh interval (mins)event.poller.refresh_interval |
A number in minutes to identify how often the poller should check for changes. | number |
Configure Pollingevent.poller.configuration |
Optional*. Configuration parameters for polling. | JSON object |
contacts | The polling event configuration of the contacts resource. | JSON object |
URLurl |
The url to query for updates to the resource. | String |
ID FieldidField |
The field in the resource that is used to uniquely identify it. | String |
Advanced FilteringdatesConfiguration |
Configuration parameters for dates in polling | JSON Object |
Updated Date FieldupdatedDateField |
The field that identifies an updated object. | String |
Updated Date FormatupdatedDateFormat |
The date format of the field that identifies an updated object. | String |
Created Date FieldcreatedDateField |
The field that identifies a created object. | String |
Created Date FormatcreatedDateFormat |
The date format of the field that identifies a created object. | String |
tags | Optional. User-defined tags to further identify the instance. | string |