---
description: >-
  Airtable is a cloud collaboration service. It’s a spreadsheet-database hybrid:
  has the capabilities of a database applied to a spreadsheet.
---

# Airtable

{% hint style="warning" %}
This integration is currently unavailable. We are working towards resolving the issue. \
Please subscribe to the newsletter for updates on our fix.
{% endhint %}

With this integration you can search, read, and update data in your Airtable database much easier  than having to create an API.

You can connect your Airtable App in 2 ways:

1\. [Via Action b](#a.-via-action-bot-dialog)lock when you are building your bot

2\. [From Chatlayer's homepage menu](#b.-from-chatlayers-homepage-menu): mainly before building your bot, when you know you’re going to create requests to one or more Airtable tables

{% hint style="warning" %}
Depending on your [Airtable plan](https://support.airtable.com/docs/airtable-plans), you will have a different maximum number of rows that you can have. Make sure your plan suits your needs before building your database.
{% endhint %}

## 1 – Via Action block

Configure your Airtable App directly in an Action block by clicking the option 'Add action' and then 'Integration':

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FS8F6fNL0hqBnctBmq5mu%2F0?alt=media)

If there is no Airtable app configured yet (as described in part 2 of this guide), a pop-up will appear:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FbExyyh1AmEhqpsaSd2I7%2F1?alt=media)

You can find your API Key in you Airtable Account page. Find out more [d](https://support.airtable.com/hc/en-us/articles/219046777-How-do-I-get-my-API-key-).

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F6gIW2571Rglat1eM9W3i%2F2?alt=media)

Or you can also regenerate key:&#x20;

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F5fW145pPw6apcdN3TUkv%2F3?alt=media)

When clicking the API Key, you’ll be able to see it. So click, select, copy and paste it into the correspondent field of the pop-up:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FWx9qTLjF4qvkToUGl2WF%2F4?alt=media)

You’ll see a new field to select integrations from. Choose 'Airtable'

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Fe3e421zZvODH42QWJIlH%2F5?alt=media)

In the Airtable Account field, you’ll see all Apps that you might have already created following the steps in the second part of this guide, or you can create a new one by clicking the 'Connect new account':

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FfjsK2e3yi8ig89fd0nCB%2F6?alt=media)

Once you pick the integrated App that you already have (or you created a new one), you’ll see the 'Select Action' field. There are three possible actions: Search, Create and Update records from your Airtable

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F4bGxMv0LQDFGHmq9qtiM%2F8?alt=media)

Three new empty fields will appear in this screen. Here’s how you should fill them in:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FLasKyYbsfnMJa7QleELa%2F9?alt=media)

You’ll get the information for the field “Base” from the Airtable URL. The URL syntax is:

https://airtable.com/**appXXXXXXX\[use this for “Base”]**/**tblYYYYYY\[use this for “Table”]**/…

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FBWiTiPoXY1WPtwlcrqiJ%2F10?alt=media)

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Fqc03tHTiBkykWpNduuee%2F11?alt=media)

This is what your Action block will look like once it’s filled in:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F27dTBxY9FC5zHs6hyfTW%2F12?alt=media)

For the Search Action, fill in the 'Search Field' (use the name of your table's column) and Search Value (a [variable ](../../navigation/settings/secure-variables-gdpr)that user will input, that should match one of the Search Field's data point) **or** create your own Search Formula.\


More information on what to fill if you want to use the 'Search Formula' option [here](https://support.airtable.com/hc/en-us/articles/203255215-Formula-field-reference).

Now build your answer syntax:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FBxm8QYeYokqQKxSqSvtu%2Fimage.png?alt=media\&token=914cabdd-0d2e-4e91-8f0d-cde6324ec3db)

You'll know it's right when your bot displays the correct data from your table:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F2pyaiEjEMDD5F6ccFXcu%2Fimage.png?alt=media\&token=45f0abc9-1431-4f1c-b298-5d2a2f6c8a65)

## 2. From Chatlayer's homepage menu

You can set up the Airtable integration directly from the left side menu on [app.chatlayer.ai](https://app.chatlayer.ai/)

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FnV6XmjZJt5ymuUlb4r1W%2F13?alt=media)

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F8WkIxkKWe61bacsMQQbR%2F14?alt=media)

You can also create it by clicking '+ Add Account' button, after which you’ll see this pop-up:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FeE7dCLrtKdpjyB5lKERi%2F15?alt=media)

You can find your API Key in your Airtable Account page. Find out more [here](https://support.airtable.com/hc/en-us/articles/219046777-How-do-I-get-my-API-key-)

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F9QBRtU4dLLHGnv9HTMIx%2F16?alt=media)

Or you can regenerate a key:

