Skip to main content

Read

Reads a JSON file from the file system and converts it to a JSON object.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs​

  • Path - File path of the JSON file to read.

Options​

This node does not have any options.

Outputs​

  • Payload - JSON object parsed from the file content.

How It Works​

The Read node loads a JSON file from the file system and converts it to a JSON object. When executed, the node:

  1. Receives a file path through the Path input
  2. Reads the file content from the specified path
  3. Removes any Byte Order Mark (BOM) if present
  4. Parses the file content as JSON
  5. Outputs the parsed JSON object through the Payload output

Requirements​

  • Valid file path to a JSON file
  • Read permissions for the specified file
  • Valid JSON format in the file

Error Handling​

The node will return specific errors in the following cases:

  • Empty file path
  • File not found at the specified path
  • Insufficient read permissions
  • Invalid JSON format in the file
  • File system access errors

Usage Notes​

  • This node is useful for loading JSON configuration files or data files
  • Works with any valid JSON file format
  • Automatically handles UTF-8 BOM characters if present
  • The file path can be absolute or relative
  • Useful for data import and configuration loading workflows
  • Can be combined with other JSON nodes to process file data
  • The output object can be used with Get, Set, Delete and other JSON processing nodes
  • Works with nested JSON objects and arrays
  • Supports standard JSON formatting with proper indentation