← Airtable

New, Modified or Deleted Records from Airtable API

Pipedream makes it easy to connect APIs for Airtable and 700+ other apps remarkably fast.

Trigger workflow on
New, Modified or Deleted Records from the Airtable API
Next, do this
Connect to 700+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New, Modified or Deleted Records with Airtable API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New, Modified or Deleted Records trigger
    1. Connect your Airtable account
    2. Configure timer
    3. Select a Base
    4. Select a Table
  2. Add steps to connect to 700+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

New, Modified or Deleted Records on Airtable
Description:Emits an event each time a record is added, updated, or deleted in an Airtable table. Supports tables up to 10,000 records
Version:0.1.0
Key:airtable-new-modified-or-deleted-records

Code

import moment from "moment";
import axios from "axios";
import Bottleneck from "bottleneck";

import common from "../common.mjs";

const limiter = new Bottleneck({
  minTime: 200, // 5 requets per second
});
const axiosRateLimiter = limiter.wrap(axios);

export default {
  ...common,
  name: "New, Modified or Deleted Records",
  key: "airtable-new-modified-or-deleted-records",
  version: "0.1.0",
  type: "source",
  description:
    "Emits an event each time a record is added, updated, or deleted in an Airtable table. Supports tables up to 10,000 records",
  props: {
    ...common.props,
    tableId: {
      propDefinition: [
        common.props.airtable,
        "tableId",
        ({ baseId }) => ({
          baseId,
        }),
      ],
    },
  },
  async run(event) {
    const {
      baseId,
      tableId,
      viewId,
    } = this;

    const metadata = {
      baseId,
      tableId,
      viewId,
    };

    const config = {
      url: `https://api.airtable.com/v0/${encodeURIComponent(baseId)}/${encodeURIComponent(tableId)}`,
      params: {},
      headers: {
        Authorization: `Bearer ${this.airtable.$auth.api_key}`,
      },
    };

    const prevAllRecordIds = this.db.get("prevAllRecordIds");

    const lastTimestamp = this.db.get("lastTimestamp");
    config.params.filterByFormula = `LAST_MODIFIED_TIME() > "${lastTimestamp}"`;

    const { data } = await axios(config);

    let allRecordIds = [],
      newRecordsCount = 0,
      modifiedRecordsCount = 0,
      deletedRecordsCount = 0;

    if (data.records) {
      for (const record of data.records) {
        if (!lastTimestamp || moment(record.createdTime) > moment(lastTimestamp)) {
          record.type = "new_record";
          newRecordsCount++;
        } else {
          record.type = "record_modified";
          modifiedRecordsCount++;
        }

        record.metadata = metadata;

        this.$emit(record, {
          summary: `${record.type}: ${JSON.stringify(record.fields)}`,
          id: record.id,
        });
      }
    }

    delete config.params.filterByFormula;

    while (allRecordIds.length === 0 || config.params.offset) {
      const { data } = await axiosRateLimiter(config);
      if (!data.records.length || data.records.length === 0) return;
      allRecordIds = [
        ...allRecordIds,
        ...data.records.map((record) => record.id),
      ];
      if (data.offset) {
        config.params.offset = data.offset;
      } else {
        delete config.params.offset;
      }
    }

    if (prevAllRecordIds) {
      const deletedRecordIds = prevAllRecordIds.filter(
        (prevRecord) => !allRecordIds.includes(prevRecord),
      );
      for (const recordID of deletedRecordIds) {
        deletedRecordsCount++;
        const deletedRecordObj = {
          metadata,
          type: "record_deleted",
          id: recordID,
        };
        this.$emit(deletedRecordObj, {
          summary: "record_deleted",
          id: recordID,
        });
      }
    }

    console.log(
      `Emitted ${newRecordsCount} new records(s) and ${modifiedRecordsCount} modified record(s) and ${deletedRecordsCount} deleted records.`,
    );
    this.db.set("prevAllRecordIds", allRecordIds);

    // We keep track of the timestamp of the current invocation
    this.updateLastTimestamp(event);
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
AirtableairtableappThis component uses the Airtable app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
timer$.interface.timer
BasebaseIdstringSelect a value from the drop down menu.
TabletableIdstringSelect a value from the drop down menu.

Authentication

Airtable uses API keys for authentication. When you connect your Airtable account, Pipedream securely stores the keys so you can easily authenticate to Airtable APIs in both code and no-code steps.

Airtable uses simple token-based authentication. To generate or manage your API key, visit your account settings.

get airtable api key

About Airtable

Looks like a spreadsheet, acts like a database.