ByteChef LogoByteChef

Airtable

Airtable is a user-friendly and flexible cloud-based database management tool.

Categories: Productivity and Collaboration

Type: airtable/v1


Connections

Version: 1

Bearer Token

Properties

NameLabelTypeDescriptionRequired
tokenTokenSTRINGtrue

Connection Setup

Connect Airtable to ByteChef using a Personal Access Token (PAT).

Create a Personal Access Token in Airtable

  1. Log in to your Airtable account.
  2. Open the Personal access tokens page: https://airtable.com/create/tokens
  3. Click +Create token.
  4. Enter a descriptive Name for your token (for example, "ByteChef Token").
  5. Add the required Scopes:
    • data.records:read
    • data.records:write
    • schema.bases:read
  6. Set Access for the token:
    • Choose one or more specific bases, an entire workspace, or all bases you own. For least privilege, select only the bases ByteChef needs to access.
  7. Click Create token and copy the token shown.

Actions

Create Record

Name: createRecord

Adds a record into an Airtable table.

Properties

NameLabelTypeDescriptionRequired
baseIdBase IDSTRINGID of the base where table is located.true
tableIdTable IDSTRING
Depends On baseId
The table where the record will be created.true
fieldsDYNAMIC_PROPERTIES
Depends On baseId, tableId
false

Example JSON Structure

{
  "label" : "Create Record",
  "name" : "createRecord",
  "parameters" : {
    "baseId" : "",
    "tableId" : "",
    "fields" : { }
  },
  "type" : "airtable/v1/createRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Base ID and Table ID

To find the Base ID, click here.

To find the Table ID, click here.

Delete Record

Name: deleteRecord

Deletes a single record from a table.

Properties

NameLabelTypeDescriptionRequired
baseIdBase IDSTRINGID of the base where table is located.true
tableIdTable IDSTRING
Depends On baseId
ID of the table where the record is located.true
recordIdRecord IDSTRING
Depends On tableId, baseId
ID of the record that will be deleted.true

Example JSON Structure

{
  "label" : "Delete Record",
  "name" : "deleteRecord",
  "parameters" : {
    "baseId" : "",
    "tableId" : "",
    "recordId" : ""
  },
  "type" : "airtable/v1/deleteRecord"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe ID of the deleted record.
deletedBOOLEAN
Options true, false
Indicates if the record was deleted.

Output Example

{
  "id" : "",
  "deleted" : false
}

Find Base ID, Table ID and Record ID

To find the Base ID, click here.

To find the Table ID, click here.

To find the Record ID, click here.

Get Record

Name: getRecord

Retrieves a single record.

Properties

NameLabelTypeDescriptionRequired
baseIdBase IDSTRINGID of the base where table is located.true
tableIdTable IDSTRING
Depends On baseId
ID of the table where the record is located.true
recordIdRecord IDSTRING
Depends On tableId, baseId
ID of the record that will be retrieved.true

Example JSON Structure

{
  "label" : "Get Record",
  "name" : "getRecord",
  "parameters" : {
    "baseId" : "",
    "tableId" : "",
    "recordId" : ""
  },
  "type" : "airtable/v1/getRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Base ID, Table ID and Record ID

To find the Base ID, click here.

To find the Table ID, click here.

To find the Record ID, click here.

Update Record

Name: updateRecord

Update an existing record in an Airtable table.

Properties

NameLabelTypeDescriptionRequired
baseIdBase IDSTRINGID of the base where table is located.true
tableIdTable IDSTRING
Depends On baseId
ID of the table where the record is located.true
recordIdRow IDSTRING
Depends On baseId, tableId
ID of the record that will be retrieved.true
fieldsDYNAMIC_PROPERTIES
Depends On baseId, tableId
false

Example JSON Structure

{
  "label" : "Update Record",
  "name" : "updateRecord",
  "parameters" : {
    "baseId" : "",
    "tableId" : "",
    "recordId" : "",
    "fields" : { }
  },
  "type" : "airtable/v1/updateRecord"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Find Base ID, Table ID and Record ID

To find the Base ID, click here.

To find the Table ID, click here.

To find the Record ID, click here.

Triggers

New Record

Name: newRecord

Trigger off when a new entry is added to the table that you have selected.

Type: POLLING

Properties

NameLabelTypeDescriptionRequired
baseIdBase IDSTRINGID of the base which contains the table that you want to monitor.true
tableIdTable IDSTRING
Depends On baseId
ID of the table to monitor for new records.true
triggerFieldTrigger FieldSTRINGIt is essential to have a field for Created Time or Last Modified Time in your schema since this field is used to sort records, and the trigger will not function correctly without it. Therefore, if you don't have such a field in your schema, please create one.true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Record",
  "name" : "newRecord",
  "parameters" : {
    "baseId" : "",
    "tableId" : "",
    "triggerField" : ""
  },
  "type" : "airtable/v1/newRecord"
}

Find Base ID and Table ID

To find the Base ID, click here.

To find the Table ID, click here.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.


Additional Instructions

How to find the Base ID

  1. Open your Airtable home screen.
  2. Open the base with the base ID you want to find.
  3. After opening your base, the URL in your browser's address bar will display your base ID, which looks similar to: https://airtable.com/appeqX9XTkHZNfSbn/pagIk60ZUF9P5UP72/
  4. Your base ID starts with app and ends before the next forward slash /.

How to find the Table ID

  1. Open your Airtable home screen.
  2. Open the base hosting the table with the table ID you want to find.
  3. After opening your table, the URL in your browser's address bar will display a URL, which looks similar to: https://airtable.com/appeqX9XTkHZNfSbn/tbl99vKzVh7NwLwm8/
  4. Your table ID starts with tbl and ends before the next forward slash /.

How to find Record ID

  1. Open your Airtable home screen.
  2. Open the base with the record ID you want to find.
  3. Expand the record with the ID you want to find.
  4. After expanding your record, the URL in your browser's address bar will display your record ID, which looks similar to: https://airtable.com/appSHwtnmVD5TiqSy/tblEzvkZks1VI3uyS/viwE3o43HKcqz6hFE/recbtRHd9o7vKZAQr?
  5. Your record ID starts with rec and ends before the question mark ?.

How is this guide?

Last updated on

On this page