Update or Create Contact with ClickFunnels API on New Candidate Added from Gem API

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

Trigger workflow on

New Candidate Added from the Gem 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 Gem 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 Candidate Added trigger
1. Connect your Gem account
2. Configure timer
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 Candidate Added on Gem

Description:Emit new event when a candidate is added in Gem. [See the documentation](https://api.gem.com/v0/reference#tag/Candidates/paths/~1v0~1candidates/get)

Version:0.0.1

Key:gem-new-candidate

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import gem from "../../gem.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "gem-new-candidate",
  name: "New Candidate Added",
  description: "Emit new event when a candidate is added in Gem. [See the documentation](https://api.gem.com/v0/reference#tag/Candidates/paths/~1v0~1candidates/get)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    gem,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || 1;
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async emitEvent(maxResults = false) {
      const lastDate = this._getLastDate();

      const response = this.gem.paginate({
        fn: this.gem.listCandidates,
        params: {
          created_after: lastDate,
        },
      });

      let responseArray = [];
      for await (const item of response) {
        responseArray.push(item);
      }

      if (responseArray.length) {
        if (maxResults && (responseArray.length > maxResults)) {
          responseArray.length = maxResults;
        }
        this._setLastDate(responseArray[0].created_at);
      }

      for (const item of responseArray.reverse()) {
        this.$emit(item, {
          id: item.id,
          summary: `New Candidate with ID: ${item.id}`,
          ts: item.created_at,
        });
      }
    },
  },
  hooks: {
    async deploy() {
      await this.emitEvent(25);
    },
  },
  async run() {
    await this.emitEvent();
  },
  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
Gem	`gem`	`app`	This component uses the Gem app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Gem#

The AI-Powered Recruiting Platform TA Teams Love

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

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.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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.