-
Notifications
You must be signed in to change notification settings - Fork 133
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
Open
protoss70
wants to merge
9
commits into
master
Choose a base branch
from
feat/airtable-integration-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
1981cea
feat: airtable integration docs
protoss70 136710c
feat: run task and get dataset
protoss70 c9241ec
fix: linting fix
protoss70 9b1441d
fix: more linting fixes
protoss70 2e91727
fix: documentation improvement
protoss70 34c5dda
fix: fix order of sections
protoss70 d9312d1
Merge remote-tracking branch 'origin/master' into feat/airtable-integ…
protoss70 d22deca
fix: minor improvement to field selection docs
protoss70 0eede6c
feat: add operations section data mapping
protoss70 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
145 changes: 145 additions & 0 deletions
145
sources/platform/integrations/data-storage/airtable/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| --- | ||
| title: Airtable integration | ||
| description: Connect Apify with Airtable. | ||
| sidebar_label: Airtable | ||
| sidebar_position: 4 | ||
| 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. | ||
| - _Console integration_ on the Actor page. | ||
|
|
||
| This guide will explain how to use the _Apify extension_, for Apify Console integration go to the _Console integration_ page in the docs. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Install Apify extension | ||
|
|
||
| Go to [Airtable](https://airtable.com) and open the base you would like to work with. Press the **Tools** dropdown in the top right corner and click **Extensions**. | ||
|
|
||
|  | ||
|
|
||
| <!-- 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. | ||
|
|
||
|  | ||
|
|
||
| ## Extension Overview | ||
|
|
||
| Apify extension helps you map and import data into your Airtable base. | ||
|
|
||
| ### 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 | ||
|  | ||
|
|
||
| ### 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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 | ||
|
|
||
| ```bash | ||
| { | ||
| crawl: { | ||
| depth: 'the field you selected', | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| #### 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 | ||
|
|
||
| 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. | ||
|
|
||
| #### Import operations | ||
|
|
||
| 1. **CREATE**: New table is created for each run of this integration. | ||
| 2. **APPEND**: New records are added to the specified table. If the table does not yet exist, new one is created. | ||
| 3. **OVERWRITE**: All records in the specified table are replaced with new data. If the table does not yet exist, new one is created. | ||
|
|
||
| #### Duplicate filtering | ||
|
|
||
| Select a **Unique ID** on the data mapping step. The unique ID will be added to the list of mapping rows. | ||
| 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 | ||
|
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+127 KB
sources/platform/integrations/images/airtable/airtable_actor_select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+160 KB
sources/platform/integrations/images/airtable/airtable_configure_actor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+235 KB
sources/platform/integrations/images/airtable/airtable_field_previews.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+46.6 KB
sources/platform/integrations/images/airtable/airtable_mapping_row.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+238 KB
sources/platform/integrations/images/airtable/airtable_search_apify_extenison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+186 KB
sources/platform/integrations/images/airtable/airtable_tools_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Sidebar Position Conflict Between Files
The 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).