-
Couldn't load subscription status.
- Fork 132
feat: airtable integration docs #2041
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 4 commits
1981cea
136710c
c9241ec
9b1441d
2e91727
34c5dda
d9312d1
d22deca
0eede6c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| title: Airtable integration | ||
| description: Connect Apify with Airtable. | ||
| sidebar_label: Airtable | ||
| sidebar_position: 4 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bug: Sidebar Position Conflict Between FilesThe sidebar_position is set to 4, which conflicts with console_integration.md that also has sidebar_position: 4. Since both files are in the same directory and index.md should be the main page while console_integration.md is a sub-section, they should have different sidebar positions. The index.md should have a lower position number than console_integration.md (e.g., index.md: 4, console_integration.md: 5). |
||
| slug: /integrations/airtable | ||
| --- | ||
|
|
||
| **Learn how to integrate Apify with Airtable. This article shows you how to use the Apify extension on Airtable.** | ||
|
|
||
| --- | ||
|
|
||
| [Airtable](https://www.airtable.com/) is a cloud-based platform for organizing, managing, and collaborating on data. With Apify integration for Airtable, you can automatically upload Actor run results to Airtable after a successful run. | ||
|
|
||
| This integration uses OAuth 2.0, a secure authorization protocol, to connect your Airtable account to Apify and manage data transfers. | ||
|
|
||
| ## Connect Apify with Airtable | ||
|
|
||
| To use the Apify integration for Airtable, ensure you have: | ||
|
|
||
| - An [Apify account](https://console.apify.com/) | ||
| - An [Airtable account](https://www.airtable.com/) | ||
|
|
||
| ## Types of integration | ||
|
|
||
| You could integrate Apify with Airtable using one of two available options. This guide explain how to use the extension which is the recommended integration. | ||
|
|
||
| - **Apify Extension** on Airtable website. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **console integration** on the Actor page. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This guide will explain how to use the **Apify extension**, for the console integration just go to the *Console integration* page in the docs. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Setup | ||
|
|
||
| ### Install Apify extension | ||
|
|
||
| Go to [Airtable](https://airtable.com) and open the base you would like to work with. Press the **tools button** on the right side of the screen and press the **Add an extension button**. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| <!-- TODO: improve pictures when Apify integration is published --> | ||
| Search for Apify extenison and install it | ||
|
|
||
|  | ||
|
|
||
| Open the Apify extension and login using OAuth 2.0 with your Apify account. If you dont have an account, visit [Apify Registration](https://console.apify.com/sign-up) page. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|  | ||
|
|
||
| ## Extension Overview | ||
|
|
||
| Apify extension helps you map and import data into your Airtable base | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Features | ||
|
|
||
| - Run Actors | ||
| - Run tasks | ||
| - Get dataset items | ||
| - Map and import the data into your base | ||
|
|
||
|  | ||
|
|
||
| ### Run Actor | ||
|
|
||
| 1. Select any Actor from `Apify store` or `recently used Actors` | ||
|  | ||
|
|
||
| 1. Fill in the Actor input form. | ||
|  | ||
|
|
||
| 1. Run the Actor and wait for results | ||
|  | ||
|
|
||
| ### Data Mapping | ||
|
|
||
| This section will explain how to map your run results or dataset items into your Airtable base | ||
|
|
||
| #### Mapping row | ||
|
|
||
| Apify extension has UI elements that allow you to map dataset fields to Airtable fields. | ||
|
|
||
|  | ||
|
|
||
| **Source:** dataset field from Apify. | ||
|
|
||
| **Target:** Target Airtable field label. For mode `new` it creates new fields in your table | ||
|
|
||
| **Field Type:** Displays the type of the target Airtable field. For `new` mode you need to also specify this field. | ||
|
|
||
| #### Select Fields to Map | ||
|
|
||
| The preview window next to the mapping rows will help you view and pick fields from the dataset. | ||
| "." character in the labels point to the children elements of an object | ||
|
|
||
| **Example Source**: crawl.depth <br/> | ||
| **Apify Field**: | ||
|
|
||
| ```bash | ||
| { | ||
| crawl: { | ||
| depth: 3, | ||
| } | ||
| } | ||
| ``` | ||
|
||
|
|
||
|  | ||
|
|
||
| #### Automatic field matching | ||
|
|
||
| Apify extension looks at the field labels in your table and matches them with dataset fields giving you a default list of mappings. | ||
|
|
||
| **How does it work:** <br/> | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Source: `crawl.depth` | ||
| it checks for fields in your table with label either `depth` or `crawl.depth`. If there is a match it adds a mapping row automatically. | ||
|
|
||
|
|
||
| #### Duplicate filtering | ||
|
|
||
| Select a **unique ID** on the data mapping step. The unique ID will be added to the list of mapping rows. | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Make sure it points to the correct field in your table. While importing the data will be filtered by existing values in the table. | ||
|  | ||
|
|
||
| #### Preview Mapped Data | ||
|
|
||
| Preview the results and start the import | ||
|
|
||
|  | ||
|
|
||
| ### Run Task | ||
|
|
||
| You can select and run any saved Apify task directly from the extension to reuse preconfigured inputs. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ### Get Dataset | ||
|
|
||
| Retrieve items from any Apify dataset and import them into your Airtable base with a single click. | ||
|
|
||
|  | ||
protoss70 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.