Dropbox

Documentation >
Apps >
File and Document Management >
Dropbox

Dropbox¶

The Dropbox modules enable you to monitor, search, retrieve, or list files and create and edit files and folders in your Dropbox account.

Getting Started with Dropbox¶

Prerequisites

A Dropbox account

In order to use Dropbox with Ibexa Connect, it is necessary to have a Dropbox account. If you do not have one, you can create a Dropbox account at www.dropbox.com/register.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Dropbox to Ibexa Connect¶

To connect your Dropbox account to Ibexa Connect follow the general instructions for Connecting to services.

After you click the Continue button, Ibexa Connect will redirect you to the Dropbox website where you will be prompted to grant Ibexa Connect access to your account.

Confirm the dialog by clicking the Allow button.

Or (for Dropbox Business) allow access by selecting the account you want to connect Ibexa Connect to:

Trigger Files¶

Watch Files¶

Returns file details when the file in a specified folder is modified.


Folder	Select the folder you want to watch for changes.
Watch also subfolders	Enable this option to monitor also subfolders for modified files.
Limit	Set the maximum number of files Ibexa Connect will return during one execution cycle.

Get Files/Folders¶

Search Files/Folders¶

Searches for the files or folders by the specified search term and filter settings.

Required Permissions: files.metadata.read


Search	Enter the search term.
Folder	Select the folder you want to search. Searches the entire Dropbox if not specified.
File Status	Select the file status to restrict the search to the selected file status.
File Categories	Select the file categories to restrict the search to the selected categories.
File extensions	Specify the file extensions you want to search for.
Limit	Set the maximum number of results Ibexa Connect will return during one execution cycle.

Get a File¶

Downloads a file from the specified folder.

Useful for providing files to subsequent modules.


Way of selecting files	Select whether you want to map/specify the file path or select the file manually.
File Path / File	File Path Specify the target path to the file. File Select the file from the menu.

Get a Folder Metadata¶

Retrieves shared folder details.

Required Permissions: sharing.read


Shared Folder ID	Enter (map) the ID of the folder you want to retrieve details about.

List All Files/Subfolders in a Folder¶

Returns files or folders in the specified folder.

Required Permissions: files.metadata.read


List	Select whether you want to retrieve files or folders.
Show Only Downloadable Files	Enable this option to return only downloadable files. Non-downloadable files can be, for example, Google Docs.
Folder	Specify the folder you want to retrieve files or folders from.
Limit	Set the maximum number of results Ibexa Connect will return during one execution cycle.

List File Revisions¶

Retrieves all file revisions, a version history, of the specified file.

Required Permissions: files.metadata.read


Way of selecting files	Select whether you want to map/specify the file path or select the file manually.
File Path / File	File Path Specify the target path to the file. File Select the file from the menu.
Limit	Set the maximum number of revisions Ibexa Connect will return during one execution cycle.

Create & Edit File/Folder¶

Upload a File¶

Uploads a provided file to the selected folder.

Required Permissions: files.content.write, files.metadata.read


Folder	Select the folder of your Dropbox you want to upload the file to.
Source File	Specify the file you want to add to the Dropbox folder selected above. File name Enter or map the file name, including the file extension. File data Enter or map the file data (from previous module, e.g. Google Drive > Get a File) Caution: The maximum size of the uploaded file is 150 MB.

Overwrite an existing file

Enable this option to replace the existing file with the new file. If this option is left disabled, the uploaded file will be renamed.

Create a Folder¶

Creates a new folder in the specified path.

Required Permissions: files.content.write, files.metadata.read


Folder Name	Enter the name for the new folder.
Folder	Specify the path where you want to create a new folder. In case you are using a Dropbox Business account (with team spaces) remove the slash `/` or do not click the Click here to choose folder button to create a team folder in the root. If the slash is not removed an error `[409] path/malformed_path/..` is returned.
Auto rename	Enable this option to rename the new folder, if the folder with the same name already exists in the target location.

Create/Overwrite a Text File¶

Creates a DOC file or overwrites the content of an existing one.

Required Permissions: files.content.write, files.metadata.read

Select to

Select whether you want to Create or Overwrite a DOC file.

Folder

Select the target location you want to create a file at.

Source File

Specify the file you want to add to the Dropbox folder.

File name

Enter the file name for the new DOC file (without an extension).

File Content

Enter the text content of the DOC file.

Creates a public link to the file that allows you to share the file with anyone.

Required Permissions: sharing.write, files.metadata.read

Way of selecting files

Select whether you want to map/specify the file path or select the file manually.

File Path / File

File Path

Specify the target path to the file.

File

Select the file from the menu.

Requested Visibility

Select whether the link will be public, for team, or password restricted.

Team only and Access with password options are only available to users who have Dropbox Pro or higher version.

Link's Expiration Date

Enter the date and time when the link will expire and will be no longer accessible. If left empty, the link will not expire. the list of supported date and time formats.

