WooCommerce Events

On this page

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 and webhooks for WooCommerce.

Polling

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

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

You can set up polling events for the following resources:

  • customers
  • discounts
  • orders
  • products
Note: You can set up polling for other resources that include created, updated, and deleted data through our API. Copy the configuration of one of the default resources, and replace the name with the resource that you want to poll.

Configure Polling Through the UI

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

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

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

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To authenticate an element instance with polling:

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

    {
      "element":{
        "key":"woocommercerest"
      },
      "configuration":{
        "store.url": "<WEB_STORE_URL>",
        "oauth.api.key": "<CONSUMER_KEY>",
        "oauth.api.secret": "<CONSUMER_SECRET>",
        "event.notification.enabled": true,
        "event.vendor.type": "polling",
        "event.notification.callback.url": "http://mycoolapp.com",
        "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>",
        "event.poller.refresh_interval": "<minutes>",
        "event.poller.configuration":{
          "contacts":{
            "url":"/hubs/ecommerce/customers",
            "idField":"id",
            "datesConfiguration":{
              "updatedDateField":"date_modified",
              "updatedDateFormat":"yyyy-MM-dd'T'HH:mm:ss'",
              "createdDateField":"date_created",
              "createdDateFormat":"yyyy-MM-dd'T'HH:mm:ss'"
            }
          },
          "discounts":{
            "url":"/hubs/ecommerce/discounts",
            "idField":"id",
            "datesConfiguration":{   }
          },
          "orders":{
            "url":"/hubs/ecommerce/orders",
            "idField":"id",
            "datesConfiguration":{   }
          },
          "products":{
            "url":"/hubs/ecommerce/products",
            "idField":"id",
            "datesConfiguration":{   }
          }
        }
      },
      "tags":[
        "<Add_Your_Tag>"
      ],
      "name":"<INSTANCE_NAME>"
    }
    
  2. 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. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Polling

curl -X POST \
https://api.cloud-elements.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
  "key": "woocommercerest"
},
"configuration": {
    "store.url": "<http://mycoolstore.com>",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
      "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/woocommercerest/",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
        "contacts": {
            "url":"/hubs/ecommerce/customers",
            "idField":"id",
            "datesConfiguration":{
              "updatedDateField":"date_modified",
              "updatedDateFormat":"yyyy-MM-dd'\''T'\''HH:mm:ss'\''",
              "createdDateField":"date_created",
              "createdDateFormat":"yyyy-MM-dd'\''T'\''HH:mm:ss'\''"
            }
        }
    }
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance with Polling"
}'

Polling Parameters

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

ParameterDescriptionData Type
keyThe element key.
woocommercerest
string
Name
name
The name of the element instance created during authentication.Body
OAuth API Key
oauth.api.key
The API key or client ID obtained from registering your app with the provider. This is the Consumer Key that you noted in API Provider Setup.string
OAuth API Key
oauth.api.secret
The client secret obtained from registering your app with the API provider. This is the Consumer Secret that you noted in API Provider Setup.string
The Store URL
oauth.callback.url
The url of your WooCommerce Storefrontstring
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 (mins)
event.poller.refresh_interval
A number in minutes to identify how often the poller should check for changes.number
Configure Polling
event.poller.configuration
Optional. Configuration parameters for polling.JSON object
Resource to PollThe polling event configuration of the resource that you will monitor.JSON object
URL
url
The url to query for updates to the resource.String
ID Field
idField
The field in the resource that is used to uniquely identify it.String
Advanced Filtering
datesConfiguration
Configuration parameters for dates in pollingJSON Object
Updated Date Field
updatedDateField
The field that identifies an updated object.String
Updated Date Format
updatedDateFormat
The date format of the field that identifies an updated object.String
Created Date Field
createdDateField
The field that identifies a created object.String
Created Date Format
createdDateFormat
The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string

Webhooks

You can configure webhooks through the UI or in the JSON body of the /instances API request .

Configure Webhooks Through the UI

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

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

Configure Webhooks Through API

Use the /instances endpoint to authenticate with WooCommerce and create an element instance with webhooks enabled.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To authenticate an element instance with webhooks:

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

    {
      "element": {
        "key": "woocommercerest"
      },
      "configuration": {
        "store.url": "<WEB_STORE_URL>",
        "oauth.api.key": "<CONSUMER_KEY>",
        "oauth.api.secret": "<CONSUMER_SECRET>",
        "event.notification.enabled":true,
        "event.vendor.type": "webhook",
        "event.notification.callback.url": "<CALLBACK_URL>",
        "event.notification.signature.key": "<OPTIONAL_SIGNATURE_KEY>"
      },
      "tags": [
        "<Add_Your_Tag>"
      ],
      "name": "<INSTANCE_NAME>"
    }
    
    
  2. 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. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Webhooks

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "woocommercerest"
  },
  "configuration": {
    "store.url": "<http://mycoolstore.com>",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "event.notification.enabled":true,
    "event.vendor.type": "webhook",
    "event.notification.callback.url": "https://mycoolapp.com/events",
    "event.notification.signature.key": "xxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Webhook Parameters

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

ParameterDescriptionData Type
keyThe element key.
woocommercerest
string
Name
name
The name of the element instance created during authentication.Body
OAuth API Key
oauth.api.key
The API key or client ID obtained from registering your app with the provider. This is the Consumer Key that you noted in API Provider Setup.string
OAuth API Key
oauth.api.secret
The client secret obtained from registering your app with the API provider. This is the Consumer Secret that you noted in API Provider Setup.string
The Store URL
oauth.callback.url
The url of your WooCommerce Storefrontstring
Events Enabled
event.notification.enabled
Optional. Identifies that events are enabled for the element instance.
Default: false.
boolean
Event Type
event.vendor.type
The type of event, either polling or webhook.string
Event Notification Callback URL
event.notification.callback.url
The URL where you want Cloud Elements to send the events.string
tagsOptional. User-defined tags to further identify the instance.string