Skip to main content

Airtable Component

Manage items (records) in an Airtable Base

Component key: airtable

Description#

Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet. This component allows you to list, create, delete, and update records in an Airtable Base.

Airtable developer documentation can be found here.

Airtable Connections#

Airtable API Key and Base ID#

The Airtable component uses an API key and Base ID for authentication.

  • To obtain an API key, log in to Airtable and navigate to https://airtable.com/account. Generate an API key from the Overview page.
  • To find your Base ID, visit https://airtable.com/api and select your workspace. The ID of your base is printed in green under the Introduction section of this page.
InputNotesExample
Input
API Key
string
/ Required
Notes
You can generate an API key from https://airtable.com/account.
Example
keyvTlNCTqEXAMPLE
Input
Airtable Base ID
string
/ Required
Notes
Visit https://airtable.com/api and select your workspace. The ID of your base will be printed for you in green.
Example
appGJJCPlhEXAMPLE

Actions#

Create Record#

Create a new record in the given table | key: createRecord

InputNotesExample
Input
Connection
connection
/ Required
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Record Fields
string
/ Required
Key Value List
Notes
A record is the base equivalent of a row in a spreadsheet.
Example
 
Input
Table Name
string
/ Required
Notes
Provide the name of the table you would like to access.
Example
myExampleTable

Output Example Payload#

{  "data": {    "id": "recZ6jmpj3EXAMPLE",    "createdTime": "2022-06-01T17:50:40.000Z",    "fields": {      "Notes": "We finished this and we're ready to move on to our backlog",      "Status": "Complete",      "Start date": "2022-05-31",      "Projects": "Updated sales process",      "Another": 0    }  }}

Delete Records#

Delete one or many records inside of the given table | key: deleteRecord

InputNotesExample
Input
Connection
connection
/ Required
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Record IDs
string
/ Required
Value List
Notes
In each field, place a key value pair (JavaScript Object) that resembles a table record.
Example
 
Input
Table Name
string
/ Required
Notes
Provide the name of the table you would like to access.
Example
myExampleTable

Output Example Payload#

{  "data": [    {      "id": "reckdVO4K0EXAMPLE",      "deleted": true    },    {      "id": "recNl3cmL7EXAMPLE",      "deleted": true    }  ]}

Get Record#

Retrieve a record by id from the given table | key: getRecord

InputNotesExample
Input
Connection
connection
/ Required
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Record Id
string
/ Required
Notes
Within Airtable, each record has a unique identifier known as a Record ID. If you are familiar with Entity-Relationship Diagrams or ERDs, then the record id would be the primary key.
Example
rec6r4kNmGDk5D52F
Input
Table Name
string
/ Required
Notes
Provide the name of the table you would like to access.
Example
myExampleTable

Output Example Payload#

{  "data": {    "id": "recZ6jmpj3EXAMPLE",    "createdTime": "2022-06-01T17:50:40.000Z",    "fields": {      "Notes": "We finished this and we're ready to move on to our backlog",      "Status": "Complete",      "Start date": "2022-05-31",      "Projects": "Updated sales process",      "Another": 0    }  }}

List Records#

List all records inside of the given table | key: listRecords

InputNotesExample
Input
Connection
connection
/ Required
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Fields
string
Value List
Notes
Enter the names (or IDs) of the fields you would like returned. If you omit this list, all fields will be returned.
Example
Notes
Input
Filter By Formula
string
Notes
Filter results to only records that meet some particular criteria.
Example
AND({Quantity} * {Price} > 100, NOT({Shipped?}))
Input
Table Name
string
/ Required
Notes
Provide the name of the table you would like to access.
Example
myExampleTable
Input
View
string
Notes
The name or ID of a view in your table. If set, only records in that view will be returned, sorted in the way that the view is sorted.
Example
Grid view

Filtering Records#

You can filter for specific records using the Filter By Formula input. For example, if you want only records where the product of the Quantity and Price fields is greater than 100, and the record's Shipped? field is not checked, you can use a formula like this:

AND({Quantity} * {Price} > 100, NOT({Shipped?}))

Full documentation on Airtable formula is available on their support site.

Output Example Payload#

{  "data": [    {      "id": "recZ6jmpj3Example",      "createdTime": "2022-06-01T17:50:40.000Z",      "fields": {        "Notes": "We finished this and we're ready to move on to our backlog",        "Status": "Complete",        "Start date": "2022-05-31",        "Projects": "Updated sales process",        "Another": 0      }    },    {      "id": "reczFSd0aaEXAMPLE",      "createdTime": "2022-06-01T17:50:40.000Z",      "fields": {        "Notes": "Everything is going well! Expect to launch on time",        "Status": "In progress",        "Start date": "2022-06-04",        "Projects": "Q4 product launch",        "Another": 0      }    }  ]}

Raw Request#

Issue a raw HTTP request with the configured connection | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
Default
Notes
 
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
binary
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Update Record#

Update a record's content inside a given table | key: updateRecord

InputNotesExample
Input
Connection
connection
/ Required
Notes
Access keys provide programmatic access to access resources in AWS. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html.
Example
 
Input
Record Id
string
/ Required
Notes
Within Airtable, each record has a unique identifier known as a Record ID. If you are familiar with Entity-Relationship Diagrams or ERDs, then the record id would be the primary key.
Example
rec6r4kNmGDk5D52F
Input
Record Fields
string
/ Required
Key Value List
Notes
A record is the base equivalent of a row in a spreadsheet.
Example
 
Input
Table Name
string
/ Required
Notes
Provide the name of the table you would like to access.
Example
myExampleTable

Output Example Payload#

{  "data": {    "id": "recZ6jmpj3EXAMPLE",    "createdTime": "2022-06-01T17:50:40.000Z",    "fields": {      "Notes": "We finished this and we're ready to move on to our backlog",      "Status": "Complete",      "Start date": "2022-05-31",      "Projects": "Updated sales process",      "Another": 0    }  }}