New or Modified Records from Airtable API

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

Trigger workflow on

New or Modified Records from the Airtable API

Next, do this

Connect to 2,400+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

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

Configure the New or Modified Records trigger
1. Connect your Airtable account
2. Configure timer
3. Select a Base
4. Select a Table
5. Optional- Select one or more Field IDs
6. Optional- Configure Return Fields By Field ID
Add steps to connect to 2,400+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on New or Modified Records from Airtable (OAuth) API

Airtable + Discord Webhook

Try it

Get Film with SWAPI - Star Wars API on New or Modified Records from Airtable API

Airtable + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on New or Modified Records from Airtable (OAuth) API

Airtable + Airtable (API Key)

Try it

Send any HTTP Request with HTTP / Webhook API on New or Modified Records from Airtable API

Airtable + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New or Modified Records from Airtable API

Airtable + Ahrefs

Try it

Details#

This is a pre-built, source-available 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 or Modified Records on Airtable

Description:Emit new event for each new or modified record in a table

Version:0.0.8

Key:airtable_oauth-new-or-modified-records

View on GitHub

Code#

import base from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";
import moment from "moment";

export default {
  ...base,
  name: "New or Modified Records",
  key: "airtable_oauth-new-or-modified-records",
  description: "Emit new event for each new or modified record in a table",
  version: "0.0.8",
  type: "source",
  props: {
    ...base.props,
    tableId: {
      propDefinition: [
        base.props.airtable,
        "tableId",
        ({ baseId }) => ({
          baseId,
        }),
      ],
      description: "The table ID to watch for changes.",
    },
    fieldIds: {
      propDefinition: [
        base.props.airtable,
        "sortFieldId",
        ({
          baseId, tableId,
        }) => ({
          baseId,
          tableId,
        }),
      ],
      type: "string[]",
      label: "Field IDs",
      description: "Identifiers of spedific fields/columns to watch for updates",
      withLabel: true,
    },
    returnFieldsByFieldId: {
      propDefinition: [
        base.props.airtable,
        "returnFieldsByFieldId",
      ],
    },
  },
  methods: {
    ...base.methods,
    _getFieldValues() {
      return this.db.get("fieldValues") || {};
    },
    _setFieldValues(fieldValues) {
      this.db.set("fieldValues", fieldValues);
    },
    updateFieldValues(newFieldValues, record) {
      const fieldKey = this.returnFieldsByFieldId
        ? "value"
        : "label";
      for (const fieldId of this.fieldIds) {
        newFieldValues[record.id] = {
          ...newFieldValues[record.id],
          [fieldId.value]: record.fields[fieldId[fieldKey]] || null,
        };
      }
      return newFieldValues;
    },
    isUpdated(fieldValues, fieldIds, record) {
      const fieldKey = this.returnFieldsByFieldId
        ? "value"
        : "label";
      for (const fieldId of fieldIds) {
        if (!record.fields[fieldId[fieldKey]]) {
          record.fields[fieldId[fieldKey]] = null;
        }
        if (fieldValues[record.id]
          && fieldValues[record.id][fieldId.value] !== undefined
          && record.fields[fieldId[fieldKey]] !== fieldValues[record.id][fieldId.value]
        ) {
          return true;
        }
      }
      return false;
    },
  },
  async run(event) {
    const {
      baseId,
      tableId,
      viewId,
    } = this;

    const lastTimestamp = this._getLastTimestamp();
    const fieldValues = this._getFieldValues();
    const isFirstRunWithFields = this.fieldIds && Object.keys(fieldValues).length === 0;
    const params = {
      returnFieldsByFieldId: this.returnFieldsByFieldId || false,
    };
    if (!isFirstRunWithFields) {
      params.filterByFormula = `LAST_MODIFIED_TIME() > "${lastTimestamp}"`;
    }

    const records = await this.airtable.listRecords({
      baseId,
      tableId,
      params,
    });

    if (!records.length) {
      console.log("No new or modified records.");
      return;
    }

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

    let newRecords = 0, modifiedRecords = 0;
    let newFieldValues = {
      ...fieldValues,
    };
    for (const record of records) {
      if (this.fieldIds) {
        newFieldValues = this.updateFieldValues(newFieldValues, record);
      }
      if (!lastTimestamp || moment(record.createdTime) > moment(lastTimestamp)) {
        record.type = "new_record";
        newRecords++;
      } else {
        if (this.fieldIds
          && (!this.isUpdated(fieldValues, this.fieldIds, record) || isFirstRunWithFields)
        ) {
          continue;
        }
        record.type = "record_modified";
        modifiedRecords++;
      }

      record.metadata = metadata;

      this.$emit(record, {
        summary: `${record.type}: ${JSON.stringify(record.fields)}`,
        id: record.id,
        ts: Date.now(),
      });
    }
    this._setFieldValues(newFieldValues);
    console.log(`Emitted ${newRecords} new records(s) and ${modifiedRecords} modified record(s).`);

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

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.

Label	Prop	Type	Description
Airtable	`airtable`	`app`	This component uses the Airtable app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Base	`baseId`	`string`	Select a value from the drop down menu.
Table	`tableId`	`string`	Select a value from the drop down menu.
Field IDs	`fieldIds`	`string[]`	Select a value from the drop down menu.
Return Fields By Field ID	`returnFieldsByFieldId`	`boolean`	An optional boolean value that lets you return field objects where the key is the field id. This defaults to `false`, which returns field objects where the key is the field name.

Authentication#

Airtable uses OAuth authentication. When you connect your Airtable account, Pipedream will open a popup window where you can sign into Airtable and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Airtable API.

Pipedream requests the following authorization scopes when you connect your account:

data.records:readdata.records:writedata.recordComments:readdata.recordComments:writeschema.bases:readschema.bases:writewebhook:manageuser.email:read