Workbooks
Workbooks are analogous to a database, and like a database, they are configured with a type-strict schema. A Workbook replaces the spreadsheet template you may share with your users today when requesting data during the data collection phase of customer onboarding or other file-based data exchange processes. Unlike a spreadsheet, it’s designed to allow your team and users to validate, correct, and import data with real-time feedback.
With Workbooks, you can:
- Accept data from many file types beyond CSVs. (And you can write your own file extractors if you can’t find a plugin.)
- Automatically apply any validation rules a developer has previously defined.
- Provide end users the ability to add, remove, review, filter, and correct any data imported into a Workbook.
- Define, in code, at least one primary action that submits the reviewed data to a destination API, database, or workflow step of your choosing.
Anatomy
A Workbook is comprised of one or more SheetsA collection of fields... plus any actions you want to take on those Sheets.
Reference
Sheets array
A schema contains Sheets. Like tables in a database or sheets in a spreadsheet, Sheets isolate different data schemas.
Fields array
Sheets contain FieldsDescribes an attribute of the entity.... Fields are defined properties of your schema (eg a first_name on a contact sheet.)
Actions array
Workbooks and Sheets can also contain Actions. Actions are developer-defined operations or macros invoked by end users on selected data like Submit to API, Download as PDF.
Labels array
To have a workbook appear first in the sidebar, give it the label ‘pinned’ (it will even have a pin icon!). You can also add other custom labels to your workbooks as needed.