Airtable Integrations

Overview

There are three types of Airtable integrations.

1. Native App

2. Generation Link

3. Automation Script

All integrations allow you to create documents from your Airtable data and attach them back to Airtable. The Generation Link integration and the Automation Script are identical in their features however the Native App does have some slight differences (see comparison below).

Integration Comparison

Feature	Native App	Generation Link & Automation Script
Available with all Documint Plans	✅	✅
Available with all Airtable plans	❌	✅
Attach documents back to Airtable	✅	✅
Include data from Linked Records	✅	✅
Document Preview	✅	✅
Works outside of Airtable (eg. Stacker)	❌	✅
Shareable Document Link	❌	✅
Whitelabel Document Viewer	❌	✅
Document Password Protection	❌	✅
Duplicate Document Prevention	✅	✅
Setup time/difficulty	🙂	😐

Native App

The Native App integration works by using an Airtable app that you can install in your base. You can find the app in the Airtable Marketplace. The app provides you with an interface within Airtable for generating documents from your records. Learn more

Generation Link

The Generation Link integration uses a special URL to generate your document. This URL is created dynamically by a formula in either a Formula field or Button field. When the link or button is clicked, Documint creates a document using the template id and record id provided in the URL. Learn more

Fields Types

Field names in Airtable are converted to snake-case in Documint. This means your variables need to be the snake-case version of the field name. For example, if a field in Airtable is named Order Total, its variable name in Documint needs to beorder_total . Notice the space is replaced with an underscore and everything is converted to lowercase.

Use the Variable Generator to convert your field names to variables.

Attachment Field

Overview

Field in Airtable

Final Product

45KB

download.pdf

pdf

Setup

Add an Image element to a Column element

Select the column and click "Add/Edit Logic"

Switch to the "Repeat/Loop" tab, enter the name of the attachment field (without curly braces) to the "List variable" input field and click "Save"

Double-click the image element added earlier.

Enter "{{url}}" into the input field in the top right of the "Select Image" modal and click "Add image"

Double click the new image item with the label "{{url}}"

That's it. Now each of your images will display horizontally (since the column is repeated and not the row)

Data

// Example of the data sent from Airtable to Documint
{
	"attachment": [
		{
			"id": "attAMs6l8bryp3xqx",
			"url": "https://dl.airtable.com/.attachments/6c774b90cc255d5b072ec1fbae1fa103/0e61546c/237-300x300.jpg",
			"filename": "237-300x300.jpg",
			"size": 17648,
			"type": "image/jpeg"
		},
		{
			"id": "attyIh1qfLMhG3cRs",
			"url": "https://dl.airtable.com/.attachments/d0ad7f35ceccf083b7fab257a30fb5f4/d7946a7f/866-300x200.jpg",
			"filename": "866-300x200.jpg",
			"size": 6621,
			"type": "image/jpeg"
		},
		{
			"id": "attDB7cO0sbOZWb2Z",
			"url": "https://dl.airtable.com/.attachments/5d62b3a4b1480769d643095f842bf9e6/e748eabe/364-300x200.jpg",
			"filename": "364-300x200.jpg",
			"size": 15358,
			"type": "image/jpeg"
		}
	]
}

Autonumber

Overview

Field in Airtable

Data Type	Number

Setup

Add a Text element to a Column in your template

In Airtable, copy the field name to your clipboard

In the Documint template editor, click "+ New Variable" in the right sidebar

Paste the field name into the New Variable modal and click the generated variable

Paste it into the Text element added earlier

Sample Data

{
    "autonumber": 10
}

Checkbox

Overview

Data Type	Boolean
ExampleToken	{{ checkbox }}

Screenshot

Screenshot of the field in Airtable

Setup

Display value

To display the value add the variable to a text element.

A checkbox value will only display if it's true.

Screenshot of template

Use as condition

Select the element you want to conditionally show or hide based on the value of the checkbox field.

Enter the field name in the variable field, select the operator you would like to use then set the value to either true or false. When you're finished, click "Save".

Sample Data

// Example when value is true
{
  "checkbox": true,
}
// Example when value is false
{
  "checkbox": null,
}

Collaborator

Overview

The fields with the type of Collaborator are sent over as Objects.

Data Type	Object
Object Properties	id email permissionLevel name profilePicUrl
Example Token	{{ collaborator.name }}

Screenshot

Screenshot of the field in Airtable

Setup

Display value

To display the value add the variable to a text element.

Sample Data

{
    "collaborator": {
        "id": "usrwWTO4QBXFwqiRA",
        "email": "[e-mail]",
        "permissionLevel": "create",
        "name": "Josh Mamroud",
        "profilePicUrl": "https://static.airtable.com/images/userIcons/user_icon_10.png"
      }
}

... remaining fields coming soon!

Helpful Info

How to find Base Id

To find the ID of your Airtable base, first, visit airtable.com/api. Select from the list of bases the base whose ID you'd like to find out. The Base ID will be shown as in the screenshot below:

How to find Table Id

To find the Id of an Airtable table, navigate to the table then select the table Id from the address bar as in the screenshot below:

The table Id will start with tbl and end before the next /

Snake Case

Airtable fields names must be converted to snake-case when being used in your template. The basic rules of snake-case are:

1. spaces are converted to underscores

2. double underscores are converted to single underscores

3. underscores at the beginning or end of the string are removed

4. some special characters are replaced with underscores

5. all upper-case characters are converted to lower-case

The easiest way to convert your field names to snake-case is using the Airtable Variable Generator

Tools

Variable Generator - Converts your Airtable field names to Documint variables