@flatfile/vanillajs

Blueprint

Plugins

Developers

API Reference

flatfile.com

Sign in

Create account

Explore our guides and examples to implement Flatfile.

Overview

Learn how to create your first Workbook in Flatfile.

Meet the Workbook

Begin the process of validating and transforming data in Flatfile by implementing a basic event handler.

Transform & validate data

Learn how to create a simple submit Action in Flatfile.

Configure a submit action

Publish your new configuration to Flatfile and move beyond this simple sandbox.

Deploy to Flatfile

Learn how to process data with Data Hooks

Handling data

Using actions

Dynamically build your configuration on command.

Dynamic configurations

Learn how to customize the look and feel of Flatfile to match your brand.

Theme your Space

Learn how to limit what Guests see in their sidebar.

Customize the guest sidebar

Learn how to build pages in your sidebar with Documents.

Build Documents

Workbooks

Jobs & Actions

Events

Spaces

Learn how to securely and easily build an embedded Flatfile import experience into your client-side application

Before you begin

Embed a [Space](../concepts/spaces) directly into your application.

Embed a Space

Learn more about about additional configuration options available for your embedded Space.

See advanced options

Discover ideas for using Flatfile to transform and validate data.

Review full code examples

Learn how to create adaptable data connections.

Setup headless file feeds

Use Flatfile in a collaborative data onboarding project with your customer.

Run onboarding projects

Blueprint is a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.

Field Types inform the user interface how to sort and display data.

Types

Constraints

Relationships

Controlling user interactions with your Sheets and fields

Access

Learn how to use Environments for testing and authentication.

Using environments

Learn how to deploy your code to Flatfile.

Deploying to Flatfile

Learn how to filter data in Sheets with FFQL.

Flatfile query language

Learn how to use API keys to authenticate API requests.

Authentication

Learn how to give your team and customers access.

Roles & permissions

flatfile

@flatfile/api

@flatfile/listener

@flatfile/react

@flatfile/angular

@flatfile/vue

Use one of our plugins to add functionality to your Flatfile data engine.

A plugin for parsing .xlsx files in Flatfile.

@flatfile/plugin-xlsx-extractor

A plugin for parsing .pdf files in Flatfile.

@flatfile/plugin-pdf-extractor

A plugin for parsing .doc files in Flatfile.

@flatfile/plugin-doc-extractor

A plugin for parsing .zip files in Flatfile.

@flatfile/plugin-zip-extractor

A plugin for running custom logic on individual data records in Flatfile.

@flatfile/plugin-record-hook

A plugin for automatically casting values in Flatfile.

@flatfile/plugin-autocast

A plugin for converting JSON Schema to Flatfile Blueprint.

@flatfile/plugin-json-schema

A plugin for converting Open API to Flatfile Blueprint.

@flatfile/plugin-openapi

A plugin for converting Graphql to Flatfile Blueprint.

@flatfile/plugin-graphql

A plugin for converting SQL DDL to Flatfile Blueprint.

@flatfile/plugin-sql-ddl

A plugin that populates a Sheet with 5-digit zip codes.

@flatfile/dataset-zipcodes

A plugin that populates a Sheet with the countries of the World.

@flatfile/dataset-countries

A plugin for using DXP class-based configurations.

Overview

Security

Core libraries

Wrappers

@flatfile/vanillajs