New Open from Mailchimp API

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

Trigger workflow on

New Open from the Mailchimp API

Next, do this

Connect to 2,500+ 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 Open with Mailchimp API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Open trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Campaign ID
4. Configure Unique Opens Only?
Add steps to connect to 2,500+ 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 Open from Mailchimp API

Mailchimp + Discord Webhook

Try it

Get Film with SWAPI - Star Wars API on New Open from Mailchimp API

Mailchimp + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on New Open from Mailchimp API

Mailchimp + Airtable (API Key)

Try it

Send any HTTP Request with HTTP / Webhook API on New Open from Mailchimp API

Mailchimp + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New Open from Mailchimp API

Mailchimp + 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 Open on Mailchimp

Description:Emit new event when a recipient opens an email in a specific campaign.

Version:0.0.2

Key:mailchimp-new-open

View on GitHub

Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "mailchimp-new-open",
  name: "New Open",
  description: "Emit new event when a recipient opens an email in a specific campaign.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.mailchimp,
        "campaignId",
      ],
      description: "The unique ID of the campaign you'd like to watch for new email opens on links.",
    },
    uniqueOpensOnly: {
      type: "boolean",
      label: "Unique Opens Only?",
      description: "Whether to count every open campaign email or only count opens coming from each subscriber only once",
      default: false,
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      return this.emitReportSampleEvents(this.campaignId, undefined, (Date.now()));
    },
  },
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "opens",
      ];
    },
    generateMeta({
      eventPayload,
      diff: openDiff,
      timestamp: ts,
    }) {
      const { campaign_id: campaignId } = eventPayload;
      return {
        id: `${campaignId}-${ts}`,
        summary: `${openDiff} new opens`,
        ts,
      };
    },
    getCachedCampaignDetails() {
      return {
        total_opens: this.getDbServiceVariable("total_opens"),
        members: this.getDbServiceVariable("members"),
      };
    },
    async getCampaignDetails() {
      return this.mailchimp.listCampaignOpenDetails(
        this.campaignId,
      );
    },
    getNodataErrorMessage() {
      return "No campaign found.";
    },
    getCurrentCampaignDetails(campaignOpenReport) {
      return {
        total_opens: campaignOpenReport.total_opens,
        members: campaignOpenReport.members,
      };
    },
    getDetailsDiff(currentCampaignOpenReport, cachedCampaignOpenReport) {
      if (this.uniqueOpensOnly) {
        return (currentCampaignOpenReport.members.length | 0)
        - (cachedCampaignOpenReport.members.length | 0);
      }
      return currentCampaignOpenReport.total_opens - cachedCampaignOpenReport.total_opens;
    },
    cacheCampaignDetails(currentCampaignOpenReport) {
      this.setDbServiceVariable("total_opens", currentCampaignOpenReport.total_opens);
      this.setDbServiceVariable("members", {
        members: currentCampaignOpenReport.members,
      });
    },
    clearCampaignDetailsCache() {
      this.setDbServiceVariable("total_opens", 0);
      this.setDbServiceVariable("members", {
        members: [],
      });
    },
  },
  async run() {
    return this.emitReportEvents();
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Unique Opens Only?	`uniqueOpensOnly`	`boolean`	Whether to count every open campaign email or only count opens coming from each subscriber only once

Authentication#

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

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