Events

Cloud Elements supports events via polling or webhooks depending on the API provider. If you would like to see more information on our Events framework, please see the Event Management Guide.

Supported Events and Resources

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

Configure Polling Through the UI

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

To authenticate an element instance with polling:

1. Enter the basic information required to authenticate an element instance as described in Authenticate with Citrix ShareFile .
2. To enable hash verification in the headers of event callbacks, click Show Optional Fields, and then add a key to Callback Notification Signature Key.
3. Enable events: Switch Events Enabled on.
4. In Event Type select Polling.
5. Add an Event Notification Callback URL.
6. Use the Event poller refresh interval (mins) slider or enter a number in minutes to specify how often Cloud Elements should poll for changes.
7. Select the resources to poll.
8. Advanced users can further configure polling:
   • Click to edit the polling configuration JSON directly.
   • Click to access the poller configuration.
9. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
10. Click Create Instance.
11. Provide your Citrix ShareFile credentials, and then allow the connection.

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 Citrix ShareFile and create an element instance with polling enabled.

To authenticate an element instance with polling:

1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

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

   {
     "element":{
       "key":"sharefile"
     },
     "providerData":{
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration":{
       "oauth.callback.url": "<CALLBACK_URL>",
       "oauth.api.key": "<CONSUMER_KEY>",
       "oauth.api.secret": "<CONSUMER_SECRET>",
       "document.root.folder.name": "</ROOT_DIR>",
       "sharefile.subdomain": "<SUBDOMAIN>",
       "event.notification.enabled": true,
       "event.vendor.type": "polling",
       "event.notification.callback.url": "http://mycoolapp.com",
       "event.notification.signature.key": "123456",
       "event.poller.refresh_interval": "<minutes>",
       "event.poller.configuration":{
         "documents":{
           "url":"/hubs/documents/events/poll/documents?where=lastmodifieddate='${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
           "idField":"id",
           "datesConfiguration":{
             "updatedDateField":"CreationDate",
             "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
             "updatedDateTimezone": "GMT",
             "createdDateField": "ProgenyEditDate",
             "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
             "createdDateTimezone": "GMT"            }
         }
       }
     },
     "tags":[
       "<Add_Your_Tag>"
     ],
     "name":"<INSTANCE_NAME>"
   }
   

3. 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.

4. 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": "sharefile"
},
"providerData":{
  "code": "<AUTHORIZATION_GRANT_CODE>"
},
"configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "document.root.folder.name": "/top",
    "sharefile.subdomain": "cloud-elements",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
      "event.notification.callback.url": "https://api.cloud-elements.com/elements/api-v2/events/sharefile/",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
        "documents": {
        "url": "/hubs/documents/events/poll/documents?where=lastmodifieddate='${gmtDate:yyyy-MM-dd'T'HH:mm:ss'Z'}'",
        "idField": "Id",
        "datesConfiguration": {
          "updatedDateField": "CreationDate",
          "updatedDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "updatedDateTimezone": "GMT",
          "createdDateField": "ProgenyEditDate",
          "createdDateFormat": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
          "createdDateTimezone": "GMT"
            }
        }
    }
  },
  "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 Parameters.

To authenticate an element instance with webhooks:

1. Enter the basic information required to authenticate an element instance as described in Authenticate with Citrix ShareFile .
2. To enable hash verification in the headers of event callbacks, click Show Optional Fields, and then add a key to Callback Notification Signature Key.
3. Enable events: Switch Events Enabled on.
4. In Event Type select Webhook.
5. Add an Event Notification Callback URL.
6. Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
7. Click Create Instance.
8. Provide your Citrix ShareFile credentials, and then allow the connection.

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 Webhooks Through API

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

To authenticate an element instance with webhooks:

1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.

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

   {
     "element": {
       "key": "sharefile"
     },
     "providerData": {
       "code": "<AUTHORIZATION_GRANT_CODE>"
     },
     "configuration": {
       "oauth.callback.url": "https;//mycoolapp.com",
       "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
       "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
       "document.root.folder.name": "/top",
       "sharefile.subdomain": "cloud-elements",
       "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>"
   }
   
   

3. 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.

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

Example cURL

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": "sharefile"
  },
  "providerData": {
    "code": "xoz8AFqScK2ngM04kSSM"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
    "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "document.root.folder.name": "/top",
    "sharefile.subdomain": "cloud-elements",
    "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.