Skip to main content
First time creating a connector? Read this first.

Requirements

You will need:

Accounts

Resources

A Box Custom App (also called a Platform App) in your Box account, set up with the following:
  • One of the following authentication methods.
    • CCG (Client Credentials Grant / Server Authentication) You will need the following values:
      • The app’s Client ID and Client Secret
      • The Enterprise ID that the app is authorized against
      See Setup with Client Credentials Grant in the Box developer documentation.
    • JWT (Server Authentication with JWT) You will need the app’s private key configuration JSON file. To download the file:
      • In the Box Custom App, on the Configuration tab, under Add and Manage Public Keys, click Generate a Public/Private Keypair.
      • Store the downloaded private key configuration JSON file in a secure location.
      See Setup with JWT in the Box developer documentation.
  • The Write all files and folders stored in Box application scope: Without this scope, the connector can look up the destination folder but cannot upload files. To set the application scope in Box:
    • On the Configuration tab, under Application Scopes, check Write all files and folders stored in Box, and then click Save Changes.
  • Authorization from a Box Admin in your Box account. On Enterprise accounts, the app cannot authenticate until an admin approves it. On free developer accounts, Box authorizes the app automatically. See App Authorization in the Box developer documentation.
  • A collaboration that grants the Custom App’s Service Account either Editor or Co-owner access to the destination Box folder.
    • In the Box Custom App, on the General Settings tab, copy the Service Account ID. The Service Account ID is an email address in the form AutomationUser_<your-app-service-id>_<a-random-string>@boxdevedition.com.
    • Share the destination Box folder with this email address as a Co-owner or Editor. A Viewer role is not sufficient. The connector’s folder lookup succeeds, but the connector fails when it attempts to upload files.
    See Share Content with User in the Box developer documentation.
  • The destination Box folder’s numeric ID, taken from the folder’s Box URL, not its path or name. For example, in the URL app.box.com/folder/406887975915, the folder ID is 406887975915.

How Unstructured writes files to Box

  • Unstructured preserves your folder structure. If the source connector recurses through subfolders, the Box destination connector recreates the same subfolder structure under the configured destination folder.
  • Re-running a job updates files in place. If Unstructured processes the same source document again, the connector matches the existing file by name and uploads a new version. Scheduled re-syncs work this way.
  • Unstructured handles large files automatically. Files over 50 MB (the staged JSON output, not the original source file) use Box’s chunked upload. There is no size ceiling and nothing to configure.

Create the connector

To create the destination connector:
  1. On the sidebar, click Connectors, then Destinations.
  2. Click New or Create Connector.
  3. For Name, enter a unique name.
  4. In the Provider area, click Box, and then Continue.
  5. Follow the on-screen instructions to fill in the fields as described later on this page.
  6. Click Save and Test.
Fill in the following fields:
  • Name (required): A unique name for this connector.
  • Folder ID (required): The numeric ID of the destination Box folder, not its path or name. For example, in the URL app.box.com/folder/406887975915, the folder ID is 406887975915. You must add the Custom App’s Service Account to this folder as an Editor or Co-owner collaborator.
    • Authentication Method (required): The authentication method for the Box Custom App. Select one, then fill in its fields:
      • CCG (Client Credentials Grant):
        • Client ID: The Client ID of the Box Custom App.
        • Client Secret: The Client Secret of the Box Custom App.
        • Enterprise ID: The Box Enterprise ID that the app is authorized against.
      • JWT:
        • Box App Config: The contents of the private key configuration JSON file for your JWT Custom App.

Troubleshooting

Issue: When you try to create or save the connector, the folder ID value is rejected.Cause: This field requires the destination folder’s numeric ID, not its path or name.Solution: Get the numeric ID from the destination folder’s Box URL. For example, in app.box.com/folder/406887975915, the folder ID is 406887975915.
Issue: The connector’s connection test fails, even though the destination folder exists and the folder ID is correct.Cause: The Custom App’s Service Account has only viewer access to the destination folder. Viewer access passes the folder lookup but fails when the connector attempts to upload files.Solution: Check the Service Account’s collaboration role on the destination folder, and change it to editor or co-owner.
Issue: JWT authentication fails immediately after you supply the app config.Cause: The Box App Config field (box_app_config) only accepts the JSON on a single line, but Box’s downloaded configuration file is multi-line by default.Solution: Compact the JSON into a single-line string before pasting it. See Requirements for the commands.