Add Member To List with Klaviyo API on Customer Created (Instant) from Customer Fields API

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

Trigger workflow on

Customer Created (Instant) from the Customer Fields API

Next, do this

Add Member To List with the Klaviyo 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 Customer Fields trigger and Klaviyo action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Customer Created (Instant) trigger
1. Connect your Customer Fields account
Configure the Add Member To List action
1. Connect your Klaviyo account
2. Select a List
3. Select one or more Profile Ids
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#

Customer Created (Instant) on Customer Fields

Description:Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).

Version:0.0.1

Key:customer_fields-customer-created

View on GitHub

Customer Fields Overview#

The Customer Fields API provides a suite of tools for managing customer data in e-commerce platforms, including custom form fields and data automation. With it, you can efficiently tailor customer interactions, streamline data collection, and enhance the shopping experience. Integrating Customer Fields with Pipedream allows for seamless automation of tasks like syncing data to other platforms, triggering personalized communications, or managing customer segments based on custom field data.

Trigger Code#

import common from "../common/webhook.mjs";
import topics from "../common/topics.mjs";

export default {
  ...common,
  key: "customer_fields-customer-created",
  name: "Customer Created (Instant)",
  description: "Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listCustomers;
    },
    getResourcesFnArgs() {
      return {
        params: {
          sort_by: "created_at",
          sort_order: "desc",
        },
      };
    },
    getResourcesName() {
      return "customers";
    },
    getTopicName() {
      return topics.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Customer: ${resource.id}`,
        ts: Date.parse(resource.created_at),
      };
    },
  },
};

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
Customer Fields	`app`	`app`	This component uses the Customer Fields 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.

Trigger Authentication#

Customer Fields uses OAuth authentication. When you connect your Customer Fields account, Pipedream will open a popup window where you can sign into Customer Fields and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Customer Fields API.

Pipedream requests the following authorization scopes when you connect your account:

readwrite

About Customer Fields#

Create customer sign-up forms as unique as your business, and save custom data to customer accounts.

Action#

Add Member To List on Klaviyo

Description:Add member to a specific list. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/add-members)

Version:1.0.0

Key:klaviyo-add-member-to-list

View on GitHub

Klaviyo Overview#

The Klaviyo API grants you the power to automate and personalize your email marketing efforts. With it, you can manage lists, profiles, and campaigns, track event-driven communications, and analyze the results. By leveraging this API on Pipedream, you can create intricate, automated workflows that respond in real-time to your users' behavior, sync data across multiple platforms, and tailor your marketing strategies to improve engagement and conversion rates.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import klaviyo from "../../klaviyo.app.mjs";

export default {
  key: "klaviyo-add-member-to-list",
  name: "Add Member To List",
  description: "Add member to a specific list. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/add-members)",
  version: "1.0.0",
  type: "action",
  props: {
    klaviyo,
    list: {
      propDefinition: [
        klaviyo,
        "list",
      ],
    },
    profileIds: {
      propDefinition: [
        klaviyo,
        "profileIds",
      ],
    },
  },
  async run({ $ }) {
    const { response } = await this.klaviyo.subscribeProfiles({
      listId: this.list.value,
      data: parseObject(this.profileIds)?.map(({ value: id }) => ({
        type: "profile",
        id,
      })),
    });

    $.export("$summary", `${this.profileId} successfully added to "${this.list.label}"!`);
    return response.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
Klaviyo	`klaviyo`	`app`	This component uses the Klaviyo app.
List	`list`	`string`	Select a value from the drop down menu.
Profile Ids	`profileIds`	`string[]`	Select a value from the drop down menu.