Airtable

Airtable is a low-code, easy-to-use online platform that helps to create and share relational databases. This platform provides a simple, friendly, and visual platform that is helpful for building collaborative applications to customize your workflow and collaborate for achieving an effective outcome. This platform connects data, people, and workflows across the organization that allowing each employee to use a single source.

Authorization

Basic Auth

The Airtable API generally uses API keys to authenticate requests. These requests can be managed and viewed in the Airtable dashboard. The authentication to the API is conducted by the HTTP Basic Auth. To authenticate basic auth for Airtable you need to provide the basic auth username value, you are not needed to provide a password. If you need to authenticate via bearer auth (e.g., for a cross-origin request), use -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" instead of -u sk_test_4eC39HqLyjWDarjtT1zdp7dc.

All API requests must be made over Http . Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl https://api.stripe.com/v1/charges\-u sk_test_4eC39HqLyjWDarjtT1zdp7dc: # The colon prevents curl from asking for a password.

Key

Description

Example

Key

Description

Example

Username

Provide the username for accessing the basic auth. An username is needs to be unique for the particular users.

Q9hgig21300

For more information please visit Airtable Basic

API Key and Base ID

The API key for Airtable allows you to use the public API for creating, fetching, updating, and deleting records based on your access to the platform. This authentication key follows the similar permissions that are required in the Airtable UI account.

The Airtable API key is using a Headers i.e., Bearer key. It consists of various id, fields, and attachments. In the attachments you will be able to get the below information's

  • File name

  • id

  • URL

  • Size

  • Type

Key

Description

Example

Key

Description

Example

Flie Name

Provide the name of the file.

Sample

ID

This sections provides the id. It’s a unique number associated with a specific file. It can be a combination of alpha numerical.

reQI97sWpp0

URL

From this section you will be able to copy the specific URL.

https://dl.airtable.com/uR6dOEH

Size

This sections provides the size of the file.

3127893

Type

You will get the details for the file type used in the API key.

Image/doc etc.

You can also get the list of records along with their specific id’s from the URL. In this field you can ask for sending the API order for the authorization purpose.

Example of authorization URL:

Get :https://api.airtable.com/v0/app0QAWP12/Artistview?main

You can get the API key and base id by selecting the specific field. You can get the base id from the documentation.

The metadata API uses token-based authentication like Airtable's standard REST API. You will need to paste their Airtable account's API key (available from your account page) into your integration. Send the API key in the Authorization header of all your requests:

Authorization: Bearer $USER_API_KEY

After you receive a client secret from us, you must send an X-Airtable-Client-Secret HTTP header with all your requests to help us identify and authenticate your integration. If you fail to do this, your request will be blocked.

X-Airtable-Client-Secret: foo-123123

Finally, please perform all requests to these endpoints server-side. Client-side requests are not allowed because they would expose the user's API token.

GEThttps://api.airtable.com/v0/meta/bases

Returns the list of bases the API key can access in the order they appear on the user's home screen, 1000 bases at a time. If there is another page to request, pass the offset as a URL query parameter. (e.g. ?offset=itr23sEjsdfEr3282/appSW9R5uCNmRmfl6)

The Airtable component uses an API key and Base ID for authentication.

Input

Notes

Example

Input

Notes

Example

API Key

You can generate an APIthe key from Airtable account.

keyvTlNCTqEXAMPLE

Airtable Base ID

Visit Airtable and select your workspace. The ID of your base will be printed for you in green.

appGJJCPlhEXAMPLE

 

The more type of field will be added in the future and this will not be considered a breaking change. API consumers are expected to handle unknown field types gracefully.

autoNumber, barcode, button, checkbox, count, createdBy, createdTime, currency, date, dateTime, duration, email, externalSyncSource, formula, lastModifiedBy

lastModifiedTime, multilineText, multipleAttachments, multipleCollaborators, multipleLookupValues

This Airtable API authentication gives you the ability to list all of your bases, tables, fields, and views.

If you want to develop an integration using the Metadata API, you must register here for access and to receive a client secret. Enterprise Airtable accounts do not require a separate Metadata API client secret.

Note that we don't consider adding keys to response objects a breaking change, so the shape of objects may change without notice, but existing keys won't be changed or removed without notice.

