Prerequisites

  • To use Dropbox modules, you must have a Dropbox account.
IMPORTANT
Dropbox must approve applications with more than 50 users.
For more information, search for “Production approval” in the Dropbox developer guide.

Dropbox API information

The Dropbox connector uses the following:

Base URLhttps://api.dropboxapi.com/2
API version2
API tag
  • Dropbox

    v5.3.9

  • Dropbox Business

    v1.0.12

Create a connection to Dropbox

To create a connection for your Dropbox modules:

  1. In any module, click Add next to the Connection box.

  2. Fill in the following fields:

    Connection nameEnter a name for this connection.
    EnvironmentSelect whether this connection is for a production or non-production environment.
    TypeSelect whether you are connecting to a service account or a personal account.
    Client IDEnter your Dropbox Client ID.
    Client SecretEnter your Dropbox Client Secret.
    Account TypeSelect whether you are connecting to a personal Dropbox account or a business (Dropbox Business) account.
    Exclude dropbox-api-path-root headerEnable this option to exclude dropbox-api-path-root header for Dropbox Apps with App Folder access
  3. Click Continue to save the connection and return to the module.## Dropbox modules and their fields

Dropbox modules and their fields

When you configure Dropbox modules, Workfront Fusion displays the fields listed below. Along with these, additional Dropbox fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.

Map toggle

Trigger modules

Watch Files

This Trigger type module returns file details when the file in a specified folder is modified.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
FolderSelect the folder you want to watch for changes.
Watch also subfoldersEnable this option to also monitor subfolders in the selected folder for modified files.
LimitEnter or map the maximum number of records you want the module to return during each scenario execution cycle.

Modules for getting Dropbox files and folders

Download a File

This action module downloads a file from a folder.

You specify the file and its location.

The module returns the ID of the file and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

NOTE
This module is useful for providing files to subsequent modules.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map the file path or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

Get a Folder Metadata

This action module retrieves shared folder details.

You specify the ID of the folder.

The module returns the ID of the folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Shared Folder IDEnter or map the ID of the folder you want to retrieve details about.

List All Files/Subfolders in a Folder

This action module lists files or folders in a particular folder.

You specify the ID of the folder.

The module returns the IDs of the files or foldes and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
ListSelect whether you want to retrieve files or folders.
Show Only Downloadable FilesEnable this option to return only downloadable files. Some types of files, such as Google Docs, are not downloadable.
FolderEnter or map the folder you want to retrieve files or folders from.
LimitEnter or map the maximum number of records you want the module to list during each scenario execution cycle.

List File Revisions

This action module retrieves all file revisions (a version history) of a particular file.
You specify the ID of the file.

The module returns any standard fields associated with the record, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map the file path or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

LimitEnter or map the maximum number of records you want the module to list during each scenario execution cycle.

Search Files/Folders

This search module looks for records in an object in Dropbox that match the search query you specify.

You can map this information in subsequent modules in the scenario.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
SearchEnter the search term.
FolderSelect the folder you want to search. This module searches the entire Dropboxaccount if you do not select a folder.
File StatusSelect the file status That you want to include in the search.
File CategoriesSelect the file categories that you want to include in the search.
File extensionsFor each file extension that you want to include in the search, click Add item and enter or map the file extension.
LimitEnter or map the maximum number of records you want the module to return during each scenario execution cycle.

Modules for creating and editing Dropbox files and folders

Create a Folder

This action module creates a new folder.

You specify the path and a name for the folder.

The module returns the ID of the folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Folder NameEnter the name for the new folder.
Folder

Enter or map the path where you want to create a new folder.

Note:

If you are using a Dropbox Business account (with team spaces), you must remove the slash /, or do not click Click here to choose folder to create a team folder in the root.

If the slash is not removed an error [409] path/malformed_path/.. is returned.

Auto renameEnable this option to rename the new folder, if a folder with the same name already exists in the target location.

Create/Overwrite a Text File

This action module creates a DOC file, or overwrites the content of an existing one.

You specify the source file and the folder.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Select to

Select whether you want to create or overwrite a DOC file.

  • Create Select the folder where you want to create a file.

  • Overwrite

    Select how you want to choose the file to overwrite, then map the file path or select the file.

Source File

Select a source file from a previous module, or map the source file's content.

If you are creating a file, select Empty.

This action module creates a public link to a file.

You specify the file and information about the link.

The module returns the ID of the link and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map or enter the file path, or select the file manually.
File Path / File

File Path

Enter or map the path to the target file.

File

Select the target file.

Requested Visibility

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

Note:

Team only is available only to Dropbox Business accounts. Access with password is only available to Dropbox Pro or Dropbox Business accounts.

Link's Expiration DateEnter the date and time when the link will expire and will be no longer accessible. If this field is left empty, the link will not expire. For a list of supported date and time formats, see Type coercion.
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. This access level is available only for cloud-based documents.

  • Max

    Users who use the link receive the maximum access level you can set the link to.

Delete a File/Folder

This action module deletes a file or folder.

You specify the file or folder.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map or enter the file path, or select the file manually.
File or Folder Path / File or Folder

File/Folder Path

Enter or map the target path to the file or folder.

File/Folder

Select the file or folder from the menu.

Move a File/Folder

This action module moves a file or folder to a different location.

You specify the file or folder and how and where you ant to move it.

The module returns the ID of the file or folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting files / foldersSelect whether you want to map or enter the file or folder path, or select the file or folder manually.
File / Folder Path /

File/Folder Path

Enter or map the target path to the file or folder.

File/Folder

Select whether you are moving a file or folder, then the file or folder.

To FolderEnter or map the target location for the file or folder.
New NameEnter the new name for the file or folder in the new location.
Auto RenameEnable this option to ensure that if a file or folder with the same name exists, the module renames the new file or folder by adding (NUMBER) after the file or folder name. Otherwise the file or folder in the target location is overwritten.
Allow ownership transferEnable 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

This action module renames a file or folder.

You specify the file or folder and the new name.

The module returns the ID of the file or folder and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map or enter the file path, or select the file manually.
File/Folder Path / File/Folder

File/Folder Path

Enter or map the target path to the file or folder.

File/Folder

Select whether you are moving a file or folder, then the file or folder.

RenameEnter the new name for the file, including the file extension.

Restore a File

This action module restores a previous version of a file.

You specify the file and the number of the revision you want.

The module returns the ID of the version and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

ConnectionFor instructions about connecting your Dropbox account to Workfront Fusion, see Create a connection to Dropbox in this article.
Way of selecting filesSelect whether you want to map or enter the file path, or select the file manually.
File Path / File

File Path

Enter or map the target path to the file.

File

Select the file from the menu.

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