Airtable¶
Getting Started with Airtable¶
The Airtable modules allow you to monitor records and submitted forms, or search, retrieve, create, update and delete records in your Airtable account.
Prerequisites
- An Airtable account
In order to use Airtable with Ibexa Connect, it is necessary to have an Airtable account. If you do not have one, you can create an Airtable account at airtable.com/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Airtable to Ibexa Connect¶
-
Log in to your Airtable account.
-
Click on your profile icon in the top-right corner, select the Account option. Click Generate API key and copy the provided API Key.
-
Go to Ibexa Connect and open the Airtable module's Create a connection dialog.
-
Enter the API Key you have copied in step 2 to the respective field and click the Continue button to establish the connection.
The connection has been established. You can proceed with setting up the module.
Triggers¶
Watch Records¶
Triggers when a new record is added or updated in the table.
Base | Select the base that contains the table you want to watch for records. |
Table | Select the table you want to watch for new records. |
Trigger configuration | Trigger field Select the Created Time option to watch for new records or Last Modified Time option to watch for modified records.If you do not have a Created Time or Last Modified Time field in your scheme, we ask you to create one. Without this field, the trigger will not work correctly.A field that will be used as a label for a record, for example, in the Choose where to start dialog. Label field A field that will be used as a label for a record, for example, in the Choose where to start dialog. |
Limit | The maximum number of records Ibexa Connect will return during one execution cycle. |
View | Select the view you want to watch the records for. If selected, only the records in that view will be returned. |
Formula | Enter the formula to filter records. For more details about formulas, please refer to the Formula field reference documentation. The formula will be evaluated for each record, and if the result is not 0 , false , "" , NaN , [] , or #Error! , the record will be included in the response.If combined with the view parameter, only records in that view that satisfy the formula will be returned.For example, to only include records where Name isn't empty, pass in NOT({Name} = '') as a parameter like this:filterByFormula=NOT%28%7BName%7D%20%3D%20%27%27%29 |
Watch Responses¶
Triggers when a form is submitted.
Caution
Available for paid ***Pro Plan** *only. See the Airtable pricing page.
The webhook URL needs to be generated in Ibexa Connect and then added to the form configuration in the Airtable.
-
Add the Watch Responses module to your Ibexa Connect scenario.
-
Generate and copy the webhook URL.
-
Log in to your Airtable account.
-
Open the Base and the table you want to use for the form and create a Form view.
-
Set the form as needed, scroll down the form, and enable the Redirect to URL after the form is submitted option.
-
Enter the Webhook URL generated in step 2 to the displayed dialog box and add the ?record_id={record_id} just after the webhook URL to include the Record ID in the module's output, then click Save. The resulting URL will, for example, look like this:
https://hook.eu1.make.com/tgnp28pewooafbdgobvbh225hmocbn85?record_id={record_id}
-
Go back to your Ibexa Connect scenario and run the Watch Responses module only to load fields from Airtable and to be able to map those fields into the other modules.
-
Submit the form in Airtable where the Redirect to URL after the form is submitted option is enabled and Webhook URL added (step 6 above).
The Watch Responses module is triggered and the desired data are loaded.
-
Add the Airtable > Get a Record module just after the Airtable > Watch Responses module and map the record_id to the Record ID field.
Now, every time the form is submitted, the Watch Responses module in your Ibexa Connect scenario is triggered, and the Get a Record module returns the submitted form details.
Records¶
Search Records¶
Returns records based on the filter settings.
Base |
Select the base that contains the table you want to search for records. |
Table |
Select the table you want to search for records. |
Formula |
Enter the formula to filter records. For more details about formulas, please refer to the Formula field reference documentation. The formula will be evaluated for each record, and if the result is not If combined with the For example, to only include records where Name isn't empty, pass in
|
Sort |
Specify sorting, if needed. The higher item in the list has precedence. |
View |
Select the view you want to search for the records. If selected, only the records in that view will be returned. |
Limit |
Set the maximum number of records Ibexa Connect will return during one execution cycle. |
Get a Record¶
Retrieves record details.
Base | Select the base that contains the table with the record you want to retrieve. |
Table | Select the table that contains the record you want to retrieve details for. |
Record ID | Enter (map) the ID of the record you want to retrieve details for. |
Create a Record¶
Creates a new record in a selected table.
Base | Select the base that contains the table you want to create a record in. |
Table | Select the table you want to create a record in. |
* Record * | Enter values to the desired fields. See also Airtable's guide to basic field types. |
Smart links | Enable this option if you want to enter names instead of record IDs to fields that link to another table. The record is automatically created in the linked table if there is no match. |
Update a Record¶
Updates an existing record.
Base |
Select the base that contains the table you want to update a record in. |
|||
Table |
Select the table you want to update a record in. |
|||
Records ID |
Enter (map) the ID of the record you want to update. You can retrieve the ID, for example, using the Search Records or Watch Records module. |
|||
Record |
Enter values to the fields you want to update. See also Airtable's guide to basic field types. | In order to delete the content of the field, use the |
Smart links
Enable this option if you want to enter names instead of record IDs to fields that link to another table. The record is automatically created in the linked table if there is no match.
Upsert a Record¶
Creates a record when you don't specify a record ID. Updates a record if the record ID is specified.
Base |
Select the base that contains the table you want to update or create a record in. |
Table |
Select the table where you want to create or update a record. |
Record ID |
Enter (map) the ID of the record you want to update. If no ID is entered, a new record will be created. You can retrieve the ID, for example, using the Search Records or Watch Records module. If you enter an ID that does not exist, the error is returned and no action is performed. |
Record |
Enter values to the fields you want to update or create. See also Airtable's guide to basic field types. |
Smart links |
Enable this option if you want to enter names instead of record IDs to fields that link to another table. The record is automatically created in the linked table if there is no match. |
Delete a Record¶
Deletes a specified record.
Base | Select the base that contains the table you want to delete a record from. |
Table | Select the table you want to delete the record from. |
Record ID | Enter the ID of the record you want to delete. You can retrieve the ID, for example, using the Search Records or Watch Records module. |
Other¶
Make an API Call¶
Allows you to perform a custom API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Airtable REST API Documentation. |
Method
Select the HTTP method you want to use:
-
GET to retrieve information for an entry.
-
POST to create a new entry.
-
PUT to update/replace an existing entry.
-
PATCH to make a partial entry update.
-
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Dashboards¶
The following API call returns all records in the specified table in your Airtable account:
URL:
/v0/{base_id}/{table_id}
Method:
GET
The result can be found in the module's Output under Bundle > Body > records. In our example, 11 records were returned:
Related Blog Articles¶
9 Airtable Integrations You Can Deploy in Minutes With Ibexa Connect
How to Create an Emergency Communication System Using Airtable And Ibexa Connect
How to connect Chatfuel to Airtable
How to connect Airtable and Google Contacts and synchronize contacts between these services
Changelog for the Airtable App¶
last update: 2020-10-09 (v3)¶
New modules:
-
Watch Responses - instant trigger (for a paid plan only)
-
Upsert a record - create/update a record
Create, Update, and Upsert modules:
-
When a column's name changes, it has no negative effect on a scenario. Now, the column's IDs are used.
-
Added support for datetime fields (time is supported).
-
Computed fields are not displayed.