Skip to main content
Skip table of contents

Airtable

Preparation

To install the Airtable Connector, you must first create an Airtable OAuth App in Airtable's Developer portal. When creating your OAuth App, you will need to provide your Cyclr Partner Service Domain so it's best to have that information to hand before you begin.

This is specific to your instance of Cyclr and can be found in your Cyclr Partner Console under Settings > General Settings > Service Domain.

Your Cyclr Partner may have been set up with a default Service Domain, but this can be changed if you would prefer to remove mentions of 'cyclr' from it. Contact Support for more.

Creating an OAuth App

Follow the instructions provided by Airtable here to create an OAuth App and reference the below when asked to enter these details:

  • Redirect URL(s) - you will need your Cyclr Partner Console‚Äôs Callback URL.

  • Permission scopes - It is best practice to use the minimum required for the methods you require.


After saving the app please take note of the Consumer Key (Client ID) and Secret (This will not be shown again) that are displayed for your app.

You should now take your Client ID and Client Secret values and store them in your Cyclr Console against the Airtable entry.

Additional Information

You will also need a Base ID and table name from Airtable to use the Airtable connector:

  • To get the Base ID, go to the API section in Airtable and select the table base you want to use. Copy the BaseID from the Introduction section.

  • The table name is the name of the table in the base (not the name of the base).

Cyclr account setup

Cyclr asks you for the below values when you install the connector into an account:

Value

Description

BaseID

The BaseID of the base you want Cyclr to use.

Table name

The name of the table you want Cyclr to use.

You can test the connector in one of your Cyclr accounts if you call a method to confirm it can return some data.

Airtable custom objects

The Airtable connector uses Cyclr custom objects to make methods dynamic based on module names. Each custom object name requires:

  • The BaseID of the table that you want to work with.

  • The table name of the table you want to interact with.

Note: The BaseID and table name can be different for each client account.

Set up a custom object

If you set up a custom object, you create a new method category with the parameters you enter. To set up a custom object:

  1. Go to the Airtable connector Settings page:

    • For template connectors, go to Templates > Template Connectors > Airtable > Edit Connector.

    • For connectors within a cycle, go to the Template Builder > Application Connectors > Airtable > Settings.

  2. Under the Methods and Fields heading, expand the Records (Custom Object) category.

  3. Select the red Copy this Category to create a Custom Object Category icon.

  4. Enter {BaseID}.{table name} into the Specify object name field. For example, appTCumMdMOC1Zcqz.TestTable.

  5. Select Copy.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.