Skip to main content

Box Actions Destination Step - Designer Web

Box Actions Destination Step explained.

Written by Praise Magidi

The Box Actions Destination step is used to execute files to Box. A Box account is required for this step to work. In addition, a connection to Box needs to be created.

The technical diagram below illustrates the data flow when a record is sent to a Box Actions Destination step.

Creating a Box Connection

A connection to Box must be created on Synatic before a step can be used. Follow the instructions below to create a Box connection:

1. Click on the Connection Tab in the Menu bar (1) and then click on the plus button (2) to access the available connections.

2. Select the Box Connection (3) from the list or use the search bar to look for it.

3. Provide a name in the Connection Name section.

4. Select the Oauth 2.0 Connection Type and click on the Logon to box button. It will redirect to the box page where the required credentials will be entered.

5. Once credentials are entered, click on the Grant Access to Box button to set the Oath Token on the connection.

6. There is an option to fill in the Commonly Accessed Folders section to cache folders that can be accessed quickly from Box. Provide the Folder Name, Folder ID and the Parent Folder ID.

7. Click the Save button to save the connection.


Adding a Box Actions Destination Step

To add a Box Actions Destination step in a flow, follow the instructions below:

1. Click on the plus icon as shown in the image below.

2. The page below will appear. Click on the Destination tab and select or search for Box as shown in the image below.


Configuring a Box Actions Destination Step

Illustrated in the image below is the configuration that is available in the Box Actions Destination step.

Select an existing connection by clicking on the dropdown arrow as shown in the image above.

Action – The different actions that can be performed. Each action has its own configuration, which will be explained below.

  • Create Path – Create a new path after a run is processed. The Path field is where to provide the path/folder to be created.

  • Delete Path – Delete a new folder or file after a run is processed. The Path field is where to provide the path/folder to be deleted. The Recursive checkbox will delete everything in that path every time a run is processed when selected.

  • Delete File – Delete a specific file after a run is processed. The Path field is where to provide the path/folder to be deleted.

  • Move File – Move a file from one path to another after a run is processed. The From Path field is where the file is being moved from. The To Path field is where the file is being moved to. The Create Path checkbox will create a new path automatically when selected. The Overwrite checkbox will overwrite the file if it exists in the path already.

  • Copy File – Copy a file from one path to another after a run is processed. The From Path field is where the file is being moved from. The To Path field is where the file is being moved to. The Create Path checkbox will create a new path automatically when selected. The Overwrite checkbox will overwrite the file if it exists in the path already.

  • Create Folder – Create a new folder after a run is processed. The Parent Folder ID is where to create the new folder (Default is 0). Provide the folder name in the Name field.

  • Update Folder – Update an existing folder. This can also be used to move the folder, create shared links, update collaborations, and more. Provide the Folder ID of the folder to be updated. Type the updated folder request body in JSON format in the Body field.

  • Set Tags – Set file tags. These tags are shown in the Box web app and mobile apps next to an item. The Parent Folder ID is where to create the new folder (Default is 0). Provide the path and set the tags in the respective fields.

For more information on the Action, click on the link below:


Using a Box Actions Destination Step

To use a Box Actions Destination step, follow the instructions below:

1. Click the Execute Flow button shown in the image below.

2. Click the Create Run button.

Did this answer your question?