# flatfile.com

## Docs

- [Transform and validate data](https://flatfile.com/docs/apps/custom/add-data-transformation): Add validations and transformations to your listeners
- [Deploy to Flatfile](https://flatfile.com/docs/apps/custom/deploying): Publish your code to Flatfile and move beyond this simple sandbox
- [Setup a listener](https://flatfile.com/docs/apps/custom/meet-the-listener): Learn how to listen and respond to events in Flatfile.
- [Configure a Space](https://flatfile.com/docs/apps/custom/meet-the-workbook): Configure a place for collecting data by creating a Space.
- [Configure a submit Action](https://flatfile.com/docs/apps/custom/submit-action): Create a simple submit Action to export your data
- [Getting started](https://flatfile.com/docs/apps/custom/tutorial-landing): Create a custom Flatfile app in this step by step guide
- [Before you begin](https://flatfile.com/docs/apps/embedding/angular/guide): Securely and easily build an embedded Flatfile import experience into your Angular application.
- [Embed a new Space](https://flatfile.com/docs/apps/embedding/angular/new_space): Create a new Space every time Flatfile is opened.
- [Quickstart](https://flatfile.com/docs/apps/embedding/angular/new_space_quickstart): Create a new Space every time Flatfile is opened.
- [Reuse an existing Space](https://flatfile.com/docs/apps/embedding/angular/reuse_space): Reuse a Space when Flatfile is opened.
- [Before you begin](https://flatfile.com/docs/apps/embedding/javascript/guide): Securely and easily build an embedded Flatfile import experience into your Javascript application.
- [Embed a new Space](https://flatfile.com/docs/apps/embedding/javascript/new_space): Create a new Space every time Flatfile is opened.
- [Quickstart](https://flatfile.com/docs/apps/embedding/javascript/new_space_quickstart): Create a new Space every time Flatfile is opened.
- [Reuse an existing Space](https://flatfile.com/docs/apps/embedding/javascript/reuse_space): Reuse a Space when Flatfile is opened.
- [Getting started](https://flatfile.com/docs/apps/embedding/overview): Securely and easily build an embedded Flatfile import experience into your client-side application behind your own authentication using a publishable key with very limited scope.
- [React Components](https://flatfile.com/docs/apps/embedding/react/components): Configure your Space in React
- [Before you begin](https://flatfile.com/docs/apps/embedding/react/guide): Securely and easily build an embedded Flatfile import experience into your React application.
- [Embed a new Space ](https://flatfile.com/docs/apps/embedding/react/legacy): Create a new Space every time Flatfile is opened.
- [Quickstart](https://flatfile.com/docs/apps/embedding/react/new_space_quickstart): Create a new Space every time Flatfile is opened.
- [Advanced](https://flatfile.com/docs/apps/embedding/reference/advanced): See the less commonly used shared properties for embedded Flatfile.
- [Common](https://flatfile.com/docs/apps/embedding/reference/common): See the commonly used shared properties across embedded Flatfile.
- [Simple](https://flatfile.com/docs/apps/embedding/reference/simple): See the simple-mode properties across embedded Flatfile.
- [Before you begin](https://flatfile.com/docs/apps/embedding/vue/guide): Securely and easily build an embedded Flatfile import experience into your Vue application.
- [Quickstart](https://flatfile.com/docs/apps/embedding/vue/new_space): Create a new Space every time Flatfile is opened.
- [Reuse an existing Space](https://flatfile.com/docs/apps/embedding/vue/reuse_space): Reuse a Space when Flatfile is opened.
- [Projects](https://flatfile.com/docs/apps/projects/overview): Use Flatfile in a collaborative data onboarding project with your customer.
- [Workbooks](https://flatfile.com/docs/apps/workbooks): The anatomy of a Workbook.
- [Access](https://flatfile.com/docs/blueprint/access): Controlling user interactions with your Sheets and fields
- [Constraints](https://flatfile.com/docs/blueprint/constraints): System level validation rules
- [Types](https://flatfile.com/docs/blueprint/field-types): Field Types inform the user interface how to sort and display data.
- [Overview](https://flatfile.com/docs/blueprint/overview): Blueprint is a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
- [Relationships](https://flatfile.com/docs/blueprint/relationships): Referencing data in other Sheets
- [Sheet options](https://flatfile.com/docs/blueprint/sheet-options): Configure the basic behavior of your Sheet
- [Platform](https://flatfile.com/docs/changelog/platform): Notable additions and updates to the Flatfile platform
- [SDKs](https://flatfile.com/docs/changelog/sdks): Notable additions and updates to Flatfile core libraries
- [flatfile](https://flatfile.com/docs/changelog/sdks/core/cli): The Flatfile CLI is a command-line tool that simplifies the integration process with Flatfile by providing developers with commands to manage and configure their integration from their local environment.
- [@flatfile/listener](https://flatfile.com/docs/changelog/sdks/core/listener): Listener combines event handling capabilities with Flatfile-specific functionality, such as working with Flatfile records and sessions. Simply put, it receives events and it responds to events.
- [@flatfile/plugin-automap](https://flatfile.com/docs/changelog/sdks/plugins/automations/automap): A plugin to provide automapping imported files for headless workflows.
- [@flatfile/plugin-job-handler](https://flatfile.com/docs/changelog/sdks/plugins/core/job-handler): A plugin that makes working with Flatfile Jobs more streamlined.
- [@flatfile/plugin-space-configure](https://flatfile.com/docs/changelog/sdks/plugins/core/space-configure): A plugin that streamlines the configuration of new Flatfile spaces.
- [@flatfile/plugin-export-workbook](https://flatfile.com/docs/changelog/sdks/plugins/export/export-workbook): A plugin for exporting data in Flatfile a Workbook.
- [@flatfile/plugin-webook-egress](https://flatfile.com/docs/changelog/sdks/plugins/export/webhook-egress): A plugin for egressing data via a webhook.
- [@flatfile/plugin-delimiter-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/delimiter-extractor): A plugin for parsing a delimited file and extracting it into Flatfile.
- [@flatfile/plugin-json-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/json-extractor): A plugin for parsing a JSON file and extracting it into Flatfile.
- [@flatfile/plugin-pdf-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/pdf-extractor): A plugin for parsing a PDF file and extracting it into Flatfile.
- [@flatfile/plugin-xlsx-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/xlsx-extractor): A plugin for parsing an XLSX file and extracting it into Flatfile.
- [@flatfile/plugin-xml-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/xml-extractor): A plugin for parsing an XML file and extracting it into Flatfile.
- [@flatfile/plugin-zip-extractor](https://flatfile.com/docs/changelog/sdks/plugins/extractors/zip-extractor): A plugin for decompressing a zip file and uploading the decompressed files into Flatfile.
- [Plugins](https://flatfile.com/docs/changelog/sdks/plugins/highlights): Notable additions and updates to Flatfile plugins
- [@flatfile/plugin-dxp-configure](https://flatfile.com/docs/changelog/sdks/plugins/migrations/dxp-configure): A plugin that lets you easily attach your implementation of the class-based schema configuration library `@flatfile/configure` to `@flatfile/listener`
- [@flatfile/plugin-convert-json-schema](https://flatfile.com/docs/changelog/sdks/plugins/schemas/json-schema): A plugin that automatically converts JSON Schema to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
- [@flatfile/plugin-convert-openapi-schema](https://flatfile.com/docs/changelog/sdks/plugins/schemas/openapi-schema): A plugin that automatically converts OpenAPI Schema to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
- [@flatfile/plugin-convert-sql-ddl](https://flatfile.com/docs/changelog/sdks/plugins/schemas/sql-ddl-converter): A plugin that automatically converts SQL DDL to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
- [@flatfile/plugin-convert-openapi-schema](https://flatfile.com/docs/changelog/sdks/plugins/schemas/yaml-schema): A plugin that automatically converts YAML Schema to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
- [@flatfile/plugin-autocast](https://flatfile.com/docs/changelog/sdks/plugins/transform/autocast): A plugin that automatically converts the initial user-inputted data to the correct type needed for that field so it can be processed.
- [@flatfile/plugin-dedupe](https://flatfile.com/docs/changelog/sdks/plugins/transform/dedupe): A plugin that automatically converts the initial user-inputted data to the correct type needed for that field so it can be processed.
- [@flatfile/plugin-record-hook](https://flatfile.com/docs/changelog/sdks/plugins/transform/record-hook): A plugin that exports a function named `recordHook` that sets up an event listener for the `commit:created` event. The purpose of this plugin is to provide a concise syntax for running custom logic on individual data records in Flatfile.
- [@flatfile/util-extractor](https://flatfile.com/docs/changelog/sdks/plugins/utils/extractor): loading...
- [@flatfile/util-file-buffer](https://flatfile.com/docs/changelog/sdks/plugins/utils/file-buffer)
- [@flatfile/util-response-rejection](https://flatfile.com/docs/changelog/sdks/plugins/utils/response-rejection): This plugin handles response rejections returned from an external source.
- [@flatfile/angular](https://flatfile.com/docs/changelog/sdks/wrappers/angular): An SDK wrapper that enables you to seamlessly integrate a secure and user-friendly data import experience into your client-side application
- [@flatfile/javascript](https://flatfile.com/docs/changelog/sdks/wrappers/javascript): An SDK wrapper that enables you to seamlessly integrate a secure and user-friendly data import experience into your client-side application
- [@flatfile/react](https://flatfile.com/docs/changelog/sdks/wrappers/react): An SDK wrapper that enables you to seamlessly integrate a secure and user-friendly data import experience into your client-side application
- [@flatfile/vue](https://flatfile.com/docs/changelog/sdks/wrappers/vue): An SDK wrapper that enables you to seamlessly integrate a secure and user-friendly data import experience into your client-side application
- [@flatfile/api](https://flatfile.com/docs/developer-tools/core-libraries/api)
- [flatfile-go](https://flatfile.com/docs/developer-tools/core-libraries/api-go)
- [flatfile-java](https://flatfile.com/docs/developer-tools/core-libraries/api-java)
- [flatfile-python](https://flatfile.com/docs/developer-tools/core-libraries/api-python)
- [flatfile](https://flatfile.com/docs/developer-tools/core-libraries/flatfile)
- [@flatfile/listener](https://flatfile.com/docs/developer-tools/core-libraries/listener)
- [@flatfile/angular](https://flatfile.com/docs/developer-tools/core-libraries/wrappers/angular)
- [@flatfile/react](https://flatfile.com/docs/developer-tools/core-libraries/wrappers/react)
- [@flatfile/javascript](https://flatfile.com/docs/developer-tools/core-libraries/wrappers/vanilla)
- [@flatfile/vue](https://flatfile.com/docs/developer-tools/core-libraries/wrappers/vuejs)
- [Deploying to Flatfile](https://flatfile.com/docs/developer-tools/deploying): Learn how to deploy your code to Flatfile.
- [Check for agents](https://flatfile.com/docs/developer-tools/developing/check-for-agents)
- [Running on your local machine](https://flatfile.com/docs/developer-tools/developing/running-local): Learn how to develop with Flatfile CLI.
- [Environments](https://flatfile.com/docs/developer-tools/environment): Learn how to use Environments for testing and authentication.
- [flatfile-mapping](https://flatfile.com/docs/developer-tools/mapping-libraries/flatfile-mapping-python)
- [Personal Access Token](https://flatfile.com/docs/developer-tools/security/account-token): Learn how to authenticate above the Environment level.
- [Authentication](https://flatfile.com/docs/developer-tools/security/authentication): Learn how to use API keys to authenticate API requests.
- [Roles & permissions](https://flatfile.com/docs/developer-tools/security/roles-and-permissions): Learn how to give your team and customers access.
- [Spaces](https://flatfile.com/docs/developer-tools/spaces): The anatomy of Spaces.
- [Versioning principles](https://flatfile.com/docs/developer-tools/versioning): Learn versioning principles for npm packages at Flatfile.
- [Using actions](https://flatfile.com/docs/guides/actions): Trigger operations based on user input.
- [Accepting Additional fields](https://flatfile.com/docs/guides/additional-fields): Create additional fields on the fly.
- [Leverage AI transformations](https://flatfile.com/docs/guides/ai): Learn how to use AI Assist to make bulk edits to your data efficiently and accurately.
- [Using our API](https://flatfile.com/docs/guides/api): Learn how to implement our API in your listeners and scripts
- [Automate with automap](https://flatfile.com/docs/guides/automap): Learn how to automatically map your data fields.
- [Bubble.io](https://flatfile.com/docs/guides/bubble-io): Open Flatfile from a Bubble.io webpage.
- [Data Retention](https://flatfile.com/docs/guides/data-retention): Implementing Data Retention Policies in Flatfile.
- [Build Documents](https://flatfile.com/docs/guides/documents): Learn how to build pages in your sidebar with Documents.
- [Dynamically configure anything](https://flatfile.com/docs/guides/dynamic-configurations): Dynamically build your Space configuration as it's created.
- [Egress out](https://flatfile.com/docs/guides/egress): Learn how to get data out of Flatfile.
- [Using Flatfile query language](https://flatfile.com/docs/guides/flatfile_query_language): Learn how to filter data in Sheets with FFQL.
- [Customize the guest sidebar](https://flatfile.com/docs/guides/guest_sidebar): Learn how to limit what Guests see in their sidebar.
- [Handling data](https://flatfile.com/docs/guides/handling-data): Learn how to process data with Data Hooks
- [Translating your Space](https://flatfile.com/docs/guides/localization): Translate and customize your Space with text overrides
- [Utilizing metadata](https://flatfile.com/docs/guides/metadata): Store descriptive information or data that provides additional context.
- [Scoping with Namespaces](https://flatfile.com/docs/guides/namespaces): Narrow down the scope of Spaces, Workbooks, and Sheets.
- [Share secrets](https://flatfile.com/docs/guides/secrets): Learn how to securely use credentials in listeners.
- [Theme your Space](https://flatfile.com/docs/guides/theming): Learn how to customize the look and feel of Flatfile to match your brand.
- [Actions](https://flatfile.com/docs/orchestration/actions): The anatomy of Actions
- [Events](https://flatfile.com/docs/orchestration/events): The anatomy of Events.
- [Jobs](https://flatfile.com/docs/orchestration/jobs): The anatomy of Jobs
- [Listeners](https://flatfile.com/docs/orchestration/listeners): The anatomy of Listeners
- [Overview](https://flatfile.com/docs/overview): Explore our guides and examples to implement Flatfile.
- [@flatfile/plugin-automap](https://flatfile.com/docs/plugins-docs/automations/automap): A plugin to provide automapping imported files for headless workflows. See our [Automap Guide](../../guides/automap) for best practices.
- [@flatfile/plugin-webhook-event-forwarder](https://flatfile.com/docs/plugins-docs/automations/webhook-event-forwarding): A plugin to forward Flatfile Events to specified http endpoints for headless workflows.
- [@flatfile/plugin-job-handler](https://flatfile.com/docs/plugins-docs/core/job-handler): A plugin for handling Flatfile Jobs.
- [@flatfile/plugin-space-configure](https://flatfile.com/docs/plugins-docs/core/space-configure): A plugin for configuring Flatfile Spaces.
- [@flatfile/dataset-countries](https://flatfile.com/docs/plugins-docs/datasets/countries): A plugin that populates a Sheet with the countries of the World.
- [@flatfile/dataset-zipcodes](https://flatfile.com/docs/plugins-docs/datasets/zipcodes): A plugin that populates a Sheet with 5-digit zip codes.
- [@flatfile/plugin-webhook-egress](https://flatfile.com/docs/plugins-docs/export/webhook): A plugin for egressing data from a Flatfile Workbook to a webhook.
- [@flatfile/plugin-export-workbook](https://flatfile.com/docs/plugins-docs/export/workbook): A plugin for exporting data in Flatfile to Workbooks.
- [@flatfile/plugin-delimiter-extractor](https://flatfile.com/docs/plugins-docs/extractors/delimiter-extractor): A plugin for parsing .delimiter files in Flatfile.
- [@flatfile/plugin-doc-extractor](https://flatfile.com/docs/plugins-docs/extractors/doc-extractor): A plugin for parsing .doc files in Flatfile.
- [@flatfile/plugin-json-extractor](https://flatfile.com/docs/plugins-docs/extractors/json-extractor): A plugin for parsing .json files in Flatfile.
- [@flatfile/plugin-pdf-extractor](https://flatfile.com/docs/plugins-docs/extractors/pdf-extractor): A plugin for parsing .pdf files in Flatfile.
- [@flatfile/plugin-xlsx-extractor](https://flatfile.com/docs/plugins-docs/extractors/xlsx-extractor): A plugin for parsing Excel files in Flatfile
- [@flatfile/plugin-xml-extractor](https://flatfile.com/docs/plugins-docs/extractors/xml-extractor): A plugin for parsing .xml files in Flatfile.
- [@flatfile/plugin-zip-extractor](https://flatfile.com/docs/plugins-docs/extractors/zip-extractor): A plugin for parsing .zip files in Flatfile.
- [@flatfile/plugin-dxp-configure](https://flatfile.com/docs/plugins-docs/migrations/dxp-configure): A plugin for using DXP class-based configurations.
- [Overview](https://flatfile.com/docs/plugins-docs/overview): Use one of our plugins to add functionality to your Flatfile data engine.
- [@flatfile/plugin-graphql](https://flatfile.com/docs/plugins-docs/schemas/convert-graphql): A plugin for converting Graphql to Flatfile Blueprint.
- [@flatfile/plugin-convert-json-schema](https://flatfile.com/docs/plugins-docs/schemas/convert-json-schema): A plugin for converting JSON Schema to Flatfile Blueprint and configuring a Flatfile Space.
- [@flatfile/plugin-convert-openapi-schema](https://flatfile.com/docs/plugins-docs/schemas/convert-openapi): A plugin for converting OpenAPI schema to Flatfile Blueprint.
- [@flatfile/plugin-convert-sql-ddl](https://flatfile.com/docs/plugins-docs/schemas/convert-sql-ddl): A plugin for converting SQL DDL to Flatfile Blueprint.
- [@flatfile/plugin-convert-yaml-schema](https://flatfile.com/docs/plugins-docs/schemas/convert-yaml-schema): A plugin for converting YAML Schema to Flatfile Blueprint.
- [@flatfile/plugin-autocast](https://flatfile.com/docs/plugins-docs/transform/autocast): A plugin for automatically casting values in Flatfile.
- [@flatfile/plugin-dedupe](https://flatfile.com/docs/plugins-docs/transform/dedupe): Dedupe records in a sheet via a sheet level custom action.
- [@flatfile/plugin-constraints](https://flatfile.com/docs/plugins-docs/transform/external-constraint): A plugin for providing a way to register external constraints for Blueprint.
- [@flatfile/plugin-record-hook](https://flatfile.com/docs/plugins-docs/transform/record-hook): A plugin for running custom logic on individual data records in Flatfile.
- [@flatfile/util-extractor](https://flatfile.com/docs/plugins-docs/utils/extractor): A shared utility for defining a data extraction.
- [@flatfile/util-file-buffer](https://flatfile.com/docs/plugins-docs/utils/file-buffer): A shared utility for processing files and extracting their contents using the Flatfile API.
- [@flatfile/util-response-rejection](https://flatfile.com/docs/plugins-docs/utils/response-rejection): A shared utility for handling response rejections.
- [Icons](https://flatfile.com/docs/reference/icons): Reference of all available icons
- [Example Projects](https://flatfile.com/docs/starter-projects): A selection of example projects to get started with.
- [Overview](https://flatfile.com/docs/upgrade/overview): Move from the legacy products to the new Flatfile Platform
- [Repo on GitHub](https://flatfile.com/docs/upgrade/v2_repo): Check out the code in this repository
- [Quickstart Portal 2 Upgrade](https://flatfile.com/docs/upgrade/v2_upgrade): Moving on up... to the Platform
- [Portal 2 <-> Platform Concepts](https://flatfile.com/docs/upgrade/v2_upgrade_concepts): Key terms and concepts for your upgrade
- [Upgrade with @flatfile/configure](https://flatfile.com/docs/upgrade/v3_dxp_configure): Upgrade to Platform using DXP Configure
- [Repo on GitHub](https://flatfile.com/docs/upgrade/v3_repo): Check out the code in this repository
- [Upgrading from v3](https://flatfile.com/docs/upgrade/v3_upgrade): Step up to the Platform


## Optional

- [API Reference](https://reference.flatfile.com)
- [Join our community](https://flatfile.com/join-slack/)