Airtable OAuth Integration Setup Guide

This guide walks you through setting up an Airtable OAuth integration for SurfSense.

Step 1: Access Airtable OAuth Integrations

1. Navigate to airtable.com/create/oauth
2. In the Builder Hub, under Developers, click "OAuth integrations"
3. Click "Register an OAuth integration"

Step 2: Register an Integration

Fill in the basic integration details:

Click "Register integration"

Step 3: Configure Scopes

After registration, configure the required scopes (permissions) for your integration:

Record data and comments

Base schema

User metadata

Step 4: Configure Support Information

Scroll down to configure the support information and authorization preview:

The preview shows what users will see when authorizing SurfSense:

• The data in your records
• Comments in your records
• The structure of your base, like table names or field types
• Your email address

Click "Save changes"

Step 5: Get OAuth Credentials

After saving, you'll find your OAuth credentials on the integration page:

1. Copy your Client ID
2. Copy your Client Secret

⚠️ Never share your client secret publicly.

Running SurfSense with Airtable Connector

Add the Airtable environment variables to your Docker run command:

docker run -d -p 3000:3000 -p 8000:8000 \
  -v surfsense-data:/data \
  # Airtable Connector
  -e AIRTABLE_CLIENT_ID=your_airtable_client_id \
  -e AIRTABLE_CLIENT_SECRET=your_airtable_client_secret \
  -e AIRTABLE_REDIRECT_URI=http://localhost:8000/api/v1/auth/airtable/connector/callback \
  --name surfsense \
  --restart unless-stopped \
  ghcr.io/modsetter/surfsense:latest