This is a single string that is the authentication of the API request, sent in an HTTP “Authorization” header. You can authenticate to the API by providing your API key in the HTTP authorization bearer token header.

  • In the Airtbale Datasource Section.

  • Select Bearer Token as the authentication type.

  • Now, paste your API key and click Save.

You can create queries to fetch, update and delete data from a datasource using the application query editor. Airtable supports the following query methods:

 

Query Name

Description

Query Name

Description

​List Records​

Fetches all the records from the Airtable database.

​Create Records​

Creates a new record in the Airtable database.

​Delete A Record​

Delete a specific record ID.

Retrieve A Record​

Retrieve an existing record.

Update Records​

Update a few fields in a record

Revoke the Secret

You are not supposed to revel your API key, however, if it get revealed accidentally then you need to regenerate your API key as soon as possible from https://airtable.com/account. You can also delete your API key if required, to do so you need to click on the Delete Key option. Once you click on this option you will get a warning that performing this process will break your API integrations. To proceed further you need to choose the red Yes, click on the delete key button to confirm your key deletion.

Key

Description

Example

Key

Description

Example

Family

Mention the connection type name.

API

Category

Add the categories for the API key.

Other

Company

Provide the name of the company for which the API key is generated.

Airtable

High recall

Mention the status for the algorithm returns for the most of the relevant results

True

Validity check available

Provide the status for the availability of validity check.

True

On-premise instances exist

Mention the status for the on-premise instance exists. It generally comes in a True and False.

False

Only valid secrets raise an alert

Provide the status for the valid secrets raise an alert. This status is associated with the “True” and “False” options

True

Minimum number of matches

Add the requirement and allowed minimum number of matches. In this scenario the minimum number for matching API key is 1. That can exceed based on the requirement

1

Occurrences found for one million commits

Here you need to mention the details for finding the occurrence for one million commits.

16.22

Prefixed

Mention the requirement and status for the Prefixed. It can be choose as “True” or “False”

True

PreValidators

With the help of PreValidators you can validate in advance.

Check data duplication

For more information visit Airtable Documentation

Oauth 2.0

Most of the API 's are required to do some authorization to secure their authentication process. Generally this process involves entering of API key or token that can function similarly to the passwords. This authentication framework is an alternative way that enable you to securely connect with the third party to their account by minimizing the requirement of manual credentials updating.

You need to select it from the available authentication types to integrate with an Airtable database:

  • Airtable API key allows you to use public API to create, fetch, update, and delete records on the bases you have access to the Airtable platform.

  • Bearer Tokens are the predominant access token used with OAuth 2.0.

Most APIs require authentication to access their data. This is likely the first part of their documentation. Try searching for the word Authentication in their documentation. Below are the authentication types supported on Sapper:

The most common types of authentication are Bearer Tokens, Username/Password (also referred to as Basic and API token ), and OAuth 2.0. Sapper has integrated these authentication types directly into this step.

Bearer Token

In this method you will be required to send your API Key or Token as a Bearer token. Get a detailed information from the below example:

From this example the below part indicates it’s a bearer token

To add this specific token in Sapper, you need to select Bearer Token from the Authorization menu and add sk_test_WiyegCaE6iGr8eSucOHitqFF as the Bearer Token Value.

Username/Password (Basic)

After the generation of Bearer Token now you need to generate and use the Username and Password for further authentication. Most of the username and password are used for the sign in purpose into the service that can be entered here. Although, In some cases for the API key the username, password or the both elements are used. In this scenario you need to provide the API key in the respective field mentioned in the below documentation.

The Endpoint URL shows a DELETE request being made to a resource called customers. The authorization type can be identified as Basic for two reasons:

  1. The -u indicates Basic Authorizationusername.

  2. Most APIs reference the username and password formatted as

  3. Username : password.

  4. There is a colon : This indicates that only a username is required for authentication.

Airtable Connections

Airtable Basic Auth Connections

Input 

Key 

Description

Example 

Select application

application

Select Airtable application

 

Connection type

connection type

Select the type of connection.

REST

Rest connection type

Rest Connection Type

Select the Basic connection type

Basic

Connection name

name

Provide a name for the connection.

