Broadcast Message with Project Broadcast API on New Product Event (Instant) from WooCommerce API

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

Trigger workflow on

New Product Event (Instant) from the WooCommerce API

Next, do this

Broadcast Message with the Project Broadcast 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 Project Broadcast 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 Broadcast Message action
1. Connect your Project Broadcast account
2. Optional- Configure Scheduled At
3. Configure Message Text
4. Select one or more Contacts
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.3

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.3",
  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.

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#

Broadcast Message on Project Broadcast

Description:Sends a broadcast message to a list of contacts. [See the documentation](https://www.projectbroadcast.com/apidoc/#api-Broadcast_Messages-CreateBroadcastMessage)

Version:0.0.2

Key:project_broadcast-broadcast-message

View on GitHub

Project Broadcast Overview#

The Project Broadcast API facilitates communication through automated text messaging, providing features to manage contacts, send messages, and track campaigns. Leveraging this API on Pipedream allows you to create intricate workflows that can automate your texting campaigns, sync contact lists, and engage with customers by integrating with numerous other services for CRM, marketing, and other functions. With Pipedream's serverless platform, these integrations become seamless, triggering actions in real-time or on a schedule without the need for complex infrastructure.

Action Code#

import app from "../../project_broadcast.app.mjs";

export default {
  key: "project_broadcast-broadcast-message",
  name: "Broadcast Message",
  description: "Sends a broadcast message to a list of contacts. [See the documentation](https://www.projectbroadcast.com/apidoc/#api-Broadcast_Messages-CreateBroadcastMessage)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    scheduledAt: {
      type: "string",
      label: "Scheduled At",
      description: "Date/Time to send message in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp format. Example: `2023-01-01T00:00:00.000Z`. Not providing a runAt will schedule the message for immediate delivery.",
      optional: true,
    },
    text: {
      type: "string",
      label: "Message Text",
      description: "The text of the message to send.",
    },
    contacts: {
      type: "string[]",
      label: "Contacts",
      description: "Array of contact ids to send message to.",
      propDefinition: [
        app,
        "contactId",
      ],
    },
  },
  methods: {
    broadcastMessage(args = {}) {
      return this.app.post({
        path: "/broadcasts",
        ...args,
      });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      broadcastMessage,
      ...data
    } = this;

    return broadcastMessage({
      step,
      data,
      summary: (response) => `Successfully broadcast message with ID \`${response._id}\`.`,
    });
  },
};

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
Project Broadcast	`app`	`app`	This component uses the Project Broadcast app.
Scheduled At	`scheduledAt`	`string`	Date/Time to send message in ISO 8601 timestamp format. Example: `2023-01-01T00:00:00.000Z`. Not providing a runAt will schedule the message for immediate delivery.
Message Text	`text`	`string`	The text of the message to send.
Contacts	`contacts`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Project Broadcast account and sign in
Click the “More” menu with the three horizontal lines glyph on the left navitation
Go to “ACCOUNT” > “Get Api Key”