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
- Find or generate your Airtable API key from your account settings page (opens in a new tab).
- Copy the API key into Dynaboard and click the ✓ to the right of the field to save it.
- 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
- Airtable URLs have the following format
- 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
Prop | profiles |
---|---|
Type | array |
Default | [ { 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
Prop | profiles[] |
---|---|
Type | object |
Default | undefined |
A profile of this resource for an environment
API Key
Prop | profiles[].apiKey |
---|---|
Type | ({ ref: string } | undefined) |
Default | undefined |
The Airtable API key to use for the connection.
Base ID
Prop | profiles[].baseID |
---|---|
Type | string |
Default | undefined |
The ID of the base. Begins with app
.
Environment
Prop | profiles[].environment |
---|---|
Type | string |
Default | undefined |
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.
Parameter | Type | Default |
---|---|---|
tableName | string | undefined |
fields | unknown | undefined |
filterByFormula | string | undefined |
sort | unknown | undefined |
view | string | undefined |
cellFormat | string | undefined |
timeZone | string | undefined |
userLocale | string | undefined |
Create Records
Creates one or more records in the Airtable base.
Parameter | Type | Default |
---|---|---|
tableName | string | undefined |
records | unknown | undefined |
Update Records
Updates one or more records in the Airtable base.
Parameter | Type | Default |
---|---|---|
tableName | string | undefined |
records | unknown | undefined |
Delete Records
Delete one or more records from an Airtable base.
Parameter | Type | Default |
---|---|---|
tableName | string | undefined |
recordIDs | unknown | [] |
Retrieve Record
Retrieve a record from an Airtable base using its unique ID.
Parameter | Type | Default |
---|---|---|
tableName | string | undefined |
id | string | undefined |