Airtable

Connection description

description

Provide a description for the connection.

 

Host name

host 

Provide a string value for the URL of the user's Airtable account.

 

Username

username

Provide a valid username for the given Airtable account.

exampleUser 

Password

password 

Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. 

exampleSecurePassword 

Header field

header

Provide the path of the endpoint for authentication.

Authorization

Header prefix header

header prefix

Select the header prefix -
Basic, Bearer, Token, None

 

 

Airtable API Key Connections

Input 

Key 

Description

Example

Select application

application

Select Airtable application

 Airtable

Connection Mode

mode

Select custom connection mode

Custom

Connection type

connection type

Select the type of connection.

 REST

REST connection type

rest connection type

Select the type of REST connection.

 API Key

Connection name

name

Provide a name for the connection.

 Airtable connection

Connection description

description

Provide a description for the connection.

 

Host name

host 

Provide a string value for the URL of the user's Airtable account.

 

Key

key

Provide the key for the connection.

 

Value

value

Add the value for the connection

 

Header Parameter

header

Header parameters are used for user-defined custom HTTP headers for a request.

 

Query Parameter

query

Query parameters are a defined set of parameters attached to the end of a URL.

 

 

 

Airtable Oauth 2.0 Connection

 

Input 

Key 

Description

Example

Select application

application

Select Airtable application

 Airtable

Connection type

connection type

Select the type of connection.

 REST

REST connection type

rest connection type

Select the type of REST connection.

 OAuth2.0

Connection name

name

Provide a name for the connection.

 Airtable connection

Connection description

description

Provide a description for the connection.

 

Host name

host 

Provide a string value for the URL of the user's Airtable account.

 

Grant type

grant type

Provide the grant type - authorization code, password, client credentials.

 

Actions

Create Record In Table

Create Record In Table | key: createRecordinTable

 

 

Key

Description

Example

Key

Description

Example

Workspace ID

It’s a unique id associated with a particular workspace. This ID is a combination of text and string starting with wsp is your Airtable browser address bar.

wspBHSbFDdQCkyKtJ

Table Name

Provide the name of the table for Airtable.

Sample table

Record Name

Records are the individual items in a table. In this section you need to provide the name of the record.

Sample record

Record Email

In this section you need to provide the email details associated with the particular record.

Sample@sapper.ai

Record Phone Number

This section is associated with a specific phone number associated with a specific Airtable record.

+1-541-754-3010

Company

Add the company name associated with the particular record.

Sapper

Comment

Provide a comment for the specific record if required

Sample text


Create Record for Salesforce Opportunities

Create Record for Salesforce Opportunities | key: createRecordforSalesforceOpportunities

 

Key

Description

Example

Key

Description

Example

Name

Provide the name of the Salesforce opportunity

Sample

Close Date

Mention the close date for the specific Salesforce opportunity

25/10/2022

Owner ID

Mention the id of the owner associated with Salesforce Opportunity.

00G80000001QW2m

Stage Name

Enter the name of the stage.

Final

ID

Provide the ID for the Salesforce Opportunity. It’s generally form in a 15 digit.

DQ89HJ10tg349AS

Created Date

Mention the opportunity created date for Salesforce.

21/06/2022


Create Record for Hubspot Deals

Create Record for Hubspot Deals | key: createRecordforHubspotDeals

Key

Description

Example

Key

Description

Example

Deal ID

A deal ID is a system generated digit that assigned to a particular deal.

3961278807007882311

Portal ID

Mention the Portal ID associated with the specific record and deal. This ID is a combination of alphanumeric format.

3e9df6032430

Deal Name

Provide the name of the deal. This is a unique name associated with a specific deal.

Sample Deal

HubSpot Owner ID

The HubSpot owner id is a unique id associated with a particular user.

00G807800001QW2m

Deal Stage

Mention the deal stage associated with the particular record.

1st stage


Get Records For Salesforce Users

Get Records For Salesforce Users | key: getRecordforSalesforceUsers

 

Key

Description

Example

Key

Description

Example

ID

Enter the id for creating the record , it will be an unique id associated with a specific record.

Eh00139EqW

Name

Provide the name for the record creation. It can be an unique name associated with a particular record.

Sample