Overview
Extend your Flatfile data engine with powerful plugins for extraction, transformation, validation, and integration
Flatfile plugins extend your data processing capabilities with pre-built, reusable modules for common data operations. They handle everything from file extraction and data transformation to validation and external integrations, allowing you to build sophisticated data workflows quickly.
Open Source
All Flatfile plugins are open source and available on GitHub at github.com/FlatFilers/flatfile-plugins.
Plugin Categories
🔄 Transform
Plugins for data transformation, validation, and cleaning.
Record Hook
Run custom logic on individual data records in real-time
Autocast
Automatically cast values to appropriate data types
Constraints
Extend schemas with external validation constraints
Dedupe
Remove duplicate records via sheet-level actions
📤 Extractors
Plugins for parsing and extracting data from various file formats.
Delimiter Extractor
Parse delimited files (CSV, TSV, etc.)
XLSX Extractor
Extract data from Excel spreadsheets
JSON Extractor
Parse JSON files and convert to tabular data
PDF Extractor
Extract structured data from PDF documents
📋 Schemas
Plugins for converting external schemas to Flatfile format.
JSON Schema Converter
Convert JSON Schema to Flatfile Blueprint
OpenAPI Schema Converter
Convert OpenAPI schema to Flatfile Blueprint
SQL DDL Converter
Convert SQL DDL to Flatfile Blueprint
YAML Schema Converter
Convert YAML Schema to Flatfile Blueprint
📤 Export
Plugins for exporting processed data to external systems.
Export Workbook
Export data from Flatfile to various formats
Webhook Egress
Send data to external webhooks
Export Delimited ZIP
Export workbooks as delimited files in ZIP archives
Export Pivot Table
Generate pivot tables from sheet data
🔧 Core
Essential plugins for Flatfile operations and configuration.
Space Configure
Configure Flatfile spaces with workbooks and settings
Job Handler
Handle Flatfile jobs with custom logic
View Mapped
Show only mapped columns in post-mapping view
Rollout
Automatically roll out workbook changes
✅ Validation
Specialized validation plugins for data quality.
Validate Email
Comprehensive email address validation
Validate Phone
Phone number formatting and validation
Validate Date
Date format normalization and validation
Validate Number
Number validation and formatting
🔗 Enrich
Plugins for data enrichment using external APIs.
Geocode
Geocode addresses using Google Maps API
Sentiment Analysis
Analyze sentiment of text fields
Text Summarization
Summarize and extract key phrases from text
What3Words
Convert What3Words addresses to standard addresses
Getting Started with Plugins
Installation
Install plugins using npm in your Flatfile project:
Basic Usage
Add plugins to your listener:
Plugin Configuration
Most plugins accept configuration options:
Plugin Development
Creating Custom Plugins
You can create custom plugins for reusable functionality:
Plugin Best Practices
- Single Responsibility: Each plugin should handle one specific functionality
- Configuration: Accept configuration options for flexibility
- Error Handling: Implement robust error handling and logging
- Documentation: Provide clear documentation and examples
- Testing: Include comprehensive tests for your plugin
Popular Plugin Combinations
Basic Data Import
Advanced Validation
Schema Conversion
Data Enrichment
Plugin Repository
All Flatfile plugins are open source and available on GitHub:
- Main Repository: github.com/FlatFilers/flatfile-plugins
- NPM Organization: @flatfile
- Plugin Marketplace: flatfile.com/plugins
Contributing
We welcome contributions to the Flatfile plugin ecosystem:
- Bug Reports: Report issues on the GitHub repository
- Feature Requests: Suggest new plugins or enhancements
- Pull Requests: Contribute code improvements or new plugins
- Documentation: Help improve plugin documentation
Support
- Documentation: Each plugin includes detailed documentation
- Community: Join our Slack community for support
- GitHub Issues: Report bugs or request features on GitHub
- Professional Support: Contact our team for enterprise support