Create Document with Formstack Documents API on New Order Event (Instant) from WooCommerce API

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

Trigger workflow on

New Order Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Order Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Document action
1. Connect your Formstack Documents account
2. Configure Name
3. Select a Type
4. Select a Output
5. Optional- Configure Folder
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 Order Event (Instant) on WooCommerce

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

Version:0.0.4

Key:woocommerce-new-order-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";
import sampleEmit from "./test-event.mjs";

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

Create Document on Formstack Documents

Description:Create a new document. [See documentation](https://www.webmerge.me/developers?page=documents)

Version:0.0.1

Key:formstack_documents-create-document

View on GitHub

Formstack Documents Overview#

The Formstack Documents API gives you the power to automate document creation and delivery, making it simple to generate custom PDFs, Word documents, PowerPoint presentations, and more, from your data. By leveraging the API within Pipedream, you can integrate dynamic document generation into your workflows. You might merge data from various sources, populate templates with real-time data, and send documents directly to customers or team members.

Action Code#

import formstackDocuments from "../../formstack_documents.app.mjs";
import fs from "fs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "formstack_documents-create-document",
  name: "Create Document",
  description: "Create a new document. [See documentation](https://www.webmerge.me/developers?page=documents)",
  version: "0.0.1",
  type: "action",
  props: {
    formstackDocuments,
    name: {
      type: "string",
      label: "Name",
      description: "The document name",
    },
    type: {
      propDefinition: [
        formstackDocuments,
        "documentType",
      ],
      reloadProps: true,
    },
    output: {
      propDefinition: [
        formstackDocuments,
        "documentOutput",
      ],
    },
    folder: {
      type: "string",
      label: "Folder",
      description: "The name of the folder to save the document in. If folder doesn't exist, one will be created.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.type === "html") {
      props.html = {
        type: "string",
        label: "HTML",
        description: "The HTML of the document",
      };
      props.width = {
        type: "string",
        label: "Width",
        description: "The width of the document (inches)",
        optional: true,
      };
      props.height = {
        type: "string",
        label: "Height",
        description: "The height of the document (inches)",
        optional: true,
      };
    } else {
      props.fileUrl = {
        type: "string",
        label: "File URL",
        description: "Public URL to the file",
        optional: true,
      };
      props.filePath = {
        type: "string",
        label: "File Path",
        description: "File path of a file previously downloaded in Pipedream E.g. (`/tmp/my-file.txt`). [Download a file to the `/tmp` directory](https://pipedream.com/docs/code/nodejs/http-requests/#download-a-file-to-the-tmp-directory)",
        optional: true,
      };
    }
    return props;
  },
  methods: {
    formatFilePath(path) {
      if (path.includes("/tmp/")) {
        return path;
      }
      return `/tmp/${path}`;
    },
  },
  async run({ $ }) {
    if (this.type !== "html" && !this.fileUrl && !this.filePath) {
      throw new ConfigurationError("Either File URL or File Path must be provided.");
    }

    const data = {
      name: this.name,
      type: this.type,
      output: this.output,
      folder: this.folder,
    };

    if (this.type === "html") {
      data.html = this.html;
      data.size_width = this.width;
      data.size_height = this.height;
    }
    if (this.fileUrl) {
      data.file_url = this.fileUrl;
    }
    if (this.filePath) {
      data.file_contents = fs.readFileSync(this.formatFilePath(this.filePath), {
        encoding: "base64",
      });
    }

    const response = await this.formstackDocuments.createDocument({
      data,
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created document with ID ${response.id}.`);
    }

    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
Formstack Documents	`formstackDocuments`	`app`	This component uses the Formstack Documents app.
Name	`name`	`string`	The document name
Type	`type`	`string`	Select a value from the drop down menu:`htmlpdfdocxxlsxpptx`
Output	`output`	`string`	Select a value from the drop down menu:`pdfdocxxlsxpptxemail`
Folder	`folder`	`string`	The name of the folder to save the document in. If folder doesn't exist, one will be created.

Action Authentication#

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

To retrieve your API keys,