Events

Cloud Elements currently supports events via polling or webhooks depending on the endpoint.

• Polling is a mechanism where Cloud Elements executes the configured query every n minutes and captures the changed information.
• Webhooks are when the provider lets Cloud Elements know what information has changed. Note that additional endpoint setup may be required prior to creating your Element Instance.

If you would like to see more information on our Events framework, please see the Event Management Guide.

Cloud Elements supports polling events for the following SAP Hybris Cloud for Customer Helpdesk resources:

• accounts
• contacts
• incidents
• incidents-statuses

Configure Polling Through the UI

Use Cloud Elements to authenticate with SAP Hybris Cloud for Customer and create an element instance with polling enabled.

To authenticate an element instance with polling:

1. Sign in to Cloud Elements, and then search for SAP Hybris Cloud for Customer Helpdesk in our Elements Catalog.
2. Hover over the element card, and then click Authenticate.
3. Enter a name for the element instance.
4. Complete the required parameters in the Configuration section: Subdomain, Username, and Password. See Parameters for descriptions.
5. Switch Events Enabled on.
6. Add an Event Notification Callback URL.
7. Use the Event poller refresh interval (mins) slider or enter a number in minutes to specify how often Cloud Elements should poll for changes.
8. Select the resources to poll.
9. Advanced users can further configure polling:
   • Click to edit the polling configuration JSON directly.
   • Click to access the poller configuration.
10. Click Create Instance.
11. Optionally add tags in the earlier UI

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.

Configure Polling Through API

Use the /instances endpoint to authenticate with SAP Hybris Cloud for Customer and create an element instance with polling enabled.

To authenticate an element instance with polling:

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

   {
       "element": {
         "key": "sapc4chd"
       },
       "configuration": {
         "subdomain": "<domain>.crm.ondemand.com",
         "username": "<YOUR_SAP_Hybris Cloud for Customer_USERNAME>",
         "password": "<YOUR_SAP_Hybris Cloud for Customer_PASSWORD>",
         "event.notification.enabled": true,
         "event.notification.callback.url": "http://mycoolapp.com",
         "event.poller.refresh_interval": "15",
         "accounts": {
           "url": "/hubs/helpdesk/accounts?where=ChangedOn>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}",
          "idField": "ObjectID",
          "datesConfiguration": {
            "updatedDateField": "ChangedOn",
            "updatedDateFormat": "milliseconds",
            "createdDateField": "CreatedOn",
            "createdDateFormat": "milliseconds"
          },
           "contacts": {
             "url": "/hubs/helpdesk/contacts?where=ChangedOn>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
             "idField": "ObjectID",
             "datesConfiguration": {
               "updatedDateField": "ChangedOn",
               "updatedDateFormat": "milliseconds",
               "createdDateField": "CreatedOn",
               "createdDateFormat": "milliseconds"
             }
           },
           "incidents": {
             "url": "/hubs/helpdesk/incidents?where=ChangedOn>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}",
             "idField": "ObjectID",
             "datesConfiguration": {
               "updatedDateField": "ChangedOn",
               "updatedDateFormat": "milliseconds",
               "createdDateField": "CreatedOn",
               "createdDateFormat": "milliseconds"
             }
           },
           "incidents-statuses": {
             "url": "/hubs/helpdesk/incidents-statuses?where=ChangedOn>='${date:yyyy-MM-dd'T'HH:mm:ss'Z'}",
             "idField": "ObjectID",
             "datesConfiguration": {
               "updatedDateField": "ChangedOn",
               "updatedDateFormat": "milliseconds",
               "createdDateField": "CreatedOn",
               "createdDateFormat": "milliseconds"
             }
           }
         },
       },
       "tags": [
         "ElementDocs"
         ],
       "name": "<AUTHENTICATED_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. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Parameters

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

Example cURL

curl -X POST \
  https://staging.cloud-elements.com/elements/api-v2/instances \
  -H 'Authorization: User <INSERT>, Organization <INSERT>'  \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "sapc4chd"
  },
  "configuration": {
    "subdomain": "<domain>.crm.ondemand.com",
    "username": "<USERNAME>",
    "password": "<YOUR_SAP_Hybris Cloud for Customer_PASSWORD>",
          "event.notification.enabled": true,
          "event.notification.callback.url": "http://mycoolapp.com",
          "event.poller.refresh_interval": "15",
          "incidents": {
            "url": "/hubs/helpdesk/incidents?where=ChangedOn>='\''${date:yyyy-MM-dd'\''T'\''HH:mm:ss'\''Z'\''}",
           "idField": "ObjectID",
           "datesConfiguration": {
             "updatedDateField": "ChangedOn",
             "updatedDateFormat": "milliseconds",
             "createdDateField": "CreatedOn",
             "createdDateFormat": "milliseconds"
           }
}
  },
  "tags": [
    "ElementDocs"
  ],
  "name": "<AUTHENTICATED_INSTANCE_NAME>"
}
'

Example Response

{
  "id": 50753,
  "name": "SAPHybris Cloud for CustomerAPI1",
  "createdDate": "2017-05-19T14:00:59Z",
  "token": "4RFxtlivv2BW9oAoO64wCnLvwwps4SPCf6LyCUq8Ihg=",
  "element": {
    "id": 5354,
    "name": "SAP Hybris Cloud for Customer Helpdesk",
    "key": "sapc4chd",
    "description": "Add a SAP Cloud for Customer (Hybris Cloud for Customer) Instance to connect your existing SAP Cloud for Customer (Hybris Cloud for Customer) account to the Helpdesk Hub, allowing you to manage accounts, contacts, incidents, etc. across multiple Helpdesk Elements. You will need your SAP Cloud for Customer (Hybris Cloud for Customer) account information to add an instance.",
    "image": "elements/provider_sapc4c.png",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": false,
    "beta": false,
    "authentication": {
      "type": "basic"
    },
    "extended": false,
    "hub": "Helpdesk",
    "protocolType": "odata",
    "parameters": [
      {
        "id": 3990,
        "createdDate": "2017-05-17T09:37:05Z",
        "name": "subdomain",
        "vendorName": "siteUrl",
        "type": "configuration",
        "vendorType": "path",
        "source": "request",
        "elementId": 5353,
        "required": false
      }
    ],
    "private": false
  },
  "elementId": 5353,
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {  },
  "eventsEnabled": true,
  "eventsNotificationCallbackUrl": "http://mycoolapp.com",
  "subscriptionId": 1157990,
  "traceLoggingEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
  "user": {  }
}