← Box

Upload a File with Box API

Pipedream makes it easy to connect APIs for Box and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Upload a File with the Box API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Upload a File with the Box 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 Box account
    2. Configure File
    3. Optional- Configure Created At
    4. Optional- Configure Modified At
    5. Optional- Configure File Name
    6. Optional- Select a Parent
  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 Box API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Box
 
Try it
Upload a File with Box API on New Message from Discord API
Discord + Box
 
Try it
Upload a File with Box API on New Message in Channel from Discord Bot API
Discord Bot + Box
 
Try it
Upload a File with Box API on New Submission from Typeform API
Typeform + Box
 
Try it
Upload a File with Box API on Custom Events from Zoom API
Zoom + Box
 
Try it

Details

This is a pre-built, open source 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 Box
Description:Uploads a small file to Box. [See the docs here](https://developer.box.com/reference/post-files-content/).
Version:0.0.1
Key:box-upload-file

Code

import app from "../../box.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import utils from "../../common/utils.mjs";

export default {
  name: "Upload a File",
  description: "Uploads a small file to Box. [See the docs here](https://developer.box.com/reference/post-files-content/).",
  key: "box-upload-file",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    file: {
      propDefinition: [
        app,
        "file",
      ],
    },
    createdAt: {
      propDefinition: [
        app,
        "createdAt",
      ],
    },
    modifiedAt: {
      propDefinition: [
        app,
        "modifiedAt",
      ],
    },
    fileName: {
      propDefinition: [
        app,
        "fileName",
      ],
    },
    parentId: {
      propDefinition: [
        app,
        "parentId",
      ],
    },
  },
  async run({ $ }) {
    const fileValidation = utils.isValidFile(this.file);
    if (!fileValidation) {
      throw new ConfigurationError("`file` must be a valid file path!");
    }
    const fileMeta = utils.getFileMeta(fileValidation);
    const fileContent = utils.getFileStream(fileValidation);
    const attributes = fileMeta.attributes;
    if (this.createdAt && utils.checkRFC3339(this.createdAt)) {
      attributes.content_created_at = this.createdAt;
    }
    if (this.modifiedAt && utils.checkRFC3339(this.modifiedAt)) {
      attributes.content_modified_at = this.modifiedAt;
    }
    if (this.fileName) {
      attributes.name = this.fileName;
    }
    if (this.parentId) {
      attributes.parent.id = this.parentId;
    }
    const data = new FormData();
    data.append("attributes", JSON.stringify(attributes));
    data.append("file", fileContent, {
      knownLength: fileMeta.size,
    });
    const response = await this.app.uploadFile({
      $,
      headers: {
        "Content-Type": `multipart/form-data; boundary=${data._boundary}`,
      },
      data,
    });
    $.export("$summary", `File with ID(${response?.entries[0]?.id}) successfully uploaded.`);
    return response;
  },
};

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
BoxappappThis component uses the Box app.
Filefilestring

The file to upload to Box, please provide a file from /tmp. To upload a file to /tmp folder, please follow the doc here

Created AtcreatedAtstring

Defines the time the file was originally created at. If not set, file's original upload time will be used. Must be in RFC3339 format without milliseconds, e.g. 2022-07-20T10:53:43-08:00

Modified AtmodifiedAtstring

Defines the time the file was last modified at. If not set, file's original modified time will be used. Must be in RFC3339 format without milliseconds, e.g. 2022-07-20T10:53:43-08:00

File NamefileNamestring

The name of the file. If not set, file's original name will be used.

ParentparentIdstringSelect a value from the drop down menu.

Authentication

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

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

About Box

Platform for secure content management, workflow, and collaboration

More Ways to Use Box

Triggers

New Event from the Box API

Emit new event when an event with subscribed event source triggered on a target, See the docs

 
Try it
New File Event from the Box API

Emit new event when a new file uploaded on a target, See the docs

 
Try it
New Folder Event from the Box API

Emit new event when a new folder created on a target, See the docs

 
Try it

Actions

Search Content with the Box API

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. See the docs here.

 
Try it