Create Customer with Pennylane API on New or Updated Subscriber (Instant) from Mailchimp API

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

Trigger workflow on

New or Updated Subscriber (Instant) from the Mailchimp API

Next, do this

Create Customer with the Pennylane 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 Mailchimp trigger and Pennylane 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 Updated Subscriber (Instant) trigger
1. Connect your Mailchimp account
2. Select a Audience List Id
3. Configure Trigger on subscriber actions?
4. Configure Trigger on actions by Mailchimp admin?
5. Configure Trigger via actions on the API?
Configure the Create Customer action
1. Connect your Pennylane account
2. Select a Customer Type
3. Configure First Name
4. Configure Last Name
5. Optional- Select a Gender
6. Configure Name
7. Optional- Configure Reg No
8. Configure Address
9. Configure Postal Code
10. Configure City
11. Configure Country
12. Optional- Configure Recipient
13. Optional- Configure VAT Number
14. Optional- Configure Source Id
15. Optional- Configure Emails
16. Optional- Configure Billing IBAN
17. Optional- Configure Delivery Address
18. Optional- Configure Delivery Postal Code
19. Optional- Configure Delivery City
20. Optional- Configure Delivery Country
21. Optional- Select a Payment Conditions
22. Optional- Configure Phone
23. Optional- Configure Reference
24. Optional- Configure Notes
25. Optional- Configure Mandate
26. Optional- Configure Plan Item
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 Updated Subscriber (Instant) on Mailchimp

Description:Emit new event when a subscriber is added or updated (on profile, or email address change) in an audience list.

Version:0.0.1

Key:mailchimp-new-or-updated-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.

Trigger Code#

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

