Create Letter with PostGrid Print & Mail API on New Customer Event (Instant) from WooCommerce API

Pipedream makes it easy to connect APIs for PostGrid Print & Mail, WooCommerce and 2,400+ other apps remarkably fast.

Trigger workflow on

New Customer Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Customer Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Letter action
1. Connect your PostGrid Print & Mail account
2. Select a To
3. Select a From
4. Configure HTML
5. Optional- Select a Address Placement
6. Optional- Configure Double Sided
7. Optional- Configure Color
8. Optional- Configure Perforated Page
9. Optional- Select a Extra Service
10. Optional- Select a Envelope Type
11. Optional- Select a Return Envelope
12. Optional- Configure Send Date
13. Optional- Configure Description
14. Optional- Configure Express
15. Optional- Select a Mailing Class
16. Optional- Select a Size
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 Customer Event (Instant) on WooCommerce

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

Version:0.0.3

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

Create Letter on PostGrid Print & Mail

Description:Creates a new letter in PostGrid. [See the documentation](https://docs.postgrid.com/#3359155b-f225-4f6a-b08a-eafe7a52b54d)

Version:0.0.1

Key:postgrid-create-letter

View on GitHub

PostGrid Print & Mail Overview#

The PostGrid Print & Mail API offers seamless print and mail solutions, enabling the automation of sending personalized letters, postcards, checks, and more. With this API, you can systematize direct mail campaigns, transactional mailings, or on-demand dispatch without managing printing infrastructure. In Pipedream, you can harness this capability to interlace PostGrid with an array of other services and triggers, creating workflows that respond to events such as form submissions, scheduled campaigns, or customer actions.

Action Code#

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

export default {
  key: "postgrid-create-letter",
  name: "Create Letter",
  description: "Creates a new letter in PostGrid. [See the documentation](https://docs.postgrid.com/#3359155b-f225-4f6a-b08a-eafe7a52b54d)",
  version: "0.0.1",
  type: "action",
  props: {
    postgrid,
    to: {
      propDefinition: [
        postgrid,
        "contactId",
      ],
      label: "To",
      description: "The id or contact object of the receiver.",
    },
    from: {
      propDefinition: [
        postgrid,
        "contactId",
      ],
      label: "From",
      description: "The id or contact object of the sender.",
    },
    html: {
      type: "string",
      label: "HTML",
      description: "The HTML content of the letter.",
    },
    addressPlacement: {
      type: "string",
      label: "Address Placement",
      description: "The location where the address will be placed.",
      options: constants.ADDRESS_PLACEMENT,
      optional: true,
    },
    doubleSided: {
      type: "boolean",
      label: "Double Sided",
      description: "Indicates if the letter is double sided or not.",
      optional: true,
    },
    color: {
      type: "boolean",
      label: "Color",
      description: "Indicates whether the letter will be printed in color or not.",
      optional: true,
    },
    perforatedPage: {
      type: "integer",
      label: "Perforated Page",
      description: "Indicates if the page is to be perforated (holes).",
      optional: true,
    },
    extraService: {
      type: "string",
      label: "Extra Service",
      description: "Indicates extra services for the letter.",
      options: constants.EXTRA_SERVICE,
      optional: true,
    },
    envelopeType: {
      type: "string",
      label: "Envelope Type",
      description: "Indicates the envelope type for the letter.",
      options: constants.ENVELOPE_TYPE,
      optional: true,
    },
    returnEnvelope: {
      propDefinition: [
        postgrid,
        "returnEnvelopeId",
      ],
    },
    sendDate: {
      type: "string",
      label: "Send Date",
      description: "The desired date for the letter to be sent out.  Example: `2023-02-16T15:40:35.873Z`",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description for the letter.",
      optional: true,
    },
    express: {
      type: "boolean",
      label: "Express",
      description: "See express shipping.",
      optional: true,
    },
    mailingClass: {
      type: "string",
      label: "Mailing Class",
      description: "Defaults to first_class. See mailing class.",
      options: constants.MAILING_CLASS,
      optional: true,
    },
    size: {
      type: "string",
      label: "Size",
      description: "Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created.",
      options: constants.LETTER_SIZE,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      postgrid,
      ...data
    } = this;

    const response = await postgrid.createLetter({
      data,
      $,
    });

    if (response.id) {
      $.export("$summary", `Successfully created letter 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
PostGrid Print & Mail	`postgrid`	`app`	This component uses the PostGrid Print & Mail app.
To	`to`	`string`	Select a value from the drop down menu.
From	`from`	`string`	Select a value from the drop down menu.
HTML	`html`	`string`	The HTML content of the letter.
Address Placement	`addressPlacement`	`string`	Select a value from the drop down menu:`{ "value": "top_first_page", "label": "Top First Page" }{ "value": "insert_blank_page", "label": "Insert Blank Page" }`
Double Sided	`doubleSided`	`boolean`	Indicates if the letter is double sided or not.
Color	`color`	`boolean`	Indicates whether the letter will be printed in color or not.
Perforated Page	`perforatedPage`	`integer`	Indicates if the page is to be perforated (holes).
Extra Service	`extraService`	`string`	Select a value from the drop down menu:`{ "value": "certified", "label": "Certified" }{ "value": "certified_return_receipt", "label": "Certified Return Receipt" }{ "value": "registered", "label": "Registered" }`
Envelope Type	`envelopeType`	`string`	Select a value from the drop down menu:`{ "value": "standard_double_window", "label": "Standard Double Window" }{ "value": "flat", "label": "Flat" }`
Return Envelope	`returnEnvelope`	`string`	Select a value from the drop down menu.
Send Date	`sendDate`	`string`	The desired date for the letter to be sent out. Example: `2023-02-16T15:40:35.873Z`
Description	`description`	`string`	A description for the letter.
Express	`express`	`boolean`	See express shipping.
Mailing Class	`mailingClass`	`string`	Select a value from the drop down menu:`{ "value": "standard_class", "label": "Standard Class" }{ "value": "first_class", "label": "First Class" }`
Size	`size`	`string`	Select a value from the drop down menu:`{ "value": "us_letter", "label": "US Letter" }{ "value": "us_legal", "label": "US Legal" }{ "value": "a4", "label": "A4" }`

Action Authentication#

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

To retrieve your API Key,