Add Member To List with Klaviyo API on New Contact Created from Salesmsg API

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

Trigger workflow on

New Contact Created from the Salesmsg 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 Salesmsg 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 New Contact Created trigger
1. Connect your Salesmsg account
2. Configure Polling interval
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#

New Contact Created on Salesmsg

Description:Emit new event when a new contact is created.

Version:0.0.1

Key:salesmsg-contact-created

View on GitHub

Salesmsg Overview#

The Salesmsg API facilitates two-way SMS and MMS communications, allowing users to send, receive, and manage messages programmatically. It provides a suite of tools to integrate texting capabilities into various workflows and systems. On Pipedream, you can harness this API to automate conversations, sync with customer databases, trigger notifications, and much more, utilizing Pipedream's serverless platform to connect Salesmsg with a plethora of other apps and services.

Trigger Code#

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

export default {
  key: "salesmsg-contact-created",
  name: "New Contact Created",
  version: "0.0.1",
  description: "Emit new event when a new contact is created.",
  type: "source",
  dedupe: "unique",
  props: {
    salesmsg,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Salesmsg API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || "1970-01-01";
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults = 0) {

      const lastDate = this._getLastDate();
      const items = this.salesmsg.paginate({
        fn: this.salesmsg.listContacts,
        maxResults,
        perPage: true,
        params: {
          "sortBy": "created_at",
          "sortOrder": "desc",
          "filtersList[0][filters][0][key]": "created_at",
          "filtersList[0][filters][0][operator]": "is_after",
          "filtersList[0][filters][0][value]": lastDate,
          "filtersList[1][filters][0][key]": "created_at",
          "filtersList[1][filters][0][operator]": "is_equal_to",
          "filtersList[1][filters][0][value]": lastDate,
        },
      });

      let responseArray = [];

      for await (const item of items) {
        responseArray.push(item);
      }

      if (responseArray.length) this._setLastDate(responseArray[0].created_at);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `A new contact with id: "${item.id}" was created!`,
            ts: item.created_at,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Salesmsg	`salesmsg`	`app`	This component uses the Salesmsg app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Salesmsg API on this schedule

Trigger Authentication#

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

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

public-api

About Salesmsg#

One SMS app for your entire company. 2-way texting, SMS marketing, calling, & more.

Action#

Add Member To List on Klaviyo

Description:Add member to a specific list. [See the documentation](https://developers.klaviyo.com/en/reference/add_profiles_to_list)

Version:1.0.3

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 documentation](https://developers.klaviyo.com/en/reference/add_profiles_to_list)",
  version: "1.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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", `Member(s) 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.