Citrix Sharefile 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 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.

Polling

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.

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

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 in Citrix Sharefile Authenticate an Element Instance.

2. Construct a JSON body as shown below (see Polling 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. For more information, see Authorization Headers, Organization Secret, and User Secret.

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",
    "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

Webhooks utilize existing functionality at the API provider and typically require additional setup. See your API provider documentation for details.

Configure Webhooks Through the UI

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 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 in Citrix Sharefile Authenticate an Element Instance.

2. Construct a JSON body as shown below (see Webhook 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. For more information, see Authorization Headers, Organization Secret, and User Secret.

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.