Airtable
Version 24.2.8980
Version 24.2.8980
Airtable
You can use the Airtable connector from the CData Sync application to capture data from Airtable and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.
Add the Airtable Connector
To enable Sync to use data from Airtable, you first must add the connector, as follows:
-
Open the Connections page of the Sync dashboard.
-
Click Add Connection to open the Select Connectors page.
-
Click the Sources tab and locate the Airtable row.
-
Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Airtable connector. For more information about installing new connectors, see Connections.
Authenticate to Airtable
After you add the connector, you need to set the required properties.
On the New Connection page, enter the connection name of your choice.
CData Sync supports authenticating to Airtable in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.
- PersonalAccessToken
- OAuthPKCE (default)
Personal Access Token
To connect with a personal access token (PAT), set the following properties:
-
Auth Scheme - Select PersonalAccessToken.
-
OAuth Access Token - Enter the PAT that you use to connect to Airtable by using OAuth.
To create a PAT:
-
Log in to your Airtable account.
-
Click your account in the upper right of the window. From the menu that opens, click Developer Hub. This option brings you to the Personal Access Token page.
-
On the Personal Access Token page, click Create new token. This step opens configuration options for the PAT that you are creating.
-
Name the PAT.
-
Click Add a scope to add each of the following:
-
data.records:read
-
data.records:write
-
schema.bases:read
-
-
Under Access, add all the workspaces and bases that you want the token to access.
-
Click Create token to generate the token. Copy and save the generated token because it will be displayed only once.
-
OAuth PKCE
To connect with the OAuth PKCE extension, select OAuthPKCE for Auth Scheme. This scheme does not require any additional settings.
Complete Your Connection
To complete your connection:
-
Specify the following properties:
-
Base Id (optional) - Enter your Airtable base identifier. To locate this value, navigate to the Airtable API Reference and select a base. The base Id is available in the endpoint that is shown in the introduction section of the selected base (for example, https://api.airtable.com/v0/meta/bases/BaseId/collaborators).
Note: This property is not required when the Metadata API is enabled. However, specifying this property when the API is enabled restricts the metadata that is retrieved.
-
Base Name (optional) - Enter the schema that you want to use that corresponds to the name of the base in Airtable. This property is available only when the Metadata API is enabled.
-
Display Object Ids (optional) - Select True if you want to replace schema, table, view, and column names with their corresponding internal identifiers. The default value is False.
-
Use Simple Names (optional) - Select True if you want to use simple names for tables and columns. The default value is False.
-
-
Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
-
Click Create & Test to create your connection.
More Information
For more information about interactions between CData Sync and Airtable, see Airtable Connector for CData Sync.