![Graphical user interface, text, application, email

Description automatically generated](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F49NYKzLavnZjFTtZo24Z%2F17?alt=media)

When clicking the API Key, you’ll be able to see it. Click, select, copy and paste it into the correspondent field of the pop-up:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FR4OdAFwEbJGl7nd6yqOd%2F18?alt=media)

This is what it will look like when you’ve successfully connected

![
](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FoqcbehFU35io6iQxsv43%2F19?alt=media)

When clicking the three dots on the right, you can manage your app integration. There are four actions:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Fcy5hKyAfucZS1Eti6oxR%2F20?alt=media)

* Reconnect: it will open up a new pop-up allowing you to change the API Key
* Test Connection (soon)
* Change Account Name: will open up a pop-up so you can rename your integrated App
* Remove: **Attention!** When clicking this button, your App integration will **immediately** be removed

![Reconnect](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Fgt3ZdVU3Fu9tbi58Wuns%2Fimage.png?alt=media\&token=7295f202-2579-49ef-9f89-4ee63bc4c3df)

![Change Account Name](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2F7GLchPJ8u2H2ulUB91vI%2Fimage.png?alt=media\&token=4b4dd7cc-4aa8-4c17-b669-6f261a5e6f7e)

![Remove](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FJXnq7JhHa3aT7LqUn1qO%2Fimage.png?alt=media\&token=8bb8a704-8b45-4cc2-a649-0c70a31b0d6e)

## How to use each type of Action possible in the Airtable App Integration

Search, Create and Update Record are the possible actions:

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FAk52p78Frel4fXTCZxyI%2Fimage.png?alt=media\&token=0c79f3d5-55aa-4ac6-8cd6-6c9b56adc7b2)

### Create Record

To create a record, you must select the Airtable App and the Airtable account (either connecting to an existing one or connection to another), choose the Create Record action, inform Base and Table, as explained in A.8.1(link).

The following step is to fill out the Record fields. In the left-side blank, the name of the column in your Airtable should be informed, and in the right-side blank, the “hard-coded” value or variable (in curly brackets) should be informed.

In the example below, the column to be updated is called ‘Number’ and the variable is called `numberChosen`. The variable informed by the user was saved in a previous step through an [Input Validation](https://docs.chatlayer.ai/bot-answers/dialog-state/user-input-bot-dialog) block.

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FTjVoQ6jK4Vj61OcEBLlw%2Fimage.png?alt=media\&token=4bca902a-442a-4fc4-8dc7-464f4d750bdc)

### Update Record

To Update a record, you must select the Airtable App and the Airtable account (either connecting to an existing one or connection to another), choose the Update Record action, inform Base and Table, as explained in A.8.1(link).

Read about Record ID and Cell Values fields below the picture.

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2FZQmjXReuJTQt0zDK5XlI%2Fimage.png?alt=media\&token=5fb96cc1-1632-43a0-ac88-e6ad93f156b6)

#### Airtable Record ID

The Record ID is the one highlighted in the URL from the screenshot below – you cannot use the value informed by the customer alone, to refer to the correct ID, you collect the ID informed by the customer in a variable (though an Input Validation xv).

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Fjrd9x6HY7AD3GGq0S3Wy%2Fimage.png?alt=media\&token=5b8874af-dd30-464e-9b68-96e2c3eaa810)

The correct syntax to retrieve the Record ID is `{apps.airtable.read_record._id}`

In Cell Values, the name of the column where the value will be updated is informed on the left-side blank, in this case ‘Number’, and the variable which has the new value saved under it in the right-side blank, in this example `{numberUpdate}`

The following screenshot shows an example of the flow that are explained in the table further down.

![](https://2786867680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LLTwFwbOqJj4dDhg8Ju%2Fuploads%2Faaj0p61wlElF6lMpifmM%2Fimage.png?alt=media\&token=3a2a7224-d072-4bc7-84d1-f3326467afff)



| **Bot Dialog**         | **Variable or action taken**                                                                                                                                                                                                                                                         |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Create update          | User passes the current data point thet they would like to update, which will be saved under variable `{ticketToUpdate}`                                                                                                                                                             |
| Get ticket id          | Action taken is the Search Record, with Search Value as the `{ticketToUpdate}` variable                                                                                                                                                                                              |
| Get value update       | The user informs the updated value that will be saved under variable `{numberUpdate}`                                                                                                                                                                                                |
| Read and update ticket | <p>Record Id is retrieved from Airtable using <code>{apps.airtable.read_record._id}</code></p><p>Cell values informed are the column name (in this case, Number) and variable saved in the previous step <code>{numberUpdate}</code> is passed as the new value for that ticket.</p> |

Now you're all set to create a personalized bot experience for your customers!
