The DevXP engineering team hosts office hours every Thursday at 11 a.m. Pacific Time where we answer your questions live and help you get up and running with Flatfile. Join us!

For synchronous data import/exchange completed in one session, create a new Space each time Flatfile is opened. This suits situations where a clean slate for every interaction is preferred.

​
Before you begin

​
Get your keys

To complete this tutorial, you'll need to retrieve your Publishable key from your development environment.

Note: The Publishable Key is safe to be used in client-side applications as it has limited access to the Flatfile API.

​
Prepare your project

​
Create your file structure

Setup your app to look something like this:

├── public/
   └── index.html
   └── styles.css
├── src/
   └── blueprint.js

In this file structure, your app should have two main directories, public and src.

The public directory contains the index.html file, which is the entry point of the application’s front-end, and the styles.css file for styling the iframe.

The src directory contains the main components and logic of the application, including the blueprint.js file, which defines your Blueprint.

​
Build your importer

​
1. Initialize Flatfile

Initialize Flatfile to open in a modal. Pass in your publishableKey and a new Space will be created on each page load. Also, add the content here to your styles.css.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Hello, world!</title>
    <script src="https://unpkg.com/@flatfile/javascript/dist/index.js"></script>
    <script src="../src/blueprint.js"></script>
    <link rel="stylesheet" type="text/css" href="./styles.css" />

    <script>
      window.onload = function () {
        FlatFileJavaScript.startFlatfile({
          publishableKey: "pk_1234",
          namespace: "portal",
          externalActorId: "test-1",
          onSubmit: async ({ sheet }) => {
            const data = await sheet.allData();
            console.log("onSubmit", data);
          },
          onRecordHook: (record) => {
            const firstName = record.get("firstName");
            console.log({ firstName });
            record.set("lastName", "Rock");
            return record;
          },
          themeConfig: {
            root: {
              primaryColor: "red",
              textColor: "white",
              logo: "https://images.ctfassets.net/hjneo4qi4goj/gL6Blz3kTPdZXWknuIDVx/7bb7c73d93b111ed542d2ed426b42fd5/flatfile.svg",
            },
          },
        });
      };
    </script>
  </head>
</html>

​
2. Run in browser

Now, open index.html in a browser. You should see that Flatfile opens on page load and an empty Space gets created.

​
3. Build a Workbook

Now, let's build a Workbook inside the Space for next time.

  1. Update your blueprint.js with this simple Blueprint.
  2. Update index.html to import the Workbook.

Next time you open Flatfile, you'll see a Workbook called "Contacts" that has one Sheet with three fields. Your Workbook will also have a Submit action. We will configure this action in the next step.

const blueprint = {
  "name": "Contacts",
  "slug": "contacts",
  "fields": [
    {
      "key": "firstName",
      "type": "string",
      "label": "First Name"
    },
    {
      "key": "lastName",
      "type": "string",
      "label": "Last Name"
    },
    {
      "key": "email",
      "type": "string",
      "label": "Email"
    }
  ]
}

​
4. Set the destination

Finally, let's get the data out of our system and to your destination with onSubmit.

Once you add this code, when the submit button is clicked, this will be the place you can egress your data. Learn more about Egress Out

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
  });
};

​
5. Transform Data

Next, we'll listen for data changes and respond onRecordHook,

Once you add this code, when a change occurs, we'll log the entered first name and update the last name to "Rock." You'll immediately see this begin to work when you add or update any records. Learn more about Handling Data

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
    onRecordHook: (record) => {
      const firstName = record.get("firstName");
      console.log({ firstName });
      record.set("lastName", "Rock");
      return record;
    },
  });
};

​
6. Match your brand

By attaching a themeConfig, we will now override colors in your Space to match your brand. See all of the options here in the Theming Reference.

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
    onRecordHook: (record) => {
      const firstName = record.get("firstName");
      if (firstName) {
        record.set("firstName", firstName.toUpperCase());
        record.addInfo("firstName", "We updated the values to all uppercase");
      }
      return record;
    },
    themeConfig: {
      root: {
        primaryColor: "red",
        textColor: "white",
        logo: "https://images.ctfassets.net/hjneo4qi4goj/gL6Blz3kTPdZXWknuIDVx/7bb7c73d93b111ed542d2ed426b42fd5/flatfile.svg",
      },
    },
  });
};

​
7. Customize

You can stop here or explore these configuration references to customize your importer:

​
Example Projects

Find these Javascript example projects in the Flatfile GitHub repository.

create-flatfile-javascript-simplified

Clone the simplified Flatfile Javascript tutorial using a CDN here.

create-flatfile-javascript

Want to get started? Clone the Flatfile JavaScript tutorial here.

The DevXP engineering team hosts office hours every Thursday at 11 a.m. Pacific Time where we answer your questions live and help you get up and running with Flatfile. Join us!

