Create Lead with HelloLeads API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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”

About HelloLeads#

An award-winning Smart and Simple Lead Management solution for Small Businesses.

More Ways to Connect HelloLeads + Pipedream#

Other Popular Integrations#

Create a Subscription with Pipedream API on New Lead Added from HelloLeads API

HelloLeads + Pipedream

Try it

Delete a Subscription with Pipedream API on New Lead Added from HelloLeads API

HelloLeads + Pipedream

Try it

Get Component with Pipedream API on New Lead Added from HelloLeads API

HelloLeads + Pipedream

Try it

Generate Component Code with Pipedream API on New Lead Added from HelloLeads API

HelloLeads + Pipedream

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Lead Added from the HelloLeads API

Emit new event when a new lead is created.

Try it