← Integrations

Airtable

Read and write a user's Airtable bases, tables and records.

View on GitHub →

How to use it

This profile ships with Kirak. Add "integrations" to modules in kirak.json, then name the profile as below. There is nothing to download, and a copy in your project's integrations/ folder is an error.

Environment variables

VariableHolds
KIRAK_INTEGRATION_AIRTABLE_CLIENT_SECRETThe OAuth client secret from the vendor's console. Secret: keep it out of kirak.json and out of source control.
KIRAK_AUTH_ENCRYPTION_KEYSEncrypts stored tokens. Shared by every integration; the module refuses to start without it.

The names follow the integration's name in kirak.json (airtable here). Name it something else, such as airtable_sales, and the variables change to match.

Redirect URL

Register this as the redirect (callback) URL in the vendor's console, with your app's address in place of <your-app> (the base_url in kirak.json):

https://<your-app>/integrations/airtable/callback

How to get your keys

  1. Sign in to Airtable and open the OAuth integrations page.
  2. Choose Register new OAuth integration and give it a name.
  3. Add https://<your-app>/integrations/airtable/callback as the OAuth redirect URL.
  4. Under Scopes, tick at least these: data.records:read (Read records), user.email:read (Read the user’s email address)
  5. Save, then choose Generate client secret and copy the client ID and the secret.
  6. Put the client ID in kirak.json as integrations.providers.airtable.client_id, and the client secret in the environment as KIRAK_INTEGRATION_AIRTABLE_CLIENT_SECRET. Never put the secret in kirak.json.

The vendor's own guide · Instructions out of date? ·Suggest an edit

kirak.json

Scopes
{
  "integrations": {
    "providers": {
      "airtable": {
        "type": "oauth2",
        "profile": "airtable",
        "client_id": "your-client-id",
        "scope": [
          "data.records:read",
          "user.email:read"
        ]
      }
    }
  }
}

Merged into the profile: scope replaces the profile's default scopes.

Good to know

  • The account is read with the user.email:read scope, which the default scopes include.
  • Whether the authorize step requires PKCE, and the exact refresh request, are not confirmed against the vendor page yet.
  • Not verified against the vendor docs in this session: check the facts before release.

Help improve this profile

Report a problem ·Suggest an edit to profile.json ·Add a profile ·Vendor docs the profile was checked against

Product names and logos are trademarks of their respective owners. Their use does not imply endorsement. To ask for this icon to be removed, email trademark@kirak.io.

Ask about Kirak on