export default {
  ...common,
  key: "mailchimp-new-or-updated-subscriber",
  name: "New or Updated Subscriber (Instant)",
  description: "Emit new event when a subscriber is added or updated (on profile, or email address change) in an audience list.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "subscribe",
        "profile",
        "upemail",
        "unsubscribe",
        "cleaned",
      ];
    },
    generateMeta(eventPayload) {
      const ts = Date.parse(eventPayload.fired_at);
      if (!this.getEventTypes().includes(eventPayload.type)) {
        console.log("Unexpected trigger found, skipping emit");
        return;
      }
      const summary = `New event "${eventPayload.type}" occurred`;
      return {
        id: eventPayload["data[id]"],
        summary,
        ts,
      };
    },
  },
};

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	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
N/A	`http`	`$.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.
Audience List Id	`listId`	`string`	Select a value from the drop down menu.
Trigger on subscriber actions?	`triggeredByUser`	`boolean`	If set to true, events will be emitted on subscriber-initiated actions.
Trigger on actions by Mailchimp admin?	`triggeredByAdmin`	`boolean`	If set to true, events will be emitted on admin-initiated actions in the web interface.
Trigger via actions on the API?	`triggeredByApi`	`boolean`	If set to true, events will be emitted on actions initiated via the API.

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

Action#

Create Customer on Pennylane

Description:Creates a new customer in Pennylane. [See the documentation](https://pennylane.readme.io/reference/customers-post-1)

Version:0.0.1

Key:pennylane-create-customer

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  CUSTOMER_GENDER_OPTIONS,
  CUSTOMER_TYPE_OPTIONS, PAYMENT_CONDITIONS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pennylane from "../../pennylane.app.mjs";

export default {
  key: "pennylane-create-customer",
  name: "Create Customer",
  description: "Creates a new customer in Pennylane. [See the documentation](https://pennylane.readme.io/reference/customers-post-1)",
  version: "0.0.1",
  type: "action",
  props: {
    pennylane,
    customerType: {
      type: "string",
      label: "Customer Type",
      description: "The type of the customer you want to create.",
      options: CUSTOMER_TYPE_OPTIONS,
      reloadProps: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Customer first name.",
      hidden: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Customer last name.",
      hidden: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Customer Gender",
      options: CUSTOMER_GENDER_OPTIONS,
      hidden: true,
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the company.",
      hidden: true,
    },
    regNo: {
      type: "string",
      label: "Reg No",
      description: "Customer registration number (SIREN).",
      hidden: true,
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "Customer address (billing address).",
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Postal code (billing address).",
    },
    city: {
      type: "string",
      label: "City",
      description: "City (billing address).",
    },
    country: {
      type: "string",
      label: "Country",
      description: "Any ISO 3166 Alpha-2 country code (billing address).",
    },
    recipient: {
      type: "string",
      label: "Recipient",
      description: "Recipient displayed in the invoice.",
      hidden: true,
      optional: true,
    },
    vatNumber: {
      type: "string",
      label: "VAT Number",
      description: "Customer's VAT number.",
      hidden: true,
      optional: true,
    },
    sourceId: {
      type: "string",
      label: "Source Id",
      description: "You can use your own id when creating the customer. If not provided, Pennylane will pick one for you. Id must be unique.",
      optional: true,
    },
    emails: {
      type: "string[]",
      label: "Emails",
      description: "A list of customer emails.",
      optional: true,
    },
    billingIban: {
      type: "string",
      label: "Billing IBAN",
      description: "The billing IBAN of the customer. This is the iban on which you wish to receive payment from this customer.",
      optional: true,
    },
    deliveryAddress: {
      type: "string",
      label: "Delivery Address",
      description: "Address (shipping address).",
      optional: true,
    },
    deliveryPostalCode: {
      type: "string",
      label: "Delivery Postal Code",
      description: "Postal code (shipping address).",
      optional: true,
    },
    deliveryCity: {
      type: "string",
      label: "Delivery City",
      description: "City (shipping address).",
      optional: true,
    },
    deliveryCountry: {
      type: "string",
      label: "Delivery Country",
      description: "Any ISO 3166 Alpha-2 country code (shipping address).",
      optional: true,
    },
    paymentConditions: {
      type: "string",
      label: "Payment Conditions",
      description: "Customer payment conditions",
      options: PAYMENT_CONDITIONS_OPTIONS,
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Customer phone number.",
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "This reference doesn't appear on the invoice.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes about the customer.",
      optional: true,
    },
    mandate: {
      type: "object",
      label: "Mandate",
      description: "The mandate object. **Example: {\"provider\": \"gocardless\",\"source_id\": \"MD001H23WP8E7XN\"}**.",
      optional: true,
    },
    planItem: {
      type: "object",
      label: "Plan Item",
      description: "The plan item object. **Example: {\"enabled\": true,\"number\": \"123\",\"label\": \"label\",\"vat_rate\": \"123\",\"country_alpha2\": \"US\",\"description\": \"description\"}**.",
      optional: true,
    },
  },
  async additionalProps(props) {
    const typeCompany = (this.customerType === "company");
    props.name.hidden = !typeCompany;
    props.regNo.hidden = !typeCompany;
    props.recipient.hidden = !typeCompany;
    props.vatNumber.hidden = !typeCompany;
    props.firstName.hidden = typeCompany;
    props.lastName.hidden = typeCompany;
    props.gender.hidden = typeCompany;
    return {};
  },
  async run({ $ }) {
    try {
      const additionalData = this.customerType === "company"
        ? {
          name: this.name,
          reg_no: this.regNo,
          vat_number: this.vatNumber,
          recipient: this.recipient,
        }
        : {
          first_name: this.firstName,
          last_name: this.lastName,
          gender: this.gender,
        };

      const response = await this.pennylane.createCustomer({
        $,
        data: {
          customer: {
            customer_type: this.customerType,
            address: this.address,
            postal_code: this.postalCode,
            city: this.city,
            country_alpha2: this.country,
            source_id: this.sourceId,
            emails: parseObject(this.emails),
            billing_iban: this.billingIban,
            delivery_address: this.deliveryAddress,
            delivery_postal_code: this.deliveryPostalCode,
            delivery_city: this.deliveryCity,
            delivery_country_alpha2: this.deliveryCountry,
            payment_conditions: this.paymentConditions,
            phone: this.phone,
            reference: this.reference,
            notes: this.notes,
            mandate: parseObject(this.mandate),
            plan_item: parseObject(this.planItem),
            ...additionalData,
          },
        },
      });
      $.export("$summary", `Successfully created customer with Id: ${response.customer.source_id}`);
      return response;
    } catch ({ response }) {
      throw new ConfigurationError(response?.data?.message || response?.data?.error);
    }
  },
};

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
Pennylane	`pennylane`	`app`	This component uses the Pennylane app.
Customer Type	`customerType`	`string`	Select a value from the drop down menu:`companyindividual`
Address	`address`	`string`	Customer address (billing address).
Postal Code	`postalCode`	`string`	Postal code (billing address).
City	`city`	`string`	City (billing address).
Country	`country`	`string`	Any ISO 3166 Alpha-2 country code (billing address).
Source Id	`sourceId`	`string`	You can use your own id when creating the customer. If not provided, Pennylane will pick one for you. Id must be unique.
Emails	`emails`	`string[]`	A list of customer emails.
Billing IBAN	`billingIban`	`string`	The billing IBAN of the customer. This is the iban on which you wish to receive payment from this customer.
Delivery Address	`deliveryAddress`	`string`	Address (shipping address).
Delivery Postal Code	`deliveryPostalCode`	`string`	Postal code (shipping address).
Delivery City	`deliveryCity`	`string`	City (shipping address).
Delivery Country	`deliveryCountry`	`string`	Any ISO 3166 Alpha-2 country code (shipping address).
Payment Conditions	`paymentConditions`	`string`	Select a value from the drop down menu:`upon_receiptcustom15_days30_days45_days60_days`
Phone	`phone`	`string`	Customer phone number.
Reference	`reference`	`string`	This reference doesn't appear on the invoice.
Notes	`notes`	`string`	Notes about the customer.
Mandate	`mandate`	`object`	The mandate object. Example: {"provider": "gocardless","source_id": "MD001H23WP8E7XN"}.
Plan Item	`planItem`	`object`	The plan item object. Example: {"enabled": true,"number": "123","label": "label","vat_rate": "123","country_alpha2": "US","description": "description"}.

Action Authentication#

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

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

customer_invoices

About Pennylane#

Pennylane brings together your finances, your accounting, and your Business Account!

More Ways to Connect Pennylane + Mailchimp#

Other Popular Integrations#

Create Customer with Pennylane API on New List Event (Instant) from Mailchimp API

Mailchimp + Pennylane

Create Customer with Pennylane API on New or Updated Subscriber (Instant) from Mailchimp API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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