Skip to content

Commit 1981cea

Browse files
committed
feat: airtable integration docs
1 parent 9c5907e commit 1981cea

14 files changed

+130
-10
lines changed

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sources/platform/integrations/data-storage/airtable.md renamed to sources/platform/integrations/data-storage/airtable/console_integration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Airtable integration
3-
description: Learn how to integrate Apify with Airtable
4-
sidebar_label: Airtable
2+
title: Airtable integration on Apify console
3+
description: Learn how to integrate Airtable on the Apify console
4+
sidebar_label: Console integration
55
sidebar_position: 4
6-
slug: /integrations/airtable
6+
slug: /integrations/airtable/console
77
---
88

99
**Learn how to integrate your Apify Actors with Airtable. This article shows you how to automatically upload results to your Airtable when an Actor run succeeds.**
@@ -26,11 +26,11 @@ To use the Apify integration for Airtable, ensure you have:
2626
1. In Apify Console, go to the [API & Integrations tab](https://console.apify.com/settings/integrations) in the **Settings** section.
2727
1. Under **Account-level integrations**, click **Add account**.
2828

29-
![Add account button in Account-level integrations section of the settings](../images/airtable/connect-account-1.png)
29+
![Add account button in Account-level integrations section of the settings](../../images/airtable/connect-account-1.png)
3030

3131
1. Select **Airtable** from the list of available services.
3232

33-
![Connect with Airtable button among other buttons for connection of other available services](../images/airtable/connect-account-2.png)
33+
![Connect with Airtable button among other buttons for connection of other available services](../../images/airtable/connect-account-2.png)
3434

3535
1. Follow the OAuth 2.0 authorization flow to securely connect your Airtable account.
3636

@@ -42,7 +42,7 @@ To use the Apify integration for Airtable, ensure you have:
4242

4343
1. Go to the **Integrations** tab and click **Upload data to Airtable**.
4444

45-
![Airtable integration option among other available integrations](../images/airtable/set-up-integration-1.png)
45+
![Airtable integration option among other available integrations](../../images/airtable/set-up-integration-1.png)
4646

4747
1. Select the upload mode:
4848
- **CREATE**: New table is created for each run of this integration.
@@ -55,9 +55,9 @@ To use the Apify integration for Airtable, ensure you have:
5555

5656
To ensure uniqueness when using CREATE mode, use dynamic variables. If a table with the same name already exists in CREATE mode, a random token will be appended.
5757

58-
![Airtable integration configuration form](../images/airtable/set-up-integration-2.png)
58+
![Airtable integration configuration form](../../images/airtable/set-up-integration-2.png)
5959

6060
1. Save the integration. Once your Actor runs, you'll see its results uploaded to Airtable.
6161

62-
![Airtable table filled with data](../images/airtable/set-up-integration-3.png)
62+
![Airtable table filled with data](../../images/airtable/set-up-integration-3.png)
6363

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
title: Airtable integration
3+
description: Connect Apify with Airtable.
4+
sidebar_label: Airtable
5+
sidebar_position: 4
6+
slug: /integrations/airtable
7+
---
8+
9+
**Learn how to integrate Apify with Airtable. This article shows you how to use the Apify extension on Airtable.**
10+
11+
---
12+
13+
[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.
14+
15+
This integration uses OAuth 2.0, a secure authorization protocol, to connect your Airtable account to Apify and manage data transfers.
16+
17+
## Connect Apify with Airtable
18+
19+
To use the Apify integration for Airtable, ensure you have:
20+
21+
- An [Apify account](https://console.apify.com/)
22+
- An [Airtable account](https://www.airtable.com/)
23+
24+
## Types of integration
25+
26+
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.
27+
28+
- **Apify Extension** on Airtable website.
29+
- **console integration** on the Actor page.
30+
31+
This guide will explain how to use the **Apify extension**, for the console integration just go to the *Console integration* page in the docs.
32+
33+
## Setup
34+
35+
### Install Apify extension
36+
37+
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**.
38+
39+
![Access the extensions tab on Airtable UI by pressing tools button](../../images/airtable/airtable_tools_button.png)
40+
41+
<!-- TODO: improve pictures when Apify integration is published -->
42+
Search for Apify extenison and install it
43+
44+
![Search for the Apify extension on Airtable](../../images/airtable/airtable_search_apify_extenison.png)
45+
46+
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.
47+
48+
![Open Apify extension and login](../../images/airtable/airtable_login.png)
49+
50+
## Extension Overview
51+
52+
Apify extension helps you map and import data into your Airtable base
53+
54+
### Features
55+
- Run Actors
56+
- Run tasks
57+
- Get dataset items
58+
- Map and import the data into your base
59+
60+
![Apify extension overview](../../images/airtable/airtable_overview.png)
61+
62+
### Run Actor
63+
1. Select any Actor from `Apify store` or `recently used Actors`
64+
![Select Actor screen](../../images/airtable/airtable_actor_select.png)
65+
66+
1. Fill in the Actor input form.
67+
![Configure Actor screen](../../images/airtable/airtable_configure_actor.png)
68+
69+
1. Run the Actor and wait for results
70+
![Run the Actor](../../images/airtable/airtable_actor_run.png)
71+
72+
### Data Mapping
73+
74+
This section will explain how to map your run results or dataset items into your Airtable base
75+
76+
#### Mapping row
77+
78+
Apify extension has UI elements that allow you to map dataset fields to Airtable fields.
79+
80+
![Run the Actor](../../images/airtable/airtable_mapping_row.png)
81+
82+
**Source:** dataset field from Apify.
83+
84+
**Target:** Target Airtable field label. For mode `new` it creates new fields in your table
85+
86+
**Field Type:** Displays the type of the target Airtable field. For `new` mode you need to also specify this field.
87+
88+
#### Select Fields to Map
89+
The preview window next to the mapping rows will help you view and pick fields from the dataset.
90+
"." character in the labels point to the children elements of an object
91+
92+
**Example Source**: crawl.depth <br/>
93+
**Apify Field**:
94+
```bash
95+
{
96+
crawl: {
97+
depth: 3,
98+
}
99+
}
100+
```
101+
![Preview dataset fields](../../images/airtable/airtable_field_previews.png)
102+
103+
#### Automatic field matching
104+
105+
Apify extension looks at the field labels in your table and matches them with dataset fields giving you a default list of mappings.
106+
107+
**How does it work:** <br/>
108+
Source: `crawl.depth`
109+
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.
110+
111+
112+
#### Duplicate filtering
113+
Select a **unique ID** on the data mapping step. The unique ID will be added to the list of mapping rows.
114+
Make sure it points to the correct field in your table. While importing the data will be filtered by existing values in the table.
115+
![Select unique ID](../../images/airtable/airtable_unique_id.png)
116+
117+
#### Preview Mapped Data
118+
Preview the results and start the import
119+
120+
![Preview Mapped Data](../../images/airtable/airtable_preview.png)
127 KB
Loading
127 KB
Loading
160 KB
Loading
235 KB
Loading
91.6 KB
Loading
46.6 KB
Loading
155 KB
Loading

0 commit comments

Comments
 (0)