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

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

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.

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

ParameterDescriptionData Type
keyThe element key.
sharefile
string
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint.string
Name
name
The name of the element instance created during authentication.Body
oauth.api.keyThe API key or client ID obtained from registering your app with the provider. This is the Client Id that you noted in API Provider Setup.string
oauth.api.secretThe client secret obtained from registering your app with the API provider. This is the Client Secret that you noted in API Provider Setup.string
oauth.callback.urlThe API key or client ID obtained from registering your app with the provider. This is the Redirect URI that you noted in API Provider Setup.
Sharefile Root Folder
document.root.folder.name
The root folder. The /top folder is the root level folder.string
Subdomain
sharefile.subdomain
The subdomain part of your Sharefile url. For example, if your url is https://cloud-elements.sharefile.com enter cloud-elements.string
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

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.

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

ParameterDescriptionData Type
keyThe element key.
sharefile
string
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint.string
Name
name
The name of the element instance created during authentication.Body
oauth.api.keyThe API key or client ID obtained from registering your app with the provider. This is the Client Id that you recorded in API Provider Setup.string
oauth.api.secretThe client secret obtained from registering your app with the API provider. This is the Client Secret that you recorded in API Provider Setup.string
oauth.callback.urlThe URL that the API provider returns a user to after they authorize access. This is the Redirect URI that you recorded in API Provider Setup.
Sharefile Root Folder
document.root.folder.name
The root folder. The /top folder is the root level folder.string
Subdomain
sharefile.subdomain
The subdomain part of your Sharefile url. For example, if your url is https://cloud-elements.sharefile.com enter cloud-elements.string
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
Callback Notification Signature Key
event.notification.signature.key
Optional. A user-defined key for added security to show that events have not been tampered with.string
tagsOptional. User-defined tags to further identify the instance.string