Share Link Notifications

A BundleNotification is an E-Mail sent out to users when certain actions are performed on or within a shared set of files and folders.

List Share Link Notifications

XML Element

<filescom:list-share-link-notifications />

Authorization Requirement

Available to all authenticated keys or sessions.

Example Operation

<filescom:list-share-link-notifications config-ref="FilesCom" />

Example Response Payload

[
  {
    "bundleId": 1,
    "id": 1,
    "notifyOnRegistration": true,
    "notifyOnUpload": true,
    "notifyCurrentUser": true,
    "notifyUserId": 1,
    "workspaceId": 1
  }
]

Show Share Link Notification

XML Element

<filescom:show-share-link-notification />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
id
Long
Required		Bundle Notification ID.

Example Operation

<filescom:show-share-link-notification config-ref="FilesCom" id="1" />

Example Response Payload

{
  "bundleId": 1,
  "id": 1,
  "notifyOnRegistration": true,
  "notifyOnUpload": true,
  "notifyCurrentUser": true,
  "notifyUserId": 1,
  "workspaceId": 1
}

Create Share Link Notification

XML Element

<filescom:create-share-link-notification />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
bundleId
Long
Required		Bundle ID to notify on
notifyUserId
Long		The id of the user to notify.

Example Operation

<filescom:create-share-link-notification config-ref="FilesCom"
 bundleId="1"
 notifyUserId="1"
/>

Example Response Payload

{
  "bundleId": 1,
  "id": 1,
  "notifyOnRegistration": true,
  "notifyOnUpload": true,
  "notifyCurrentUser": true,
  "notifyUserId": 1,
  "workspaceId": 1
}

Update Share Link Notification

XML Element

<filescom:update-share-link-notification />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
id
Long
Required		Bundle Notification ID.
notifyOnRegistration
boolean		Triggers bundle notification when a registration action occurs for it.
notifyOnUpload
boolean		Triggers bundle notification when a upload action occurs for it.

Example Operation

<filescom:update-share-link-notification config-ref="FilesCom"
 id="1"
 notifyOnRegistration="true"
 notifyOnUpload="true"
/>

Example Response Payload

{
  "bundleId": 1,
  "id": 1,
  "notifyOnRegistration": true,
  "notifyOnUpload": true,
  "notifyCurrentUser": true,
  "notifyUserId": 1,
  "workspaceId": 1
}

Delete Share Link Notification

XML Element

<filescom:delete-share-link-notification />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
id
Long
Required		Bundle Notification ID.

Example Operation

<filescom:delete-share-link-notification config-ref="FilesCom" id="1" />