Create Lead with HelloLeads API on New or Updated Subscriber (Instant) from Mailchimp API

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

Trigger workflow on

New or Updated Subscriber (Instant) from the Mailchimp API

Next, do this

Create Lead with the HelloLeads 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 HelloLeads 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 Lead action
1. Connect your HelloLeads account
2. Select a List Key
3. Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Designation
6. Optional- Configure Company
7. Optional- Configure Email
8. Optional- Configure Phone
9. Optional- Configure Mobile
10. Optional- Configure Fax
11. Optional- Configure Address Line 1
12. Optional- Configure Address Line 2
13. Optional- Configure City
14. Optional- Configure State
15. Optional- Configure Postal Code
16. Optional- Configure Country
17. Optional- Configure Website
18. Optional- Configure Notes
19. Optional- Configure Interests
20. Optional- Configure Category
21. Optional- Configure Tags
22. Optional- Configure Mobile Code
23. Optional- Configure Deal Size
24. Optional- Select a Potential
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 Lead on HelloLeads

Description:Adds a new lead into the HelloLeads system. [See the documentation](https://github.com/PipedreamHQ/pipedream/files/13168532/HelloLeads_CRM_API_Documentation_POST_Method.pdf)

Version:0.0.1

Key:helloleads-create-lead

View on GitHub

HelloLeads Overview#

The HelloLeads API integrates with Pipedream to automate your lead management processes. By leveraging this API on Pipedream, you can streamline contact syncing, lead tracking, and perform actions based on lead status changes. With serverless workflows, you can connect HelloLeads with various apps like CRMs, communication platforms, or data analysis tools to enhance lead engagement, follow-up efficiency, and data-driven decision-making.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import helloleads from "../../helloleads.app.mjs";
import {
  clearObj,
  parseObj,
} from "../../common/utils.mjs";

export default {
  key: "helloleads-create-lead",
  name: "Create Lead",
  version: "0.0.1",
  description: "Adds a new lead into the HelloLeads system. [See the documentation](https://github.com/PipedreamHQ/pipedream/files/13168532/HelloLeads_CRM_API_Documentation_POST_Method.pdf)",
  type: "action",
  props: {
    helloleads,
    listKey: {
      propDefinition: [
        helloleads,
        "listKey",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the lead.",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the lead.",
      optional: true,
    },
    designation: {
      type: "string",
      label: "Designation",
      description: "Designation of the lead.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Lead organization name.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Primary email address of the lead.",
      optional: true,
    },
    phone: {
      type: "integer",
      label: "Phone",
      description: "Work phone number of the lead.",
      optional: true,
    },
    mobile: {
      type: "integer",
      label: "Mobile",
      description: "Mobile phone number of the lead.",
      optional: true,
    },
    fax: {
      type: "integer",
      label: "Fax",
      description: "Fax number of the lead.",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "Address line1 of the lead.",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "Address line2 of the lead.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City that the lead belongs to.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State that the lead belongs to.",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Zip code of the region that the lead belongs to.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country that the lead belongs to.",
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "Website reference of the lead.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Specify any other details about the lead.",
      optional: true,
    },
    interests: {
      type: "string[]",
      label: "Interests",
      description: "A list of Product/Interest which offered by you is interested to Lead. `(Don't use special characters)`.",
      optional: true,
    },
    category: {
      type: "string",
      label: "Category",
      description: "Customer group of a Lead. `(Don't use special characters)`.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Short tags (Tagging words) on lead. `(Do not use special characters)`.",
      optional: true,
    },
    mobileCode: {
      type: "string",
      label: "Mobile Code",
      description: "Mobile country code.",
      optional: true,
    },
    dealSize: {
      type: "string",
      label: "Deal Size",
      description: "Deal value of the business.",
      optional: true,
    },
    potential: {
      type: "string",
      label: "Potential",
      description: "How potential is the customer. By default, it will be Low.",
      options: [
        "High",
        "Medium",
        "Low",
        "Not Relevant",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      helloleads,
      listKey,
      firstName,
      lastName,
      email,
      mobile,
      addressLine1,
      addressLine2,
      postalCode,
      interests,
      tags,
      mobileCode,
      dealSize,
      ...data
    } = this;

    if (!email && !mobile) throw new ConfigurationError("You must fill in at least Email or Mobile");

    const response = await helloleads.createLead({
      $,
      data: clearObj({
        list_key: listKey,
        first_name: firstName,
        last_name: lastName,
        email: email,
        mobile: mobile,
        address_line1: addressLine1,
        address_line2: addressLine2,
        postal_code: postalCode,
        interests: interests && parseObj(interests).toString(),
        tags: tags && parseObj(tags).toString(),
        mobile_code: mobileCode,
        deal_size: dealSize,
        ...data,
      }),
    });

    $.export("$summary", `A new lead with Id: ${response.lead_id} created successfully!`);
    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
HelloLeads	`helloleads`	`app`	This component uses the HelloLeads app.
List Key	`listKey`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	First name of the lead.
Last Name	`lastName`	`string`	Last name of the lead.
Designation	`designation`	`string`	Designation of the lead.
Company	`company`	`string`	Lead organization name.
Email	`email`	`string`	Primary email address of the lead.
Phone	`phone`	`integer`	Work phone number of the lead.
Mobile	`mobile`	`integer`	Mobile phone number of the lead.
Fax	`fax`	`integer`	Fax number of the lead.
Address Line 1	`addressLine1`	`string`	Address line1 of the lead.
Address Line 2	`addressLine2`	`string`	Address line2 of the lead.
City	`city`	`string`	City that the lead belongs to.
State	`state`	`string`	State that the lead belongs to.
Postal Code	`postalCode`	`string`	Zip code of the region that the lead belongs to.
Country	`country`	`string`	Country that the lead belongs to.
Website	`website`	`string`	Website reference of the lead.
Notes	`notes`	`string`	Specify any other details about the lead.
Interests	`interests`	`string[]`	A list of Product/Interest which offered by you is interested to Lead. `(Don't use special characters)`.
Category	`category`	`string`	Customer group of a Lead. `(Don't use special characters)`.
Tags	`tags`	`string[]`	Short tags (Tagging words) on lead. `(Do not use special characters)`.
Mobile Code	`mobileCode`	`string`	Mobile country code.
Deal Size	`dealSize`	`string`	Deal value of the business.
Potential	`potential`	`string`	Select a value from the drop down menu:`HighMediumLowNot Relevant`

Action Authentication#

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

To retrieve your API Authentication Key,

Navigate to your HelloLeads and sign in
Go to “Settings” > “API Integrations”

Create Lead with HelloLeads API on New or Updated Subscriber (Instant) from Mailchimp API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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