← Dropbox

Upload a File with Dropbox API

Pipedream makes it easy to connect APIs for Dropbox and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Upload a File with the Dropbox API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Upload a File with the Dropbox API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Upload a File action
    1. Connect your Dropbox account
    2. Select a Path
    3. Configure File Name
    4. Optional- Configure File URL
    5. Optional- Configure File Path
    6. Optional- Configure Autorename
    7. Optional- Configure Mute
    8. Optional- Configure Strict Conflict
    9. Optional- Select a Mode
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Upload a File with Dropbox API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Dropbox
 
Try it
Upload a File with Dropbox API on New Item in Feed from RSS API
RSS + Dropbox
 
Try it
Upload a File with Dropbox API on New Message in Channel from Discord Bot API
Discord Bot + Dropbox
 
Try it
Upload a File with Dropbox API on New Submission from Typeform API
Typeform + Dropbox
 
Try it
Upload a File with Dropbox API on Custom Events from Zoom API
Zoom + Dropbox
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Upload a File on Dropbox
Description:Uploads a file to a selected folder. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesUpload__anchor)
Version:0.0.13
Key:dropbox-upload-file

Code

import dropbox from "../../dropbox.app.mjs";
import consts from "../../common/consts.mjs";
import fs from "fs";
import got from "got";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Upload a File",
  description: "Uploads a file to a selected folder. [See the documentation](https://dropbox.github.io/dropbox-sdk-js/Dropbox.html#filesUpload__anchor)",
  key: "dropbox-upload-file",
  version: "0.0.13",
  type: "action",
  props: {
    dropbox,
    path: {
      propDefinition: [
        dropbox,
        "path",
        () => ({
          filter: ({ metadata: { metadata: { [".tag"]: type } } }) => type === "folder",
        }),
      ],
      description: "Type the folder name to search for it in the user's Dropbox. If not filled, it will be created in the root folder.",
    },
    name: {
      type: "string",
      label: "File Name",
      description: "The name of your new file (make sure to include the file extension).",
    },
    fileUrl: {
      type: "string",
      label: "File URL",
      description: "The URL of the file you want to upload to Dropbox. Must specify either File URL or File Path.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The path to the file, e.g. /tmp/myFile.csv . Must specify either File URL or File Path.",
      optional: true,
    },
    autorename: {
      type: "boolean",
      label: "Autorename",
      description: "If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.",
      optional: true,
    },
    mute: {
      type: "boolean",
      label: "Mute",
      description: "Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If `true`, this will not result in a user notification.",
      optional: true,
    },
    strictConflict: {
      type: "boolean",
      label: "Strict Conflict",
      description: "Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given \"rev\" doesn't match the existing file's \"rev\", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.",
      optional: true,
    },
    mode: {
      type: "string",
      label: "Mode",
      description: "Selects what to do if the file already exists.",
      options: consts.UPLOAD_FILE_MODE_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      fileUrl,
      filePath,
      path,
      name,
      autorename,
      mute,
      strictConflict,
      mode,
      clientModified,
    } = this;

    if (!fileUrl && !filePath) {
      throw new ConfigurationError("Must specify either File URL or File Path.");
    }

    const contents = fileUrl
      ? await got.stream(fileUrl)
      : fs.createReadStream(filePath);

    let normalizedPath = this.dropbox.getNormalizedPath(path, true);

    const res = await this.dropbox.uploadFile({
      contents,
      autorename,
      path: normalizedPath + name,
      mode: mode
        ? {
          ".tag": mode,
        }
        : undefined,
      client_modified: clientModified,
      mute,
      strict_conflict: strictConflict,
    });
    $.export("$summary", `File successfully uploaded to "${path?.label || path}"`);
    return res;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
DropboxdropboxappThis component uses the Dropbox app.
PathpathstringSelect a value from the drop down menu.
File Namenamestring

The name of your new file (make sure to include the file extension).

File URLfileUrlstring

The URL of the file you want to upload to Dropbox. Must specify either File URL or File Path.

File PathfilePathstring

The path to the file, e.g. /tmp/myFile.csv . Must specify either File URL or File Path.

Autorenameautorenameboolean

If there's a conflict, have Dropbox try to autorename the folder to avoid the conflict.

Mutemuteboolean

Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this will not result in a user notification.

Strict ConflictstrictConflictboolean

Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

ModemodestringSelect a value from the drop down menu:addoverwriteupdate

Authentication

Dropbox uses OAuth authentication. When you connect your Dropbox account, Pipedream will open a popup window where you can sign into Dropbox and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Dropbox API.

Pipedream requests the following authorization scopes when you connect your account:

About Dropbox

Dropbox gives you secure access to all your files. Collaborate with friends, family, and coworkers from any device.

More Ways to Use Dropbox

Triggers

New File from the Dropbox API

Emit new event when a new file is added to your account or a specific folder. Make sure the number of files/folders in the watched folder does not exceed 4000.

 
Try it
New Folder from the Dropbox API

Emit new event when a new folder is created. Make sure the number of files/folders in the watched folder does not exceed 4000.

 
Try it
New or Modified File or Folder from the Dropbox API

Emit new event when a file or folder is added or modified. Make sure the number of files/folders in the watched folder does not exceed 4000.

 
Try it

Actions

Create a Text File with the Dropbox API

Creates a brand new text file from plain text content you specify. See the documentation

 
Try it
Create folder with the Dropbox API

Create a Folder. See the documentation

 
Try it
Create or Append to a Text File with the Dropbox API

Adds a new line to an existing text file, or creates a file if it doesn't exist. See the documentation

 
Try it
Create/Update a Share Link with the Dropbox API

Creates or updates a public share link to the file or folder (It allows you to share the file or folder with anyone). See the documentation

 
Try it
Delete a File/Folder with the Dropbox API

Permanently removes a file/folder from the server. See documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.