NetSuite Human Capital Events

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports polling events for NetSuite Human Capital. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

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

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Polling Through API

To authenticate an element instance with polling, sign in to Cloud Elements, and then create a new element instance as described in authentication. When using the API, there are additional parameters used to enable and configure polling events on the new instance.

Example JSON with Polling

This example JSON shows the parameters that can be sent to the /instances API to enable and configure polling. The example shows configuration of polling for Customers objects, but you can set whichever types of objects that you wish.

{
  "element":{
    "key": "netsuitehcv2"
  },
  "configuration": {
    "netsuite.sandbox": false,
    "netsuite.accountId": "my_account_id",
    "netsuite.single.session": true,
    "netsuite.single.session.key": "my_unique_key",
    "authentication.type": "Basic",
    "user.username": "my@somewhere.com",
    "user.password": "my_secret_password",
    "netsuite.appId": "my_app_id",
    "event.notification.enabled": true,
    "event.notification.callback.url": "http://mycoolapp.com",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration": {
      "employees": {
        "url": "/hubs/finance/customers?where=lastModifiedDate>'${gmtDate:yyyy-MM-dd'T'HH:mm:ssXXX}'",
        "idField": "internalId",
        "filterByUpdatedDate": true,
        "datesConfiguration": {
          "updatedDateField": "lastModifiedDate",
          "updatedDateFormat": "milliseconds",
          "createdDateField": "dateCreated",
          "createdDateFormat": "milliseconds"
        }
      }
    }
  },
  "tags": [
    "Testing"
  ],
  "name": "NetSuite Polling"
}

Parameters

Note: Non-event related parameters are described in Authenticate.
ParameterDescriptionData Type
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the element instance.
Default: false.
boolean
Event Notification Callback URL
event.notification.callback.url
The URL where you want Cloud Elements to send the events.string
Event Poller Refresh Interval
event.poller.refresh_interval
A number in minutes to identify how often the poller should check for changes.number
Configur Polling
event.poller.configuration
Optional. Configuration parameters for polling.JSON object
<object_type>One or more JSON objects that correspond to configuration for that type. object_type can be customers, invoices, etc.JSON object
urlThe url to query for updates to the resource.String
idFieldThe field in the resource that is used to uniquely identify it.String
datesConfigurationConfiguration parameters for dates in pollingJSON Object.
updatedDateFieldThe field that identifies an updated object.String
updatedDateFormatThe date format of the field that identifies an updated object.String
createdDateFieldThe field that identifies a created object.String
createdDateFormatThe date format of the field that identifies a created object.String