Jump to a Section

Overview

The first time you add a Box card to a FLO, you will need to create a configuration. This will allow you to connect to your account, save your account information, and reuse that configuration next time you build a FLO with the connector. That way, you don’t have to sign in every time you want to build a FLO with this Connector. Instead, use the configuration you have already set up. You can create and save multiple configurations and share them with your teammates.

Here’s how to set up a new configuration in Box:

  1. First, enter in an Account Nickname. This should be unique so if you are connecting multiple Box accounts you will be able to tell them apart.
  2. Then click “Create” to launch a pop-up window where you will sign into your Box Account. This will also save your configuration.

    Events

    • File Created

      This card monitors entire root folder and any of its sub folder whether a new file has been uploaded.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event.
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • File
        • File ID (text): the unique identifier of the created file.
        • File Name (text): name of the file that was created.
        • File Description (text): description of the file that was created.
        • Version ID (text): the version ID of the created file (versions only tracked for Box users with premium accounts).
        • Version Tag (text): the version tag of the created file (versions only tracked for Box users with premium accounts).
        • Sequence ID (text): unique identifier for use with events endpoint.
        • SHA1 Hash (text): the SHA-1 hash of this file.
        • Size (text): the size of the file.
        • Path (text): path to the file (e.g., /pictures/2016/4/…).
        • Time Created (text): time that the file was created in Box.
        • Time Content Created (text): time that the file was created in general.
        • Parent Folder Name (text): the name of the file’s parent folder.
        • Parent Folder ID (text): the unique identifier of the file’s parent folder.
        • Item Status (text): the status of the item (can be active, trashed, or deleted)
      • Created By 
        • Name (text): the name of the user who created the file.
        • User ID (text): the unique identifier of the user who created the file.
        • Email (text): the email of the user who created the file.
      • Owned By 
        • Name (text): the name of the user who owns the file.
        • User ID (text): the unique identifier of the user who owns the file.
        • Email (text): the email of the user who owns the file.
      • Context
        • Execution ID (text): the unique identifier associated with the execution of the FLO.
    • File Created in Folder

      This card monitors a specified folder and its subfolder, if a file / files has been uploaded to any of these folder, the card will start the FLO.

      Option Fields

      • Folded ID (text) : The unique identifier of a folder. These can be found in the url. For example if the url is app.box.com/folder/62245130358 the id is 62245130358.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event.
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • File
        • File ID (text): the unique identifier of the created file.
        • File Name (text): name of the file that was created.
        • File Description (text): description of the file that was created.
        • Version ID (text): the version ID of the created file (versions only tracked for Box users with premium accounts).
        • Version Tag (text): the version tag of the created file (versions only tracked for Box users with premium accounts).
        • Sequence ID (text): unique identifier for use with events endpoint.
        • SHA1 Hash (text): the SHA-1 hash of this file.
        • Size (text): the size of the file.
        • Path (text): path to the file (e.g., /pictures/2016/4/…).
        • Time Created (text): time that the file was created in Box.
        • Time Content Created (text): time that the file was created in general.
        • Parent Folder Name (text): the name of the file’s parent folder.
        • Parent Folder ID (text): the unique identifier of the file’s parent folder.
        • Item Status (text): the status of the item (can be active, trashed, or deleted)
      • Created By 
        • Name (text): the name of the user who created the file.
        • User ID (text): the unique identifier of the user who created the file.
        • Email (text): the email of the user who created the file.
      • Owned By 
        • Name (text): the name of the user who owns the file.
        • User ID (text): the unique identifier of the user who owns the file.
        • Email (text): the email of the user who owns the file.
      • Context
        • Execution ID (text): the unique identifier associated with the execution of the FLO.
    • File Updated

      Monitors a Box folder for when a file is updated.

      Options

      • Folder ID (text): the unique identifier of the folder to be monitored (e.g. 11209361018) Or enter in ‘0’ for the root folder.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • File
        • File ID (text): the unique identifier of the created file
        • File Name (text): name of the file that was created
        • File Description (text): description of the file that was created
        • Version ID (text): the version ID of the created file (versions only tracked for Box users with premium accounts)
        • Version Tag (text): the version tag of the created file (versions only tracked for Box users with premium accounts)
        • Sequence ID (text): unique identifier for use with events endpoint
        • SHA1 Hash (text): the SHA-1 hash of this file
        • Size (text): the size of the file
        • Path (text): path to the file (e.g., /pictures/2016/4/…)
        • Time Created (text): time that the file was created in Box
        • Time Content Created (text): time that the file was created in general
        • Parent Folder Name (text): the name of the file’s parent folder
        • Parent Folder ID (text): the unique identifier of the file’s parent folder
        • Item Status (text): the status of the item (can be active, trashed, or deleted)
      • Share Link
        • Share URL(text): The URL to view the file.
        • Download URL(text): The URL to download the file
        • Vanity URL(text): The vanity URL. (i.e. “go.site.com/winterpromo”).
        • Password Enabled(text): If the shared link has a password.
        • Time Unshared(text): The time the link became unshared.
        • Download Count(text): How many times the link was downloaded.
        • Access Level(text): The access level of the share link (ie can edit, view, etc.)
        • Can Download(text): If you can download the link contents.
        • Can Preview(text): If you can preview the link contents.
      • Created By
        • Name (text): the name of the user who created the file
        • User ID (text): the unique identifier of the user who created the file
        • Email (text): the email of the user who created the file
      • Owned By
        • Name (text): the name of the user who owns the file
        • User ID (text): the unique identifier of the user who owns the file
        • Email (text): the email of the user who owns the file
      • Context
        • Execution ID (text): the unique identifier associated with the execution of the FLO
    • Folder Created

      Triggers a FLO when a new folder is created in Box.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • Folder
        • Folder ID (text): The ID of the new folder
        • Name (text): the name of the folder
        • Description (text): the description of the folder
        • Version Tag (text): the version tag of the folder (versions only tracked for Box users with premium accounts)
        • Sequence ID (text): unique identifier of the folder for use with events endpoint
        • Size (text): the size of the folder
        • Path (list of text): path to the folder (e.g., /pictures/2016/4/…)
        • Time Created (text): time that the folder was created
        • Time Content Created (text): most recent time that content in the folder was created
        • Folder Upload Email (text): email that files can be sent to in order to upload to this folder
        • Parent Folder Name (text): the name of the folder’s parent folder
        • Parent Folder ID (text): the unique identifier of the folder’s parent folder
        • Item Status (text): the status of the folder (can be active, trashed, or deleted)
      • Created By
        • Name (text): the name of the user who created the folder
        • User ID (text): the unique identifier of the user who created the folder
        • Email (text): the email of the user who created the folder
      • Modified By
        • Name (text): the name of the user who most recently modified the folder
        • User ID (text): the unique identifier of the user who most recently modified the folder
        • Email (text): the email of the user who most recently modified the folder
      • Owned By
        • Name (text): the name of the user who owns the folder
        • User ID (text): the unique identifier of the user who owns the folder
        • Email (text): the email of the user who owns the folder
      • Context
        • Execution ID (text): the unique identifier associated with the execution of the FLO
    • Folder Updated

      Triggers a FLO when a folder is updated in Box.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • Folder
        • Folder ID (text): The ID of the folder
        • Name (text): the name of the folder
        • Description (text): the description of the folder
        • Version Tag (text): the version tag of the folder (versions only tracked for Box users with premium accounts)
        • Sequence ID (text): unique identifier of the folder for use with events endpoint
        • Size (text): the size of the folder
        • Path (list of text): path to the folder (e.g., /pictures/2016/4/…)
        • Time Created (text): time that the folder was created
        • Time Modified (text): When the folder was modified.
        • Time Trashed (text): When (if) the folder was trashed.
        • Time Purged (text): When  (if) the folder was purged (deleted permanently)
        • Time Content Created (text): most recent time that content in the folder was created
        • Time Content Modified (text): The time the content of the folder was modified
        • Folder Upload Email (text): email that files can be sent to in order to upload to this folder
        • Parent Folder Name (text): the name of the folder’s parent folder
        • Parent Folder ID (text): the unique identifier of the folder’s parent folder
        • Item Status (text): the status of the folder (can be active, trashed, or deleted)
      • Share Link
        • Share URL (text): the url for sharing the folder
        • Download URL (text): the url for downloading the folder
        • Vanity URL (text): the vanity version of the folder’s url
        • Password Enabled (text): whether or not the folder is password protected
        • Time Unshared (text): how long since the folder has been shared
        • Download Count (text): how many times the folder has been downloaded
        • Access Level (text): the access level granted by the share link
        • Can Download (text): whether or not the folder can be downloaded from the share link
        • Can Preview (text): whether or not contents can be previewed from the share link
      • Created By
        • Name (text): the name of the user who created the folder
        • User ID (text): the unique identifier of the user who created the folder
        • Email (text): the email of the user who created the folder
      • Modified By
        • Name (text): the name of the user who most recently modified the folder
        • User ID (text): the unique identifier of the user who most recently modified the folder
        • Email (text): the email of the user who most recently modified the folder
      • Owned By
        • Name (text): the name of the user who owns the folder
        • User ID (text): the unique identifier of the user who owns the folder
        • Email (text): the email of the user who owns the folder
      • Context
        • Execution ID (text): the unique identifier associated with the execution of the FLO
    • New Comment

      Triggers a FLO when a new comment is created in Box.

      Output Fields

      • Event
        • Event ID (text): the unique identifier of the event
        • Event Type (text): the type of event this file was created through (e.g. ITEM_UPLOAD)
      • File
        • File ID (text): The ID of an attached file.
      • Comment
        • Comment ID (text): The ID of the comment.
        • Message(text): The content of the message.
        • Reply Comment(text): The reply comment (if any).
        • Time Created(text): The time the comment was created.
        • Time Modified(text): The time the comment was most recently modified.
      • Created by
        • Name (text): The name of the user who created the comment.
        • User ID (text): The ID of the user who created the comment.
        • Email (text): The email of the user who created the comment.
    • New Task

      Triggers a FLO when a new task is created in Box.

      Output Field

      • Task
        • Task ID (text): The ID of the task.
        • Task Description(text): A description of the task.
        • Action(text): The action of the task.
        • Due Date(text): When the task is due.
        • Time Created(text): When the task was created.
      • File
        • File ID(text): ID for an attached file.
        • File Name(text): Name of the attached file.
      • Created By
        • Name(text): Name of the user who created the task.
        • User ID(text): The ID of the user who created the task.
        • Email(text): The email of the user who created the task.
      • Assigned to
        • Name(text): The name of the user the task is assigned to.
        • User ID(text): The ID of the user the task is assigned to.
        • Email(text): The email of the user the task is assigned to.
      • Context
        • Execution ID(text): The ID of the execution of the FLO running.
    • New Task Assignment

      Triggers a FLO when a new task is created in Box.

      Output Field

      • Task
        • Task Assignment ID (text): The ID of the task assignment
        • File ID (text): ID for an attached file.
        • File Name (text): Name of the attached file.
        • Message (text): The message attached to the task assignment.
        • Time Assigned (text): The time the task was assigned.
        • Time Created (text): When the task assignment was created.
        • Resolution State (text): Can be ‘completed’, ‘incomplete’, ‘approved’, or ‘rejected’.
      • Assigned to
        • Name (text): The name of the user the task is assigned to.
        • User ID (text): The ID of the user the task is assigned to.
        • Email (text): The email of the user the task is assigned to.
      • Assigned By
        • Name (text): Name of the user who assigned the task.
        • User ID (text): The ID of the user who assigned the task.
        • Email (text): The email of the user who assigned the task.
      • Context
        • Execution ID (text): The ID of the execution of the FLO running.

    Actions

    • Add Comment to File

      Add a comment to any of the files in Box based on the file’s ID.

      Input Fields

      • Comment
        • File ID (text): the unique identifier of the file to add a comment to (e.g. 11209361018)
        • Message (text): the text of the comment
        • Tagged Message (text): the text of the comment when tagging someone as @[userid:Username] in your message, only use when tagging another user

      Output Fields

      • Comment
        • Comment ID (text): the unique identifier of the newly added comment
        • Time Created (text): time that the comment was created (e.g. 2012-12-12T11:25:01-08:00)
    • Add Task to File

      Attach a task with a due date to a file.

      Input

      • Task
        • File ID (text): ID of the file to add a task to.
        • Message (text): Message about the task.
        • Due Date (text): Due date for the task.

      Output

      • Task
        • Task ID (text): ID of the newly made task.
        • Time Created (text): The time that the task was created.
    • Assign Task

      Assigns a task to a user.

      Input

      • Task Assignment
        • Task ID (text): The ID of the task. This can be dragged from the create task card.
        • Assign to ID (text): An ID to assign the task to.
        • Assign to Email (text): An email to assign the task to.

      Output

      • Task Assignment
        • Task Assignment ID (text): The ID of the task’s assignment.
        • Time Assigned (text): The time the task was assigned.
    • Copy Folder

      Copies a folder and its contents using the folder ID.

      Input

      • Folder ID (required - text): ID of the folder to be copied
      • Destination Folder ID (required - text): ID of the destination folder
      • New Name (text): an optional new name for the folder

      Output

      • Folder ID (text): ID of the newly created folder
      • Path (text):Path of the newly created folder
    • Create Folder

      Create a folder using input fields.

    • Create Share Link

      Create a share link for an item.

      Input

      • Item
        • ID (text): The unique identifier of the file or folder to read info from (e.g. 11209361018)
      • Share Link
        • Access (text): Accessibility status of the file, for example, “open.”
        • Date Unshared (text): The desired expiration date.
        • Password (text):Set the password for the link.
        • Can Download (text): Set download status
        • Can Preview (text): Indicate whether downloading is optional.

      Output

      • Share Link
        • Share URL (text): The link for sharing.
        • Download URL (text): The link for downloading.
    • Custom API Action

      This action allows you to make a custom, authenticated HTTP call to the Box 2.0 API.

      NOTE: This is not like any of the other Box cards; it may help if you refer to the documentation.

      Options

      • Request Type (dropdown): your available HTTP request methods. There are 5 supported HTTP request methods (sometimes called verbs) in custom API calls:

        • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

        • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. If a POST is successful, you will receive a 200 OK response message. Additional documentation here.

        • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Additional documentation here.

        • PATCH: applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that the result of multiple PATCH’s could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Additional documentation here.

        • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Additional documentation here.

      Input Data

      • Relative URL (text): the address on the web server you are attempting to interact with. Relative URL means that you don’t have to explicitly specify the protocol at the beginning of the URL (such as “http://“). This suggests to the web server that the interaction is occurring on the server (in this instance).

        Example: /user/me
      • Query (object or text): JSON object that determines the action taken at the URL.

        Example: {"name":"something-urgent"}
      • Headers (object): JSON that determines the content type of the request. This will usually be a replica of the example below.

        Example: {"Content-type":"application/json"}

      Output Data

      • Status Code (Number): the success or failure of your HTTP request. Here is a list of all status codes.

      • Headers (object): a more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.

      The response headers are dependent on the HTTP request you choose in options.

      • Body (object): depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.
    • Delete File

      Deletes a file using it’s ID.

      Input

      • File
        • File ID (text): The unique identifier of the folder to read info from (e.g. 11209361018)
    • Delete Folder

      Deletes a folder using its ID.

      Input

      • Folder
        • Folder ID (text): The unique identifier of the folder to read info from (e.g. 11209361018)
    • Download File

      Download the contents of a file using the file ID.

      Input Fields

      • File
        • File ID (text): the unique identifier of the file to be downloaded

      Output Fields

      • File
        • File Content (File): a reference to the downloaded file in the file system
    • Read All Files In Folder

      Return a list of File Id and File Name pairs given a Folder ID.

      Options

      • Folder ID (text): The unique identifier of the folder to return file ID and Name pairs (Eg. “File ID”: “1234567890”). Enter 0 to get results from root folder. One way to get a Folder ID is by using the Create Folder card.

      Output Fields

      • Result
        • Files (list)
          • File ID (text) ID of file in folder.
          • File Name (text) Name of file in folder.
    • Read File Info

      This card returns many fields of information about a file which can be dragged to other cards for reference.

      Input

      • File
        • File ID (text): The unique identifier of the folder to read info from (e.g. 11209361018)

      Output

      • File 
        • File Name (text): The name of the file.
        • File Extension (text): The type of file, for example, png or jpg with no “.”
        • File Description (text): The description of the file.
        • Version ID (text): Optional file version ID that is a copy of the file at a specific point in time.
        • Version Tag (text): The entity of this file object.
        • Sequence ID (text): The unique ID for use with the /events endpoint. May be null for some folders, such as root or trash.
        • Size (text): The folder size in bytes. Be careful parsing this integer, it can easily go into EE notation: see IEEE754 format.
        • Path (text): The path that designates the key, in the format of a JSON-Pointer. Since all keys are located at the root of the metadata instance, the key must be prefixed with a /. Special characters ~ and / in the key must be escaped according to JSON-Pointer specification. The value at the path must exist for the operation to be successful.
        • Time Created (text): The time the file was created.
        • Time Modified (text): The time the file was modified.
        • Time Trashed (text): The time the file was trashed.
        • Time Purged (text): The time the file was purged.
        • Time Content Created (text): The content of the file was created.
        • Time Content Modified (text): The content of the file was modified.
        • Parent Folder Name (text): The parent folder name.
        • Parent Folder ID (text): The ID of the parent folder.
        • Item Status (text): The status of the folder (can be active, trashed, or deleted)
        • Tags (list of text): The list of the tags on this folder
      • Share Link
        • Share URL (text): TheURLl for sharing the folder
        • Download URL (text): TheURLl for downloading the folder
        • Vanity URL (text): The vanity version of the folder’s URL
        • Password Enabled (text): Whether or not the folder is password protected
        • Time Unshared (text): How long since the folder has been shared
        • Download Count (text): How many times the folder has been downloaded
        • Access Level (text): The access level granted by the share link
        • Can Download (text): Whether or not the folder can be downloaded from the share link
        • Can Preview (text): Whether or not contents can be previewed from the share link
        • Allowed Link Access Level (text): The amount of access available for the link.
      • Created by
        • Name (text): Returns the name of the creator.
        • User ID (text): Returns the user ID of the creator.
        • Email (text): Returns the email of the creator.
      • Modified by
        • Name (text): Returns the name of the modifier.
        • User ID (text): Returns the user ID of the modifier.
        • Email _(text):  _Returns the email of the modifier.
      • Owned by
        • Name (text): Returns the name of the owner.
        • User ID (text): Returns the user ID of the owner.
        • Email (text): Returns the email of the owner.
    • Read Folder Info

      A card that returns all of the available information about a Folder based on the Folder’s ID.

      Input Fields

      • Folder
        • Folder ID (text): the unique identifier of the folder to read info from (e.g. 11209361018)

      Output Fields

      • Folder
        • Name (text): the name of the folder
        • Description (text): the description of the folder
        • Version Tag (text): the version tag of the folder (versions only tracked for Box users with premium accounts)
        • Sequence ID (text): unique identifier of the folder for use with events endpoint
        • Size (text): the size of the folder
        • Path (text): path to the folder (e.g., /pictures/2016/4/…)
        • Time Created (text): time that the folder was created
        • Time Modified (text): most recent time that the folder was modified
        • Time Trashed (text): time that the folder was trashed
        • Time Purged (text): most recent time that the folder was purged
        • Time Content Created (text): most recent time that content in the folder was created
        • Time Content Modified (text): most recent time that content in the folder was modified
        • Folder Upload Email (text): email that files can be sent to in order to upload to this folder
        • Parent Folder Name (text): the name of the folder’s parent folder
        • Parent Folder ID (text): the unique identifier of the folder’s parent folder
        • Item Status (text): the status of the folder (can be active, trashed, or deleted)
        • Sync State (text): the synchronization state of this folder
        • Tags (List): a list of the tags on this folder
      • Share Link
        • Share URL (text): the url for sharing the folder
        • Download URL (text): the url for downloading the folder
        • Vanity URL (text): the vanity version of the folder’s url
        • Password Enabled (text): whether or not the folder is password protected
        • Time Unshared (text): how long since the folder has been shared
        • Download Count (text): how many times the folder has been downloaded
        • Access Level (text): the access level granted by the share link
        • Can Download (text): whether or not the folder can be downloaded from the share link
        • Can Preview (text): whether or not contents can be previewed from the share link
      • Permissions
        • Can Non-Owners Invite (text): whether or not non-owners can send invites to this folder
        • Is Externally Owned (text): whether or not the folder is externally owned
        • Allowed Link Access Levels (List): user levels that are allowed share link access
        • Allowed Invitee Roles (List): roles that are allowed to invite
        • Has Collaborations (text): whether or not the folder allows collaborations
      • Created By
        • Name (text): the name of the user who created the folder
        • User ID (text): the unique identifier of the user who created the folder
        • Email (text): the email of the user who created the folder
      • Modified By
        • Name (text): the name of the user who most recently modified the folder
        • User ID (text): the unique identifier of the user who most recently modified the folder
        • Email (text): the email of the user who most recently modified the folder
      • Owned By
        • Name (text): the name of the user who owns the folder
        • User ID (text): the unique identifier of the user who owns the folder
        • Email (text): the email of the user who owns the folder
    • Search Folders

      Search folders using filters.

    • Update File Info

      Update information about a file.

      Input

      • Updated By
        • File ID (text): The unique identifier of the folder to read info from (e.g. 11209361018)
      • File
        • Name (text): The name of the file.
        • Description (text): The description of the file.
        • Parent Folder ID (text): The ID of the parent folder.
        • Tags (list of text): The list of the tags on this folder
    • Update Folder Info

      Updates the information about a folder.

      Input

      • Update By
        • Folder ID (text): The unique identifier of the folder to read info from (e.g. 11209361018)
      • Folder
        • Name (text): Name of the folder.
        • Description (text): Description of the folder.
        • Parent Folder ID (text): The unique identifier of the folder’s parent folder
        • Sync State (text): The synchronization state of this folder
        • Tags (list of text): A list of the tags on this folder
    • Update Task

      This card updates information about a task.

      Input

      • Task
        • File ID (text): ID of the file to add a task to.
        • Message (text): Message about the task.
        • Due Date (text): Due date for the task.
    • Update Task Assignment

      Update the assignment of a task.

      Input

      • Task Assignment
        • Task Assignment ID (text): The ID of the task. This can be dragged from the assign task card
        • Message (text): Message for updated task.
        • Resolution Status (text): Status of the task’s completion, for example, if the task was resolved the status would be “completed.”
    • Upload File

      Uploads a file into Box.

      Input Fields

      • File
        • Name (text): The name of the file.
        • Parent Folder ID (text): The ID of the folder where the file will be uploaded to.
        • File Content (file): The file content.

      Output Field

      • File ID (text): The ID of the file.