Add or Update Contact with BigMailer API on New or Modified Records from Airtable API

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

Trigger workflow on

New or Modified Records from the Airtable API

Next, do this

Add or Update Contact with the BigMailer API

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#

This integration creates a workflow with a Airtable trigger and BigMailer action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
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
Configure the Add or Update Contact action
1. Connect your BigMailer account
2. Select a Brand ID
3. Configure Email
4. Select one or more List ID
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

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

Airtable Overview#

Airtable (OAuth) API on Pipedream allows you to manipulate and leverage your Airtable data in a myriad of powerful ways. Sync data between Airtable and other apps, trigger workflows on updates, or process bulk data operations asynchronously. By using Airtable's structured databases with Pipedream's serverless platform, you can craft custom automation solutions, integrate with other services seamlessly, and streamline complex data processes.

Trigger 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,
};

Trigger 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.

Trigger 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

About Airtable#

Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.

Action#

Add or Update Contact on BigMailer

Description:Creates or updates a contact within a brand. [See the documentation](https://docs.bigmailer.io/reference/upsertcontact)

Version:0.0.1

Key:bigmailer-add-update-contact

View on GitHub

BigMailer Overview#

The BigMailer API enables you to automate your email marketing by interacting with your BigMailer account programmatically. On Pipedream, you can leverage this API to create workflows that respond to events, manage contacts, campaigns, and analyze the effectiveness of your email strategies. By connecting BigMailer to other apps on Pipedream, you can orchestrate complex automations and streamline your email operations.

Action Code#

import bigmailer from "../../bigmailer.app.mjs";

export default {
  key: "bigmailer-add-update-contact",
  name: "Add or Update Contact",
  description: "Creates or updates a contact within a brand. [See the documentation](https://docs.bigmailer.io/reference/upsertcontact)",
  version: "0.0.1",
  type: "action",
  props: {
    bigmailer,
    brandId: {
      propDefinition: [
        bigmailer,
        "brandId",
      ],
      reloadProps: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact. If the specified email does not exist, a new contact is created. If the specified email exists, the existing contact is updated.",
    },
    listIds: {
      propDefinition: [
        bigmailer,
        "listIds",
        (c) => ({
          brandId: c.brandId,
        }),
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.brandId) {
      return props;
    }
    const fields = await this.getFields();
    for (const field of fields) {
      props[field.id] = {
        type: field.type === "integer"
          ? "integer"
          : "string",
        label: `${field.name}`,
        description: `${field.name} value`,
      };
    }
    return props;
  },
  methods: {
    async getFields() {
      const fields = this.bigmailer.paginate({
        resourceFn: this.bigmailer.listFields,
        args: {
          brandId: this.brandId,
        },
      });
      const results = [];
      for await (const field of fields) {
        if (field.merge_tag_name !== "EMAIL") {
          results.push(field);
        }
      }
      return results;
    },
  },
  async run({ $ }) {
    const fieldValues = [];
    const fields = await this.getFields();
    for (const field of fields) {
      const type = (field.type === "integer" || field.type === "date")
        ? field.type
        : "string";
      fieldValues.push({
        name: field.merge_tag_name,
        [type]: this[field.id],
      });
    }

    const response = await this.bigmailer.upsertContact({
      $,
      brandId: this.brandId,
      data: {
        email: this.email,
        field_values: fieldValues,
        list_ids: this.listIds,
      },
    });

    if (response?.id) {
      $.export("$summary", `Successfully created or updated contact with ID ${response.id}.`);
    }

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
BigMailer	`bigmailer`	`app`	This component uses the BigMailer app.
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	Email address of the contact. If the specified email does not exist, a new contact is created. If the specified email exists, the existing contact is updated.
List ID	`listIds`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API key,

Navigate to your BigMailer account and sign in
Go to “Account” > “API”

About BigMailer#

Email Marketing platform for agencies and makers - unlimited brands/users, all email campaign types, support when you need it.

More Ways to Connect BigMailer + Airtable#

Other Popular Integrations#

Create Comment with Airtable API on New Contact Created from BigMailer API

BigMailer + Airtable

Add or Update Contact with BigMailer API on New or Modified Records from Airtable API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

1
-
24
of
2,200+
apps by most popular