Add or Update Subscriber with Mailchimp API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Mailchimp, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Add or Update Subscriber with the Mailchimp 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 HTTP / Webhook trigger and Mailchimp action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Add or Update Subscriber action
1. Connect your Mailchimp account
2. Select a List Id
3. Select a Subscriber
4. Configure Email address
5. Optional- Configure Skip merge validation
6. Select a Status if new
7. Optional- Select a Email type
8. Optional- Select a Status
9. Optional- Configure Merge fields
10. Optional- Configure Interests
11. Optional- Configure Language
12. Optional- Configure Vip
13. Optional- Configure Latitude
14. Optional- Configure Longitude
15. Optional- Configure Marketing permission ID
16. Optional- Configure Marketing permissions enabled
17. Optional- Configure IP signup
18. Optional- Configure Timestamp signup
19. Optional- Configure IP opt in
20. Optional- Configure Timestamp opt in
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Add or Update Subscriber on Mailchimp

Description:Adds a new subscriber to an audience or updates existing subscriber. [See docs here](https://mailchimp.com/developer/marketing/api/list-members/add-or-update-list-member/)

Version:0.2.2

Key:mailchimp-add-or-update-subscriber

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Action Code#

import mailchimp from "../../mailchimp.app.mjs";
import { removeNullEntries } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "mailchimp-add-or-update-subscriber",
  name: "Add or Update Subscriber",
  description: "Adds a new subscriber to an audience or updates existing subscriber. [See docs here](https://mailchimp.com/developer/marketing/api/list-members/add-or-update-list-member/)",
  version: "0.2.2",
  type: "action",
  props: {
    mailchimp,
    listId: {
      propDefinition: [
        mailchimp,
        "listId",
      ],
      label: "List Id",
      description: "The unique ID of the list",
    },
    subscriberHash: {
      propDefinition: [
        mailchimp,
        "subscriberHash",
        (c) => ({
          listId: c.listId,
        }),
      ],
    },
    emailAddress: {
      label: "Email address",
      type: "string",
      description: "Email address for a subscriber.",
    },
    skipMergeValidation: {
      label: "Skip merge validation",
      type: "boolean",
      description: "If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to False.",
      optional: true,
    },
    statusIfNew: {
      label: "Status if new",
      type: "string",
      description: "Subscriber's status. This value is required only if the email address is not already present on the list.",
      options: constants.STATUS,
    },
    emailType: {
      label: "Email type",
      type: "string",
      description: "Type of email this member asked to get ('html' or 'text').",
      optional: true,
      options: constants.EMAIL_TYPES,
    },
    status: {
      label: "Status",
      type: "string",
      description: "Subscriber's current status.",
      optional: true,
      options: constants.STATUS,
    },
    mergeFields: {
      label: "Merge fields",
      type: "object",
      description: "An individual merge var and value for a member.",
      optional: true,
    },
    interests: {
      label: "Interests",
      type: "object",
      description: "The key of this object's properties is the ID of the interest in question.",
      optional: true,
    },
    language: {
      label: "Language",
      type: "string",
      description: "If set/detected, the subscriber's language.",
      optional: true,
    },
    vip: {
      label: "Vip",
      type: "boolean",
      description: "VIP status for subscriber.",
      optional: true,
    },
    latitude: {
      label: "Latitude",
      type: "string",
      description: "The location latitude.",
      optional: true,
    },
    longitude: {
      label: "Longitude",
      type: "string",
      description: "The location longitude.",
      optional: true,
    },
    marketingPermissionId: {
      label: "Marketing permission ID",
      type: "string",
      description: "The ID for the marketing permission on the list.",
      optional: true,
    },
    marketingPermissionsEnabled: {
      label: "Marketing permissions enabled",
      type: "boolean",
      description: "If the subscriber has opted-in to the marketing permission.",
      optional: true,
    },
    ipSignup: {
      label: "IP signup",
      type: "string",
      description: "IP address the subscriber signed up from.",
      optional: true,
    },
    timestampSignup: {
      label: "Timestamp signup",
      type: "string",
      description: "The date and time the subscriber signed up for the list in ISO 8601 format.",
      optional: true,
    },
    ipOpt: {
      label: "IP opt in",
      type: "string",
      description: "The IP address the subscriber used to confirm their opt-in status.",
      optional: true,
    },
    timestampOpt: {
      label: "Timestamp opt in",
      type: "string",
      description: "The date and time the subscriber confirmed their opt-in status in ISO 8601 format.",
      optional: true,
    },
  },
  async run({ $ }) {

    const payload = removeNullEntries({
      listId: this.listId,
      subscriberHash: this.subscriberHash,
      data: {
        email_address: this.emailAddress,
        status_if_new: this.statusIfNew,
        email_type: this.emailType,
        status: this.status,
        merge_fields: this.mergeFields,
        interests: this.interests,
        language: this.language,
        vip: this.vip,
        location: {
          latitude: this.latitude && Number(this.latitude),
          longitude: this.longitude && Number(this.longitude),
        },
        marketing_permissions: [
          {
            marketing_permission_id: this.marketingPermissionId,
            enabled: this.marketingPermissionsEnabled,
          },
        ],
        ip_signup: this.ipSignup,
        timestamp_signup: this.timestampSignup,
        ip_opt: this.ipOpt,
        timestamp_opt: this.timestampOpt,
      },
      params: {
        skip_merge_validation: this.skipMergeValidation,
      },
    });
    const response = await this.mailchimp.addOrUpdateListMember($, payload);
    response && $.export("$summary", "Successful");
    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
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
List Id	`listId`	`string`	Select a value from the drop down menu.
Subscriber	`subscriberHash`	`string`	Select a value from the drop down menu.
Email address	`emailAddress`	`string`	Email address for a subscriber.
Skip merge validation	`skipMergeValidation`	`boolean`	If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to False.
Status if new	`statusIfNew`	`string`	Select a value from the drop down menu:`subscribedunsubscribedcleanedpendingtransactional`
Email type	`emailType`	`string`	Select a value from the drop down menu:`htmltext`
Status	`status`	`string`	Select a value from the drop down menu:`subscribedunsubscribedcleanedpendingtransactional`
Merge fields	`mergeFields`	`object`	An individual merge var and value for a member.
Interests	`interests`	`object`	The key of this object's properties is the ID of the interest in question.
Language	`language`	`string`	If set/detected, the subscriber's language.
Vip	`vip`	`boolean`	VIP status for subscriber.
Latitude	`latitude`	`string`	The location latitude.
Longitude	`longitude`	`string`	The location longitude.
Marketing permission ID	`marketingPermissionId`	`string`	The ID for the marketing permission on the list.
Marketing permissions enabled	`marketingPermissionsEnabled`	`boolean`	If the subscriber has opted-in to the marketing permission.
IP signup	`ipSignup`	`string`	IP address the subscriber signed up from.
Timestamp signup	`timestampSignup`	`string`	The date and time the subscriber signed up for the list in ISO 8601 format.
IP opt in	`ipOpt`	`string`	The IP address the subscriber used to confirm their opt-in status.
Timestamp opt in	`timestampOpt`	`string`	The date and time the subscriber confirmed their opt-in status in ISO 8601 format.

Action 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:

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

More Ways to Connect Mailchimp + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on Link Clicked from Mailchimp API

Mailchimp + HTTP / Webhook