Skip to main content

Airtable

This connector captures data from Airtable into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-airtable:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Prerequisites

  • An active Airtable account

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Airtable source connector.

Properties

Endpoint

The following properties reflect the API Key authentication method.

PropertyTitleDescriptionTypeRequired/Default
/api_keyAPI KeyAPI KeystringRequired
/access_tokenPersonal Access TokenThe Personal Access Token for the Airtable account.stringRequired

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource of your Airtable project from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-airtable:dev
config:
access_token: <secret>
api_key: <secret>
bindings:
- resource:
stream: users
syncMode: full_refresh
target: ${PREFIX}/users
{...}