Update or Create Contact with ClickFunnels API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Update or Create Contact with the ClickFunnels 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 ClickFunnels 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 Update or Create Contact action
1. Connect your ClickFunnels account
2. Select a Team Id
3. Select a Workspace Id
4. Configure Email
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Phone Number
8. Optional- Configure Time Zone
9. Optional- Configure FB URL
10. Optional- Configure Twitter URL
11. Optional- Configure Instagram URL
12. Optional- Configure Linkedin URL
13. Optional- Configure Website URL
14. Optional- Select one or more Tag Ids
15. Optional- Configure Custom Attributes
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#

Update or Create Contact on ClickFunnels

Description:Searches for a contact by email and updates it, or creates a new one if not found. [See the documentation](https://developers.myclickfunnels.com/reference/upsertcontact)

Version:0.0.1

Key:clickfunnels-update-create-contact

View on GitHub

ClickFunnels Overview#

The ClickFunnels API lets you interact programmatically with your ClickFunnels account, giving you control over your funnels, contacts, purchases, and more. With Pipedream, you can automate workflows that respond to a variety of triggers, such as new contacts or purchases. By connecting ClickFunnels with other apps available on Pipedream, you can streamline your sales process, sync data across platforms, and create powerful marketing automation.

Action Code#

import clickfunnels from "../../clickfunnels.app.mjs";
import {
  clearObj, parseObject,
} from "../../common/utils.mjs";

export default {
  key: "clickfunnels-update-create-contact",
  name: "Update or Create Contact",
  description: "Searches for a contact by email and updates it, or creates a new one if not found. [See the documentation](https://developers.myclickfunnels.com/reference/upsertcontact)",
  version: "0.0.1",
  type: "action",
  props: {
    clickfunnels,
    teamId: {
      propDefinition: [
        clickfunnels,
        "teamId",
      ],
    },
    workspaceId: {
      propDefinition: [
        clickfunnels,
        "workspaceId",
        ({ teamId }) => ({
          teamId,
        }),
      ],
    },
    email: {
      propDefinition: [
        clickfunnels,
        "email",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The contact's first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The contact's last name.",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The contact's phone number.",
      optional: true,
    },
    timeZone: {
      type: "string",
      label: "Time Zone",
      description: "The contact's time zone.",
      optional: true,
    },
    fbUrl: {
      type: "string",
      label: "FB URL",
      description: "The contact's Facebook URL.",
      optional: true,
    },
    twitterUrl: {
      type: "string",
      label: "Twitter URL",
      description: "The contact's twitter URL.",
      optional: true,
    },
    instagramUrl: {
      type: "string",
      label: "Instagram URL",
      description: "The contact's instagram URL.",
      optional: true,
    },
    linkedinUrl: {
      type: "string",
      label: "Linkedin URL",
      description: "The contact's linkedin URL.",
      optional: true,
    },
    websiteUrl: {
      type: "string",
      label: "Website URL",
      description: "The contact's website URL.",
      optional: true,
    },
    tagIds: {
      propDefinition: [
        clickfunnels,
        "tagId",
        ({ workspaceId }) => ({
          workspaceId,
        }),
      ],
      optional: true,
      type: "string[]",
      label: "Tag Ids",
      description: "An empty array is ignored here. If you wish to remove all tags for a Contact, use the Update Contact endpoint. A non-empty array overwrites the existing array.",
    },
    customAttributes: {
      type: "object",
      label: "Custom Attributes",
      description: `Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification.
        Custom attributes are provided as key-value pairs:
        A key that does not exist, will create a new custom contact attribute.
        A key that already exists, will update the value of an existing custom contact attribute.
        Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to snake_case (For example, 'Favorite Food! 🥑' will be converted to 'favorite_food').
        Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes(e.g. an array or string), it will be ignored.
        Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., 'first_name', 'First Name', etc. are not valid inputs.
        `,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      data, status,
    } = await this.clickfunnels.upsertContact({
      $,
      returnFullResponse: true,
      workspaceId: this.workspaceId,
      data: {
        contact: clearObj({
          email_address: this.email,
          first_name: this.firstName,
          last_name: this.lastName,
          phone_number: this.phoneNumber,
          time_zone: this.timeZone,
          fb_url: this.fbUrl,
          twitter_url: this.twitterUrl,
          instagram_url: this.instagramUrl,
          linkedin_url: this.linkedinUrl,
          website_url: this.websiteUrl,
          tag_ids: parseObject(this.tagIds),
          custom_attributes: parseObject(this.customAttributes),
        }),
      },
    });

    $.export("$summary", `Contact with Id: ${data.id} has been ${status === 200
      ? "updated"
      : "created"} successfully.`);
    return data;
  },

};

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
ClickFunnels	`clickfunnels`	`app`	This component uses the ClickFunnels app.
Team Id	`teamId`	`string`	Select a value from the drop down menu.
Workspace Id	`workspaceId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	The email address of the contact
First Name	`firstName`	`string`	The contact's first name.
Last Name	`lastName`	`string`	The contact's last name.
Phone Number	`phoneNumber`	`string`	The contact's phone number.
Time Zone	`timeZone`	`string`	The contact's time zone.
FB URL	`fbUrl`	`string`	The contact's Facebook URL.
Twitter URL	`twitterUrl`	`string`	The contact's twitter URL.
Instagram URL	`instagramUrl`	`string`	The contact's instagram URL.
Linkedin URL	`linkedinUrl`	`string`	The contact's linkedin URL.
Website URL	`websiteUrl`	`string`	The contact's website URL.
Tag Ids	`tagIds`	`string[]`	Select a value from the drop down menu.
Custom Attributes	`customAttributes`	`object`	Custom attributes are usually added in ClickFunnels to a contact when they submit forms that contain custom contact attributes. Here you can directly create them during contact modification. Custom attributes are provided as key-value pairs: A key that does not exist, will create a new custom contact attribute. A key that already exists, will update the value of an existing custom contact attribute. Empty or null values, will set the custom attribute values to empty strings. A key that has special characters or spaces will be automatically converted to snake_case (For example, 'Favorite Food! 🥑' will be converted to 'favorite_food'). Empty keys will trigger a bad request response. Also, non-object inputs for custom_attributes(e.g. an array or string), it will be ignored. Keys that are default properties on the Contact resource or variations of it will result in an error. E.g., 'first_name', 'First Name', etc. are not valid inputs.

Action Authentication#

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

About ClickFunnels#

Marketing funnels made easy.

More Ways to Connect ClickFunnels + Pipedream#

Other Popular Integrations#

Apply Tag to Contact with ClickFunnels API on New Scheduled Tasks from Pipedream API

Pipedream + ClickFunnels

Update or Create Contact with ClickFunnels API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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