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

Polling

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

You can set up polling events for the following resources:

• customers
• discounts
• orders
• products

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.

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.

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.

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.