Use Files Inside a Workflow
Retrieve a private uploaded file, include its bytes, read its text and save a repeatable workflow test.
Watch tutorial (4:39)
Retrieve a private uploaded file, include its bytes, read its text and save a repeatable workflow test.
Watch tutorial (4:39)Twidget offers a set of commands to manipulate files in your file store. Below are the descriptions and usage of each command to help you understand how to utilize them effectively.
For CSV, ZIP archives and temporary download links, see Advanced file commands.
Retrieve a file via file path.
Inputs:
path: The file path to retrieve the file from.
get_bytes (Include bytes): Request the actual file contents when a following command needs them. Bytes are not loaded automatically just because a path is present. Keep reads bounded and use an uploaded or explicitly read FILE value for image, spreadsheet, PDF and connector commands that require file contents.
Outputs:
filename: The name of the file.
path: The path of the file.
parent_path: The parent directory path.
file_size: The size of the file in bytes.
is_directory: Boolean indicating if it is a directory.
is_file: Boolean indicating if it is a file.
is_root: Boolean indicating if it is the root directory.
is_multi_part_file: Boolean indicating if it is a multi-part file.
bytes: File contents only when requested with Include bytes, subject to runtime file-size limits.
Copy a provided file to another file path.
Inputs:
file: The file you want to copy.
copy_path: The destination path where the file should be copied.
Outputs:
filename: The name of the file.
path: The path of the file.
parent_path: The parent directory path.
file_size: The size of the file in bytes.
is_directory: Boolean indicating if it is a directory.
is_file: Boolean indicating if it is a file.
is_root: Boolean indicating if it is the root directory.
is_multi_part_file: Boolean indicating if it is a multi-part file.
bytes: The bytes of the file.
Delete the provided file.
Inputs:
file: The file you want to delete.Outputs:
Get the size of a file.
Inputs:
file: The file whose size you want to retrieve.Outputs:
Get the parent path of the provided file.
Inputs:
file: The file whose parent path you want to retrieve.Outputs:
Get the parent file/folder of the provided file.
Inputs:
file: The file whose parent file/folder you want to retrieve.Outputs:
filename: The name of the file.
path: The path of the file.
parent_path: The parent directory path.
file_size: The size of the file in bytes.
is_directory: Boolean indicating if it is a directory.
is_file: Boolean indicating if it is a file.
is_root: Boolean indicating if it is the root directory.
is_multi_part_file: Boolean indicating if it is a multi-part file.
bytes: The bytes of the file.
List files in the specified folder.
Inputs:
file: The folder whose files you want to list.Outputs:
A list of files with fields:
filename: The name of the file.
path: The path of the file.
parent_path: The parent directory path.
file_size: The size of the file in bytes.
is_directory: Boolean indicating if it is a directory.
is_file: Boolean indicating if it is a file.
is_root: Boolean indicating if it is the root directory.
is_multi_part_file: Boolean indicating if it is a multi-part file.
bytes: The bytes of the file.
Create a new folder at the specified path.
Inputs:
path: The path where you want to create the new folder.Outputs:
Rename the specified file or folder.
Inputs:
file: The file or folder you want to rename.
path: The new name for the file or folder.
Outputs:
Write data to a file in the file store.
Inputs:
path: The path where you want to write the file.
data: The data to write to the file.
Outputs:
filename: The name of the file.
path: The path of the file.
parent_path: The parent directory path.
file_size: The size of the file in bytes.
is_directory: Boolean indicating if it is a directory.
is_file: Boolean indicating if it is a file.
is_root: Boolean indicating if it is the root directory.
is_multi_part_file: Boolean indicating if it is a multi-part file.
bytes: The bytes of the file.
Append data to a file in the file store.
Inputs:
file: The file to append the data to.
data: The data to append.
Outputs:
Read the text content of the specified file.
Inputs:
file: The file whose text content you want to read.Outputs:
Check if the provided file is a folder.
Inputs:
file: The file to check.Outputs:
Check if the provided file is a file.
Inputs:
file: The file to check.Outputs:
Check if the provided file exists.
Inputs:
path: The path of the file to check.Outputs:
Check if the provided path is the root of the system.
Inputs:
file: The file or path to check.Outputs:
Send Message
Send SMS Command. With Twidget, you can send SMS messages to phones using the `Send SMS` command. This functionality varies depending on the provider. Currently, we support Twilio as the SMS provider. To use Twilio for SMS integrations, you will need: - A Twilio account ID - Twilio Auth Token - A Tw...
Lists
Twidget offers a variety of commands to help you manipulate lists easily without coding. Below is a detailed explanation of each command available. Transform a list. In an endpoint, server function or event, add a command and choose List. Use the commands below to select, reshape, order or combine i...
Realtime commands
Use these commands in endpoints, server functions and events to connect authenticated customers and send live notifications. Start with [Realtime channels](/docs/builder/realtime) to create a channel and choose its audience. Authorize Realtime. Issue a one-use connection ticket for the signed-in cus...
Page Security
Use these commands in page workflows to check reCAPTCHA before accepting a form submission. Configure your keys first; see [Page Settings](/docs/pages/page-settings) and the existing [reCAPTCHA guide](/docs/pages/recaptcha). Generate reCAPTCHA token. Generates a token for the current interaction. Th...
Session Storage
Twidget includes a suite of session storage commands that enable no-code interaction with the browser’s `sessionStorage` API. These tools allow temporary storage of key-value data for the current page session. Purpose. Session storage commands allow developers to manage transient data tied to a sing...