Create or Update Lead with KickoffLabs API on New Customer Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for KickoffLabs, WooCommerce and 2,000+ other apps remarkably fast.

Trigger workflow on

New Customer Event (Instant) from the WooCommerce API

Next, do this

Create or Update Lead with the KickoffLabs API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a WooCommerce trigger and KickoffLabs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Customer Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create or Update Lead action
1. Connect your KickoffLabs account
2. Optional- Configure Email
3. Optional- Configure Phone Number
4. Optional- Configure IP Address
5. Optional- Configure URL
6. Optional- Configure Referrer URL
7. Optional- Configure User Agent
8. Optional- Configure Source
9. Optional- Configure Custom Fields
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 Customer Event (Instant) on WooCommerce

Description:Emit new event each time the specified customer event(s) occur

Version:0.0.3

Key:woocommerce-new-customer-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-customer-event",
  name: "New Customer Event (Instant)",
  description: "Emit new event each time the specified customer event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCustomers({
        per_page: perPage,
        orderby: "registered_date",
      });
    },
    getTopic(topicType) {
      return `customer.${topicType}`;
    },
    generateMeta(eventType, {
      id, username, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Customer "${username || id}" ${eventType}`,
        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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create or Update Lead on KickoffLabs

Description:Adds a new lead or modifies an existing lead on your campaign. [See the documentation](https://dev.kickofflabs.com/create/).

Version:0.0.1

Key:kickofflabs-create-or-update-lead

View on GitHub

KickoffLabs Overview#

The KickoffLabs API enables you to automate your referral marketing campaigns by integrating with their service. With this API, you can programmatically manage campaigns, leads, and rewards, allowing you to dynamically respond to new sign-ups or reward achievements. By connecting the KickoffLabs API to Pipedream, you can create powerful workflows that react to events in real-time, synchronize data across multiple services, or even trigger custom logic tailored to your marketing strategy.

Action Code#

import app from "../../kickofflabs.app.mjs";

export default {
  name: "Create or Update Lead",
  description: "Adds a new lead or modifies an existing lead on your campaign. [See the documentation](https://dev.kickofflabs.com/create/).",
  key: "kickofflabs-create-or-update-lead",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the lead.",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the lead.",
      optional: true,
    },
    ip: {
      type: "string",
      label: "IP Address",
      description: "By default, we use the IP address of the request. This is great if your are using ajax to make the request. However, if you are making the request on the server, you may want to include user’s ip address.",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "The URL which the lead signed up on.",
      optional: true,
    },
    ref: {
      type: "string",
      label: "Referrer URL",
      description: "The referrer url the lead came from.",
      optional: true,
    },
    userAgent: {
      type: "string",
      label: "User Agent",
      description: "The user agent of the lead.",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "This will default to API, but you can change it to something unique. This is helpful if you are sending leads in from various sources. In additional, if source is API, we will not perform duplicate IP address checks.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Any additional parameters you include when signing up a lead will be captured as custom fields.",
      optional: true,
    },
  },
  async run({ $ }) {
    const res = await this.app.createOrUpdateLead({
      email: this.email,
      phone_number: this.phoneNumber,
      ip: this.ip,
      __url: this.url,
      __ref: this.ref,
      __user_agent: this.userAgent,
      __source: this.source,
    }, $);
    $.export("summary", `Successfully created or updated lead with id ${res.id}`);
    return res;
  },
};

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
KickoffLabs	`app`	`app`	This component uses the KickoffLabs app.
Email	`email`	`string`	Email address of the lead.
Phone Number	`phoneNumber`	`string`	Phone number of the lead.
IP Address	`ip`	`string`	By default, we use the IP address of the request. This is great if your are using ajax to make the request. However, if you are making the request on the server, you may want to include user’s ip address.
URL	`url`	`string`	The URL which the lead signed up on.
Referrer URL	`ref`	`string`	The referrer url the lead came from.
User Agent	`userAgent`	`string`	The user agent of the lead.
Source	`source`	`string`	This will default to API, but you can change it to something unique. This is helpful if you are sending leads in from various sources. In additional, if source is API, we will not perform duplicate IP address checks.
Custom Fields	`customFields`	`object`	Any additional parameters you include when signing up a lead will be captured as custom fields.

Action Authentication#

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

To retrieve your Campaign ID and API Key,