Create or Update Lead with KickoffLabs API on New Abandoned Cart from Shopify API

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

Trigger workflow on

New Abandoned Cart from the Shopify 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 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shopify 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 Abandoned Cart trigger
1. Connect your Shopify account
2. Configure timer
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 Abandoned Cart on Shopify

Description:Emit new event each time a user abandons their cart.

Version:0.0.4

Key:shopify_developer_app-new-abandoned-cart

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/sources/new-abandoned-cart/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-abandoned-cart",
  name: "New Abandoned Cart",
  type: "source",
  description: "Emit new event each time a user abandons their cart.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    shopify,
    ...common.props,
  },
};

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
Shopify	`shopify`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

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,

Navigate to your KickoffLabs account and sign in
Click on one of your campaigns (or hit “View Campaign” on campaign)

Once you are in a campaign, navigate to "Settings" >> "All Settings"

Save your Campaign ID and API Key from this page.

Create or Update Lead with KickoffLabs API on New Abandoned Cart from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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