Airtable

Categories: Productivity and Collaboration

Type: airtable/v1

Connections

Version: 1

Bearer Token

Properties

Name	Label	Type	Description	Required
token	Token	STRING		true

Connection Setup

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

Create a Personal Access Token in Airtable

Log in to your Airtable account.
Open the Personal access tokens page: https://airtable.com/create/tokens
Click +Create token.
Enter a descriptive Name for your token (for example, "ByteChef Token").
Add the required Scopes:
- data.records:read
- data.records:write
- schema.bases:read
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.
Click Create token and copy the token shown.

Actions

Create Record

Name: createRecord

Adds a record into an Airtable table.

Properties

Name	Label	Type	Description	Required
baseId	Base ID	STRING	ID of the base where table is located.	true
tableId	Table ID	STRING Depends On baseId	The table where the record will be created.	true
fields		DYNAMIC_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.

Delete Record

Name: deleteRecord

Deletes a single record from a table.

Properties

Name	Label	Type	Description	Required
baseId	Base ID	STRING	ID of the base where table is located.	true
tableId	Table ID	STRING Depends On baseId	ID of the table where the record is located.	true
recordId	Record ID	STRING 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"
}

Properties

Name	Type	Description
id	STRING	The ID of the deleted record.
deleted	BOOLEAN Options true, false	Indicates if the record was deleted.

Output Example

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

Get Record

Name: getRecord

Retrieves a single record.

Properties

Name	Label	Type	Description	Required
baseId	Base ID	STRING	ID of the base where table is located.	true
tableId	Table ID	STRING Depends On baseId	ID of the table where the record is located.	true
recordId	Record ID	STRING 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.

Update Record

Name: updateRecord

Update an existing record in an Airtable table.

Properties

Name	Label	Type	Description	Required
baseId	Base ID	STRING	ID of the base where table is located.	true
tableId	Table ID	STRING Depends On baseId	ID of the table where the record is located.	true
recordId	Row ID	STRING Depends On baseId, tableId	ID of the record that will be retrieved.	true
fields		DYNAMIC_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.

Triggers

New Record

Name: newRecord

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

Type: POLLING

Properties

Name	Label	Type	Description	Required
baseId	Base ID	STRING	ID of the base which contains the table that you want to monitor.	true
tableId	Table	STRING Depends On baseId	The table to monitor for new records.	true
triggerField	Trigger Field	STRING	It 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"
}

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.

On this page