Create Draft Campaign with Sendy API on New Product Event (Instant) from WooCommerce API

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

Trigger workflow on

New Product Event (Instant) from the WooCommerce API

Next, do this

Create Draft Campaign with the Sendy 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 Sendy action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Product Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Draft Campaign action
1. Connect your Sendy account
2. Configure From Name
3. Configure From Email
4. Configure Reply To
5. Configure Title
6. Configure Subject
7. Optional- Configure Plain Text
8. Configure HTML Text
9. Select a Brand ID
10. Optional- Select one or more List IDs
11. Optional- Configure Segment IDs
12. Optional- Select one or more Exclude List IDs
13. Optional- Configure Exclude Segment IDs
14. Optional- Configure Query String
15. Select a Track Opens
16. Select a Track Clicks
17. Optional- Configure Schedule Date Time
18. Optional- Configure Schedule Timezone
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 Product Event (Instant) on WooCommerce

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

Version:0.0.4

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

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Draft Campaign on Sendy

Description:Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)

Version:0.0.2

Key:sendy-create-draft-campaign

View on GitHub

Sendy Overview#

The Sendy API allows you to programmatically manage email campaigns, subscribers, and lists. With Pipedream's capabilities, you can leverage Sendy API to create custom workflows that respond to events, synchronize data across platforms, and automate email marketing tasks. Pipedream provides a serverless platform where you can connect Sendy with 3,000+ other apps without writing complex code, harnessing the power of Sendy's features with event-driven programming and API integration.

Action Code#

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

export default {
  key: "sendy-create-draft-campaign",
  name: "Create Draft Campaign",
  description: "Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    sendy,
    fromName: {
      type: "string",
      label: "From Name",
      description: "The 'From Name' of your campaign.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "The 'From Email' of your campaign.",
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "The 'Reply To' of your campaign.",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The 'Title' of your campaign.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The 'Subject' of your campaign.",
    },
    plainText: {
      type: "string",
      label: "Plain Text",
      description: "The 'Plain text version' of your campaign.",
      optional: true,
    },
    htmlText: {
      type: "string",
      label: "HTML Text",
      description: "The 'HTML version' of your campaign.",
    },
    brandId: {
      propDefinition: [
        sendy,
        "brandId",
      ],
    },
    listIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "List IDs",
      description: "A list of List IDs.",
      optional: true,
    },
    segmentIds: {
      type: "string[]",
      label: "Segment IDs",
      description: "A list of segment IDs. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    excludeListIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "Exclude List IDs",
      description: "Lists to exclude from your campaign.",
      optional: true,
    },
    excludeSegmentIds: {
      type: "string[]",
      label: "Exclude Segment IDs",
      description: "Segments to exclude from your campaign. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    queryString: {
      type: "string",
      label: "Query String",
      description: "e.g., Google Analytics tags.",
      optional: true,
    },
    trackOpens: {
      type: "string",
      label: "Track Opens",
      description: "Open tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    trackClicks: {
      type: "string",
      label: "Track Clicks",
      description: "Click tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    scheduleDateTime: {
      type: "string",
      label: "Schedule Date Time",
      description: "Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..",
      optional: true,
    },
    scheduleTimezone: {
      type: "string",
      label: "Schedule Timezone",
      description: "e.g., 'America/New_York'. See the [list of PHP's supported timezones](https://www.php.net/manual/en/timezones.php). This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.sendy.createDraftCampaign({
      $,
      data: {
        from_name: this.fromName,
        from_email: this.fromEmail,
        reply_to: this.replyTo,
        title: this.title,
        subject: this.subject,
        plain_text: this.plainText,
        html_text: this.htmlText,
        list_ids: this.listIds && parseObject(this.listIds),
        segment_ids: this.segmentIds && parseObject(this.segmentIds),
        exclude_list_ids: this.excludeListIds && parseObject(this.excludeListIds),
        exclude_segment_ids: this.excludeSegmentIds && parseObject(this.excludeSegmentIds),
        brand_id: this.brandId,
        query_string: this.queryString,
        track_opens: this.trackOpens,
        track_clicks: this.trackClicks,
        schedule_date_time: this.scheduleDateTime,
        schedule_timezone: this.scheduleTimezone,
      },
    });

    $.export("$summary", "Draft campaign created successfully");
    return response;
  },
};

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
Sendy	`sendy`	`app`	This component uses the Sendy app.
From Name	`fromName`	`string`	The 'From Name' of your campaign.
From Email	`fromEmail`	`string`	The 'From Email' of your campaign.
Reply To	`replyTo`	`string`	The 'Reply To' of your campaign.
Title	`title`	`string`	The 'Title' of your campaign.
Subject	`subject`	`string`	The 'Subject' of your campaign.
Plain Text	`plainText`	`string`	The 'Plain text version' of your campaign.
HTML Text	`htmlText`	`string`	The 'HTML version' of your campaign.
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
List IDs	`listIds`	`string[]`	Select a value from the drop down menu.
Segment IDs	`segmentIds`	`string[]`	A list of segment IDs. Segment ids can be found in the segments setup page.
Exclude List IDs	`excludeListIds`	`string[]`	Select a value from the drop down menu.
Exclude Segment IDs	`excludeSegmentIds`	`string[]`	Segments to exclude from your campaign. Segment ids can be found in the segments setup page.
Query String	`queryString`	`string`	e.g., Google Analytics tags.
Track Opens	`trackOpens`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Track Clicks	`trackClicks`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Schedule Date Time	`scheduleDateTime`	`string`	Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..
Schedule Timezone	`scheduleTimezone`	`string`	e.g., 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.