For synchronous data import/exchange completed in one session, create a new Space each time Flatfile is opened. This suits situations where a clean slate for every interaction is preferred.

​
Before you begin

​
Get your keys

To complete this tutorial, you'll need to retrieve your Publishable key from your development environment.

Note: The Publishable Key is safe to be used in client-side applications as it has limited access to the Flatfile API.

​
Prepare your project

​
Create your file structure

Setup your app to look something like this:

├── public/
   └── index.html
   └── styles.css
├── src/
   └── blueprint.js

In this file structure, your app should have two main directories, public and src.

The public directory contains the index.html file, which is the entry point of the application’s front-end, and the styles.css file for styling the iframe.

The src directory contains the main components and logic of the application, including the blueprint.js file, which defines your Blueprint.

​
Build your importer

​
1. Initialize Flatfile

Initialize Flatfile to open in a modal. Pass in your publishableKey and a new Space will be created on each page load. Also, add the content here to your styles.css.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Hello, world!</title>
    <script src="https://unpkg.com/@flatfile/javascript/dist/index.js"></script>
    <script src="../src/blueprint.js"></script>
    <link rel="stylesheet" type="text/css" href="./styles.css" />

    <script>
      window.onload = function () {
        FlatFileJavaScript.startFlatfile({
          publishableKey: "pk_1234",
          namespace: "portal",
          externalActorId: "test-1",
          onSubmit: async ({ sheet }) => {
            const data = await sheet.allData();
            console.log("onSubmit", data);
          },
          onRecordHook: (record) => {
            const firstName = record.get("firstName");
            console.log({ firstName });
            record.set("lastName", "Rock");
            return record;
          },
          themeConfig: {
            root: {
              primaryColor: "red",
              textColor: "white",
              logo: "https://images.ctfassets.net/hjneo4qi4goj/gL6Blz3kTPdZXWknuIDVx/7bb7c73d93b111ed542d2ed426b42fd5/flatfile.svg",
            },
          },
        });
      };
    </script>
  </head>
</html>

​
2. Run in browser

Now, open index.html in a browser. You should see that Flatfile opens on page load and an empty Space gets created.

​
3. Build a Workbook

Now, let's build a Workbook inside the Space for next time.

  1. Update your blueprint.js with this simple Blueprint.
  2. Update index.html to import the Workbook.

Next time you open Flatfile, you'll see a Workbook called "Contacts" that has one Sheet with three fields. Your Workbook will also have a Submit action. We will configure this action in the next step.

const blueprint = {
  "name": "Contacts",
  "slug": "contacts",
  "fields": [
    {
      "key": "firstName",
      "type": "string",
      "label": "First Name"
    },
    {
      "key": "lastName",
      "type": "string",
      "label": "Last Name"
    },
    {
      "key": "email",
      "type": "string",
      "label": "Email"
    }
  ]
}

​
4. Set the destination

Finally, let's get the data out of our system and to your destination with onSubmit.

Once you add this code, when the submit button is clicked, this will be the place you can egress your data. Learn more about Egress Out

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
  });
};

​
5. Transform Data

Next, we'll listen for data changes and respond onRecordHook,

Once you add this code, when a change occurs, we'll log the entered first name and update the last name to "Rock." You'll immediately see this begin to work when you add or update any records. Learn more about Handling Data

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
    onRecordHook: (record) => {
      const firstName = record.get("firstName");
      console.log({ firstName });
      record.set("lastName", "Rock");
      return record;
    },
  });
};

​
6. Match your brand

By attaching a themeConfig, we will now override colors in your Space to match your brand. See all of the options here in the Theming Reference.

public/index.html
window.onload = function () {
  FlatFileJavaScript.startFlatfile({
    publishableKey: "pk_1234",
    namespace: "portal",
    sheet: blueprint,
    onSubmit: async ({ sheet }) => {
      const data = await sheet.allData();
      console.log("onSubmit", data);
    },
    onRecordHook: (record) => {
      const firstName = record.get("firstName");
      if (firstName) {
        record.set("firstName", firstName.toUpperCase());
        record.addInfo("firstName", "We updated the values to all uppercase");
      }
      return record;
    },
    themeConfig: {
      root: {
        primaryColor: "red",
        textColor: "white",
        logo: "https://images.ctfassets.net/hjneo4qi4goj/gL6Blz3kTPdZXWknuIDVx/7bb7c73d93b111ed542d2ed426b42fd5/flatfile.svg",
      },
    },
  });
};

​
7. Customize

You can stop here or explore these configuration references to customize your importer:

​
Example Projects

Find these Javascript example projects in the Flatfile GitHub repository.

create-flatfile-javascript-simplified

Clone the simplified Flatfile Javascript tutorial using a CDN here.

create-flatfile-javascript

Want to get started? Clone the Flatfile JavaScript tutorial here.