List subscribers with ConvertKit API on New Coupon Event (Instant) from WooCommerce API

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

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce API

Next, do this

List subscribers with the ConvertKit 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 WooCommerce trigger and ConvertKit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the List subscribers action
1. Connect your ConvertKit account
2. Optional- Configure Email address
3. Optional- Configure Page
4. Optional- Configure Start date
5. Optional- Configure End date
6. Optional- Select a Sort order
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 Coupon Event (Instant) on WooCommerce

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

Version:0.0.3

Key:woocommerce-new-coupon-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-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${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#

List subscribers on ConvertKit

Description:Returns a list of your subscribers. [See docs here](https://developers.convertkit.com/#list-subscribers)

Version:0.0.2

Key:convertkit-list-subscribers

View on GitHub

ConvertKit Overview#

ConvertKit's API offers granular control over email marketing campaigns, allowing users to automate subscriber management, broadcast sending, and sequence setup. Utilize Pipedream's power to react to events, sync data across platforms, or create personalized, timely campaigns. Pipedream's serverless platform connects ConvertKit with hundreds of other apps, enabling automated workflows that save time and improve engagement.

Action Code#

import convertkit from "../../convertkit.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "convertkit-list-subscribers",
  name: "List subscribers",
  description: "Returns a list of your subscribers. [See docs here](https://developers.convertkit.com/#list-subscribers)",
  version: "0.0.2",
  type: "action",
  props: {
    convertkit,
    emailAddress: {
      label: "Email address",
      description: "Search subscribers by email address",
      type: "string",
      optional: true,
    },
    page: {
      label: "Page",
      description: "Page for paginated results",
      type: "integer",
      default: 1,
      optional: true,
    },
    from: {
      label: "Start date",
      description: "Filter subscribers added on or after this date (format yyyy-mm-dd)",
      type: "string",
      optional: true,
    },
    to: {
      label: "End date",
      description: "Filter subscribers added on or before this date (format yyyy-mm-dd)",
      type: "string",
      optional: true,
    },
    sortOrder: {
      label: "Sort order",
      description: "Sort order for results",
      type: "string",
      default: constants.SORT_ORDER[0],
      options: constants.SORT_ORDER,
      optional: true,
    },
  },
  async run({ $ }) {
    const payload = {
      email_address: this.emailAddress,
      page: this.page,
      from: this.from,
      to: this.to,
      sort_order: this.sortOrder,
    };
    const data = [];
    const paginator = this.convertkit.paginate({
      $,
      fn: this.convertkit.listSubscribers,
      payload,
    }, "subscribers");
    for await (const item of paginator) {
      data.push(item);
    }
    if (data.length) {
      $.export("$summary", "Successfully listed subscribers");
    }
    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
ConvertKit	`convertkit`	`app`	This component uses the ConvertKit app.
Email address	`emailAddress`	`string`	Search subscribers by email address
Page	`page`	`integer`	Page for paginated results
Start date	`from`	`string`	Filter subscribers added on or after this date (format yyyy-mm-dd)
End date	`to`	`string`	Filter subscribers added on or before this date (format yyyy-mm-dd)
Sort order	`sortOrder`	`string`	Select a value from the drop down menu:`ascdesc`

List subscribers with ConvertKit API on New Coupon Event (Instant) from WooCommerce API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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