Add or Update Contact with BigMailer API on New Email from Email API

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

Trigger workflow on

New Email from the Email 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 Email 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 Email trigger
1. Connect your Email account
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 Email on Email

Description:Get a unique address where you can send emails to trigger your workflow.

Version:0.0.1

Key:email-new-email

View on GitHub

Trigger Code#

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

export default {
  name: "New Email",
  version: "0.0.1",
  key: "email-new-email",
  description: "Get a unique address where you can send emails to trigger your workflow.",
  props: {
    email,
  },
  type: "source",
  methods: {},
  async run() {},
};

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
Email	`email`	`app`	This component uses the Email app.

Trigger Authentication#

The Email API does not require authentication.

About Email#

Trigger workflows on new emails, and send emails to yourself as part of a Pipedream workflow.

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,