Note

Team only and Access with password options are only available to users who have Dropbox Pro or higher version.

Link's Access Level

Set the permission for the link recipient.

Viewer Users who use the link can view and comment on the content.
Editor Users who use the link can edit, view and comment on the content.
Max Request for the maximum access level you can set the link to.

Restore a File¶

Restores a previous version of the file.

Required Permissions: files.content.write, files.metadata.read

Way of selecting files

Select whether you want to map/specify the file path or select the file manually.

File Path / File

File Path

Specify the target path to the file.

File

Select the file from the menu.

Revision

Enter or map the revision number of the revision you want to restore.

Move a File/Folder¶

Moves a file or folder to a different location in your Dropbox.

Required Permissions: files.content.write, files.metadata.read

Way of selecting files	Select whether you want to map/specify the file path or select the file manually.
File/Folder Path / File/Folder	File/Folder Path Specify the target path to the file or folder. File/Folder Select the file or folder from the menu.
To Folder	Specify the target location for the file/folder.
New Name	Enter the new name for the file/folder in the new location.
Auto Rename	Renames the new file/folder, if the file/folder with the same name exists. Adds (NUMBER) after the file/folder name. Otherwise the file/folder in the target location will be overwritten.
Allow ownership transfer	Enable this option to allow moves by owner even if it would result in an ownership transfer for the content being moved.

Rename a File/Folder¶

Renames a file or folder.

Required Permissions: files.content.write, files.metadata.read

Way of selecting files

Select whether you want to map/specify the file path or select the file manually.

File/Folder Path / File/Folder

File/Folder Path

Specify the target path to the file or folder.

File/Folder

Select the file or folder from the menu.

Rename

Enter the target name for the file, including the file extension.

Delete a File/Folder¶

Deletes a file from your Dropbox.

Required Permissions: files.content.write, files.metadata.read

Way of selecting files

Select whether you want to map/specify the file path or select the file manually.

File Path / File

File Path

Specify the target path to the file.

File

Select the file from the menu.

Make an API Call¶

Allows you to perform a custom API call.

URL

Enter a path relative to Enter a path relative to https://api.dropboxapi.com. E.g. /2/files/list_folder

For the list of available endpoints, refer to the Dropbox API v2 Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List From the Folder¶

The following API call returns the first 10 files from the /Text files folder in your Dropbox account:

URL:

/2/files/list_folder

Body:

{  
"path": "/Text files",  
"limit": 10,  
"recursive": false,  
"include_deleted": false  
}

Matches of the search can be found in the module's Output under Bundle > Body > entries.

In our example, 10 tickets were returned:

Common problems¶

Unable to upload or update a file¶

There are several situations when uploading or updating a file fails:

The uploaded file is too big and exceeds the maximum file size allowed for your Dropbox plan or you have used all of your Dropbox account's storage quota. You will either need to delete existing files from your Dropbox account or upgrade your plan.
The previously selected folder, to which the file is being uploaded to, no longer exists. The scenario gets stopped and you will need to select the target folder again.

Image referenced via a shared link does not render¶

The URL returned by the Dropbox > Create a shared link does not link directly to an image, but to a Dropbox page - see https://www.dropbox.com/help/desktop-web/force-download for further details. To force the image to download, replace the trailing ?dl=0 with ?dl=1. To force the image to render (e.g. in a Web browser or in Facebook Messenger), append &raw=1 to the URL.

If you need to get the direct/raw link of your image which you can use for your website or for other Ibexa Connect modules you need to modify the initial shared URL in the following way:

Let's say your initial URL is:

https://www.dropbox.com/s/ia8qtvs20f3a5ux/Screen%20Shot%202018-10-15%20at%204.21.11%20PM.png?dl=0

1. replace www with dl

2. remove ?dl=0

Your final URL should be:

https://dl.dropbox.com/s/ia8qtvs20f3a5ux/Screen%20Shot%202018-10-15%20at%204.21.11%20PM.png

To do it automatically, use the replace() function twice:

to replace www with dl

and

to remove ?dl=0

To do it in one step, combine these functions:

You can use this code. Just copy it and paste it into the field and replace variable with the URL.

Dropbox¶

Getting Started with Dropbox¶

Connecting Dropbox to Ibexa Connect¶

Trigger Files¶

Watch Files¶

Get Files/Folders¶

Search Files/Folders¶

Get a File¶

Get a Folder Metadata¶

List All Files/Subfolders in a Folder¶

List File Revisions¶

Create & Edit File/Folder¶

Upload a File¶

Create a Folder¶

Create/Overwrite a Text File¶

Create a Share Link¶

Restore a File¶

Move a File/Folder¶

Rename a File/Folder¶

Delete a File/Folder¶

Make an API Call¶

Example of Use - List From the Folder¶

Common problems¶

Unable to upload or update a file¶

Image referenced via a shared link does not render¶