Updating polling configuration
Polling configuration enables automatic and timely data updates between applications by allowing regular checks on data sources. You can set time intervals and apply filters to synchronize data efficiently. The first time that you add a polled event group, you need to update the polling configuration fields of the events as necessary in the Event details tab.
| Field name | Description |
|---|---|
| Created timestamp property | Select the field from your application that contains the timestamp for when the object was created. The list of fields that are shown for timestamps are the ones that are provided by the application for use in filters. This field is shown by default in the New 'event name' and Updated 'event name' events. |
| Updated timestamp property | Select the field from your application that contains the timestamp for when the object was updated. The list of fields that are shown for timestamps are the ones that are provided by the application for use in filters. This field is shown by default in the Updated 'event name' and New or updated 'event name' events. |
| Created query template | Specify the created query template format supported by your
target application. A created query template must contain the
updated date field and its corresponding value. For example, if the
query supported by your application is in the form of
$filter=createdDateTime ge 2021-01-02T12:00:00Z, then
the corresponding query template value would be
$filter=createdDateTime ge ${value}. The query
template defines the filter design when the Test tab triggers a
call for an event. This field is shown by default in the New 'event
name' event. |
| Updated query template | Specify the updated query template format supported by your
target application. An updated query template must contain the
updated date field and its corresponding value. For example, if the
query supported by your application is in the form of
$filter=updatedDateTime ge 2021-01-02T12:00:00Z, then
the corresponding query template value would be
$filter=updatedDateTime ge ${value}. The query
template defines the filter design when the Test tab triggers a
call for an event. This field is shown by default in the Updated
'event name' and New or updated 'event name' events. |
| Application time zone | Select the time zone that applies to the timestamps in your target application. The default value is UTC (Coordinated Universal Time). |
| Display name | The display the name of the polled event. The field name is generated based on the associated action group name and is noneditable. |
| Description | The description of the polled event. The description is generated based on the associated action description and is noneditable. |
| Retrieve action | The action type of the associated retrieve action. The action type cannot be changed from the Events tab. |
| Group | The group with which the associated 'RetrieveWithWhere' action belongs. The group cannot be changed from the Events tab. |
Adding created timestamp properties
When new polled events get added in the Events tab, you need to configure the created timestamp property with the necessary parameters. The created timestamp property field is displayed by default in the New 'event name' and Updated 'event name' events. In the created timestamp property dropdown, you can find date-time properties that are available only in the Response tab or are common in both the Response tab and the filter parameters of the Request tab.
To add a new property in the created timestamp property field, complete the following steps:
- Go to the Connector Development Kit home page and select the connector you want to work with.
- On the Actions tab, click the associated action with action type 'RetrieveWithWhere'.
- On the Response tab of the associated action, create a new schema or select an existing schema, and add a new property with the type Date-time. For more information, see Adding properties.
- On the Array of properties dropdown, select an array that contains the data for the response of the action.
- If necessary, on the Request tab of the associated action, create a new date-time filter parameter with the same property and name as that of the previously created response parameter, with the operator 'is greater than'. For more information, see Adding filter parameters.
- Go to , and then select the newly added Date-time property in the Created timestamp property field.
Adding updated timestamp properties
When new polled events get added in the Events tab, you need to configure the updated timestamp property with the necessary parameters. The updated timestamp property field is displayed by default in the Updated 'event name' and New or updated 'event name' events. In the updated timestamp property dropdown, you can find date-time properties that are common in both the Response tab and the filter parameters of the Request tab.
To add a new property in the updated timestamp property field, complete the following steps:
- Go to the Connector Development Kit home page and select the connector you want to work with.
- On the Actions tab, click the associated action with action type 'RetrieveWithWhere'.
- On the Response tab of the associated action, create a new schema or select an existing schema, and add a new property with the type Date-time. For more information, see Adding properties.
- On the Array of properties dropdown, select an array that contains the data for the response of the action.
- If necessary, on the Request tab of the associated action, create a new date-time filter parameter with the same property and name as that of the previously created response parameter, with the operator 'is greater than'. For more information, see Adding filter parameters.
- Go to , and then select the newly added common Date-time property in the Updated timestamp property field.
Created and updated timestamp properties behavior
The properties added to the Created timestamp property and Updated timestamp property fields are displayed or not displayed based on the following conditions:
| Event name | Condition 1 | Condition 2 | Condition 3 |
|---|---|---|---|
| New 'event name' | Only Created timestamp property (The dropdown consists of only one date-time property available in the Response tab) shown. | Only Created timestamp property (The dropdown consists of only one date-time property that is commonly available in both the Response tab and the filter parameters of the Request tab) shown. | Created timestamp property (The dropdown consists of multiple date-time properties available in the Response tab) and Updated timestamp property (The dropdown consists of properties that are commonly available in both the Response tab and the filter parameters of the Request tab) shown. |
| Updated 'event name' | Created timestamp property (The dropdown consists of multiple date-time properties available in the Response tab) and Updated timestamp property (The dropdown consists of properties that are commonly available in both the Response tab and the filter parameters of the Request tab) shown. | ||
| New or updated 'event name' | Only Updated timestamp property (The dropdown consists of date-time properties that are commonly available in both the Response tab and the filter parameters of the Request tab) shown. |
Adding created query template
The created query template field is used as a query string by the Connector Development Kit Test events tab while checking for polled events. The 'RetrieveWithWhere' operation sends queries to the target application in a specific query string format to get the latest event details. It is important to note that this format is unique to each application, so you need to provide the query string format as defined in the API documentation of the application.
A created query template must be of type string and contain the created date field and
its corresponding ${value}. For example, if the query supported by your application is in the form
of $filter=createdDateTime ge 2024-01-02T12:00:00Z, then the corresponding query
template would be $filter=createdDateTime ge ${value}. In this example,
createdDateTime represents the created date field, and
2024-01-02T12:00:00Z is the ${value}. When the query template field is filled in,
the tool generates an output displaying how the query would be created. The Connector Development Kit then uses the template to dynamically
generate the query at run time.
Examples of created query template for different connectors:
| Connector | Created query template value |
|---|---|
| Microsoft OneNote |
$filter=createdDateTime ge ${value}
|
| ClickSend |
$createdDateTime$_from=$value$
|
| GetResponse |
query[$createdDateTime$][from]=$value$
|
| Zoho CRM |
criteria=(createdDateTime:greater_than:${value})
|
Adding updated query template
The updated query template field is used as a query string by the Connector Development Kit Test events tab while checking for polled events. The 'RetrieveWithWhere' operation sends queries to the target application in a specific query string format to get the latest event details. It is important to note that this format is unique to each application, so you need to provide the query string format as defined in the API documentation of the application.
An updated query template must be of type string and contain the updated date field and
its corresponding ${value}. For example, if the query supported by your application is in the form
of $filter=updatedDateTime ge 2024-01-02T12:00:00Z, then the corresponding query
template would be $filter=updatedDateTime ge ${value}. In this example,
updatedDateTime represents the updated date field, and
2024-01-02T12:00:00Z is the ${value}. When the query template field is filled in,
the tool generates an output displaying how the query would be created. The Connector Development Kit then uses the template to dynamically
generate the query at run time.
Examples of created query template for different connectors:
| Connector | Updated query template value |
|---|---|
| Microsoft OneNote |
$filter=updatedDateTime ge ${value}
|
| ClickSend |
$updatedDateTime$_from=$value$
|
| GetResponse |
query[$updatedDateTime$][from]=$value$
|
| Zoho CRM |
criteria=(updatedDateTime:greater_than:${value})
|