Flatfile Developer Docs

Docs

• 01: Creating Your First Listener: Learn to set up a basic Listener with Space configuration to define your data structure and workspace layout.
• 02: Adding Validation to Your Listener: Enhance your listener with data validation capabilities to ensure data quality and provide real-time feedback to users.
• 03: Adding Actions to Your Listener: Build on your basic Listener by adding user Actions to create interactive data processing workflows.
• Coding Tutorial: Learn to build Event Listeners that configure and customize Flatfile through hands-on coding tutorials
• Actions: User-triggered operations in Flatfile
• Apps: The anatomy of an App
• Blueprints: Define your data schema to structure exactly how data should look, behave, and connect
• Documents: Standalone webpages within Flatfile Spaces for guidance and dynamic content
• Environments: Use Environments for testing and authentication
• Fields: Blueprint definitions that define the structure and validation rules for your data in Flatfile
• Jobs: Discrete tasks executed asynchronously in response to events
• Events and Listeners: The anatomy of Events and Listeners - core components of the Flatfile Platform
• Overview: Understanding Flatfile's building blocks and architecture
• Plugins: Reusable functionality modules that extend Flatfile's capabilities
• Records: Individual data rows that represent your imported data in Flatfile
• Sheets: Individual data tables within Workbooks that organize and structure imported data
• Spaces: Micro-applications for content and data storage
• Workbooks: Database-like containers with type-strict Blueprints for data import
• Advanced Configuration: Complete configuration reference for embedded Flatfile
• Angular Embedding: Embed Flatfile in Angular applications
• JavaScript Embedding: Embed Flatfile using vanilla JavaScript
• Overview: Embed Flatfile data import directly into your application
• React Embedding: Embed Flatfile in React applications
• Server Setup for Space Reuse: Server-side implementation guide for reusing existing spaces
• Vue Embedding: Embed Flatfile in Vue.js applications
• Getting Started with AutoBuild: Get up and running with Flatfile in minutes using AutoBuild to create a complete data import solution
• Creating Your First Project: Running through the import flow with your Flatfile App
• Accepting Additional Fields: Create additional fields on the fly
• Advanced Filters: Learn how to use Flatfile's Advanced Filters to efficiently filter and search through your data
• Authentication and Authorization: Complete guide to authenticating with Flatfile using API keys, Personal Access Tokens, and managing roles and permissions
• Custom Extractors: Build custom file processing plugins to handle unique data formats and transform files into structured data
• Data Egress: Get data out of Flatfile using various transmission methods and file formats
• Multi-Part Jobs: Split up Jobs into Parts
• Namespaces and Filters: Isolate and organize your Flatfile Listeners using namespace filtering and advanced Event filtering patterns
• Guides Overview: Comprehensive guides to help you master Flatfile's features and capabilities
• Secrets: Securely use credentials in listeners
• Theming: Learn how to customize the look and feel of Flatfile to match your brand
• Internationalization: Translate and customize your Space with text overrides
• Actions: Trigger custom operations based on user input
• Using Record Hooks: Process data with Record Hooks
• Metadata: Store descriptive information or data that provides additional context
• Welcome to Flatfile
• Autocast Plugin: Automatically convert data in a Flatfile Sheet to match the data types defined in the corresponding Blueprint
• Automap Plugin: Automatically map columns for headless data import workflows in Flatfile with configurable confidence levels
• Boolean Validator: Comprehensive boolean validation plugin for Flatfile that handles various representations of boolean values with multi-language support and flexible configuration options.
• Constraints Plugin: Extend Flatfile validation capabilities with custom validation logic for complex field and sheet-level constraints
• Currency Conversion Plugin: Automatically converts currency values from a source currency to a target currency using Open Exchange Rates API with support for historical exchange rates.
• Date Format Normalizer: Automatically parse and standardize date values during data import, converting various date formats into a consistent output format.
• Deduplicate Sheet Records: A Flatfile plugin that provides functionality to find and remove duplicate records from a sheet based on specified field values or custom logic.
• Delimited File Zip Exporter: Export data from all sheets within a Flatfile Workbook into delimited text files and compress them into a single ZIP archive for download.
• Delimiter Extractor Plugin: Parse text files with custom delimiters and automatically extract structured data for import into Flatfile
• Email Validation Plugin: Validate email addresses in Flatfile data imports with format checking, required field validation, and disposable domain blocking
• Export Workbook Plugin: A server-side utility for Flatfile that allows users to export data from an entire Flatfile Workbook into a single, downloadable Microsoft Excel (.xlsx) file.
• Foreign Database Extractor for Microsoft SQL Server: Automatically extract data from Microsoft SQL Server backup files (.bak) into Flatfile Workbooks for easy data review and processing.
• Geocode Address Data: Automatically enrich location data using the Google Maps Geocoding API to convert addresses into geographic coordinates and vice-versa.
• GPX File Parser and Analyzer: Automatically processes GPX (GPS Exchange Format) files to extract waypoints, tracks, routes, and calculate geographic statistics like distance and elevation gain.
• GraphQL Schema to Flatfile Blueprint Converter: Automatically generate Flatfile Space configurations by converting GraphQL schemas into Workbooks and Sheets, streamlining data import setup for GraphQL APIs.
• HTML Table Extractor: Parse HTML files and extract data from tables within them, converting structured data into Flatfile-compatible format
• Overview: Extend your Flatfile data engine with powerful plugins for extraction, transformation, validation, and integration
• ISBN Validator Plugin: A Flatfile plugin that validates and formats International Standard Book Number (ISBN) data during the import process, supporting both ISBN-10 and ISBN-13 standards with automatic formatting and conversion capabilities.
• Job Handler Plugin: A Flatfile plugin that streamlines the handling of asynchronous Jobs by managing their lifecycle, progress reporting, and completion status.
• JSON Extractor: Parse JSON and JSON Lines files uploaded to Flatfile and extract data into Sheets within a Workbook
• JSON Schema Converter: Automatically transform JSON Schema into Flatfile Blueprint for streamlined data model setup
• Markdown File Extractor: Automatically parse Markdown files and extract tables into Flatfile Sheets
• Merge.dev Connection Plugin: Connect Flatfile to the Merge.dev unified API platform to sync data from hundreds of third-party integrations including HRIS, ATS, CRM, and Accounting systems.
• Number Validation Plugin: Comprehensive validation for numeric data during the Flatfile import process with support for ranges, formats, and special number types.
• OpenAPI Schema to Flatfile Blueprint Converter: Automatically converts OpenAPI v3.0.3 schemas into Flatfile Blueprints to streamline Space setup using existing API data structures
• PDF Extractor Plugin: Extract tabular data from PDF files and convert them to CSV format using the pdftables.com service
• Phone Number Validation and Formatting Plugin: Validates and formats phone numbers in Flatfile using country-specific validation with libphonenumber-js library
• Pivot Table Exporter: A Flatfile plugin that performs data analysis and summarization by generating pivot tables from workbook data and uploading them as Markdown documents.
• Record Hook Plugin: Execute custom logic on individual data records within a Flatfile Sheet with support for validation, transformation, enrichment, and cleaning.
• Rollout: Automatic Workbook Updates: Automatically apply schema changes to existing, live workbooks when a new version of a Flatfile Agent is deployed
• Sentiment Analysis Plugin: Automatically analyze sentiment in text fields and add sentiment scores and categories to your Flatfile records
• Flatfile Space Configuration Plugin: Programmatically set up and configure a new Flatfile Space with workbooks, sheets, documents, and metadata from a single configuration object.
• Space Configure from Template: Automatically configure new Flatfile Spaces by cloning an existing Space Template, including workbooks, documents, and settings.
• SQL DDL to Flatfile Blueprint Converter: Automatically create Flatfile Blueprints from SQL Data Definition Language (DDL) files to streamline database schema imports.
• Stored Constraints Plugin: Automatically applies server-side validation rules to records during the data import process using reusable JavaScript functions defined at the App level.
• String Validator Plugin: A comprehensive plugin for validating and transforming string data during the Flatfile import process with configurable validation rules, pattern matching, and automatic data corrections.
• Text Summarization and Key Phrase Extraction Plugin: Automatically enriches Flatfile data by performing text summarization and key phrase extraction on specified text fields using natural language processing.
• Field Translation using Google Translate API: Automatically translate text content in specified fields using Google Translate API and create new fields with translated content
• View Mapped Data Plugin: Automatically hides unmapped columns after the mapping stage to provide a cleaner data review experience
• Webhook Egress: Send workbook data from Flatfile to external webhook endpoints for seamless integration with your systems
• Webhook Event Forwarder: Forward all Flatfile events to a webhook URL for language-agnostic integration with external systems
• What3Words Converter Plugin: Automatically convert What3Words addresses into standard geographic data including country codes, nearest places, and latitude/longitude coordinates using the official What3Words API.
• Excel Extractor: Parse various Excel file formats (.xls, .xlsx, .xlsm, .xlsb, .xltx, .xltm) and extract structured data with support for header detection, merged cells, and hierarchical spreadsheets.
• XML Extractor: A Flatfile plugin for parsing XML files, flattening nested structures and attributes, and converting them into tabular format for easy import into Flatfile Sheets.
• YAML Schema to Flatfile Blueprint Converter: Automates the creation of a Flatfile Blueprint (Workbook and Sheets) from one or more YAML schema definitions, streamlining the setup of a Flatfile Space by converting existing data models into a Flatfile-compatible format.
• Zip Extractor: Automatically decompress .zip files uploaded to a Flatfile Space and extract their contents as individual files
• CLI Reference: Command line interface for developing, deploying, and managing Flatfile Agents
• Event Reference: Complete reference for all Flatfile events, their payloads, and when they are triggered
• Flatfile Query Language: Learn how to filter data in Sheets with FFQL.
• For LLMs: AI-optimized documentation formats and tools for better LLM integration
• Icon Reference: Reference of all available icons
• V2 Records API: Using the V2 Records API with the Flatfile TypeScript API package

OpenAPI Specs

• openapi
• package
• package-lock
• .prettier

Optional

• API Reference
• Changelog
• Platform