Reference
Nodes
Resources
Airtable

Airtable Resource

The Airtable Resource makes it easy to pull data out of your Airtable bases and display or process it within Dynaboard.

Configuration Steps

  1. Find or generate your Airtable API key from your account settings page (opens in a new tab).
  2. Copy the API key into Dynaboard and click the ✓ to the right of the field to save it.
  3. Find your base ID by navigating to the desired Airtable base and copying the ID beginning with app from the URL.
    • Airtable URLs have the following format https://airtable.com/baseID/tableID/viewID/recordID?blocks=hide
  4. Copy the base ID into Dynaboard and click "Test Connection" at the bottom of the panel to verify everything works!

Common Configuration Errors

  • A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.
  • If you're having trouble writing to a connected base, make sure that your account has the appropriate permissions for the base in Airtable. Your API key has the same permissions as your account.

Properties

Environment Profiles

Propprofiles
Typearray
Default[ { 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject
Defaultundefined

A profile of this resource for an environment

API Key

Propprofiles[].apiKey
Type({ ref: string } | undefined)
Defaultundefined

The Airtable API key to use for the connection.

Base ID

Propprofiles[].baseID
Typestring
Defaultundefined

The ID of the base. Begins with app.

Environment

Propprofiles[].environment
Typestring
Defaultundefined

The name of the environment with which this profile is associated

Actions

List Records

Lists records within the Airtable base according to the provided filter, sort, and pagination arguments.

ParameterTypeDefault
tableNamestringundefined
fieldsunknownundefined
filterByFormulastringundefined
sortunknownundefined
viewstringundefined
cellFormatstringundefined
timeZonestringundefined
userLocalestringundefined

Create Records

Creates one or more records in the Airtable base.

ParameterTypeDefault
tableNamestringundefined
recordsunknownundefined

Update Records

Updates one or more records in the Airtable base.

ParameterTypeDefault
tableNamestringundefined
recordsunknownundefined

Delete Records

Delete one or more records from an Airtable base.

ParameterTypeDefault
tableNamestringundefined
recordIDsunknown[]

Retrieve Record

Retrieve a record from an Airtable base using its unique ID.

ParameterTypeDefault
tableNamestringundefined
idstringundefined