KoboToolbox 2 icon

KoboToolbox 2

Work with KoboToolbox forms and submissions

Overview

This node integrates with KoboToolbox to work specifically with files related to KoboToolbox forms. The "File" resource with the "Get Many" operation allows users to retrieve multiple files associated with a specific form. Users can choose to either get metadata about these files or download their actual content into the workflow as binary data.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of all media files (e.g., images, audio) uploaded via a KoboToolbox form for further processing or storage.
  • Downloading file attachments from form submissions to use in other systems or workflows.
  • Archiving or backing up form-related files automatically.

Practical example:

  • A humanitarian organization collects field data with photos using KoboToolbox forms. This node can fetch all photos submitted for a particular form and download them into n8n for automatic upload to cloud storage or analysis.

Properties

Name Meaning
Form Name or ID Select or specify the ID of the KoboToolbox form whose files you want to retrieve.
Download File Content Boolean option to decide whether to download the actual file content (true) or just retrieve file metadata (false).
Property Name When downloading file content, this specifies the name of the binary property where the file data will be stored in the output.

Output

The node outputs an array of JSON objects representing the files associated with the specified form.

  • If Download File Content is set to false, each item contains only the file metadata in the json property.
  • If Download File Content is set to true, each item contains:
    • json: The file metadata.
    • binary: A binary property (named as per the "Property Name" input) containing the actual file content ready for downstream nodes that handle binary data.

This enables workflows to either process file information or directly manipulate/download the file contents.

Dependencies

  • Requires a valid API authentication token/credential for accessing the KoboToolbox API.
  • The node uses the KoboToolbox REST API endpoints to list and download files.
  • No additional external services are required beyond KoboToolbox itself.

Troubleshooting

  • No file found matching name "X": This error occurs if the node is configured to select a file by name but no file with that exact name exists in the form. To resolve, verify the file name spelling or switch to selecting by file ID.
  • API request failures: Could be due to invalid credentials, network issues, or API rate limits. Ensure the API key is correct and has sufficient permissions.
  • Empty output when expecting files: Confirm that the form actually has uploaded files of type "form_media". Also check that the form ID is correct.
  • Binary data not appearing: Make sure "Download File Content" is enabled and the binary property name is correctly set.

Links and References

Discussion