Create Postcard with PostGrid Print & Mail API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Postcard 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 npm 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 Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Postcard action
1. Connect your PostGrid Print & Mail account
2. Select a To
3. Select a From
4. Configure Front HTML
5. Configure Back HTML
6. Select a Size
7. Optional- Configure Send Date
8. Optional- Configure Express
9. Optional- Configure Description
10. Optional- Select a Mailing Class
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation.
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Postcard on PostGrid Print & Mail

Description:Creates a new postcard in PostGrid. [See the documentation](https://docs.postgrid.com/#fe8c4cd6-7617-4023-9437-669fa847ccc1)

Version:0.0.1

Key:postgrid-create-postcard

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-postcard",
  name: "Create Postcard",
  description: "Creates a new postcard in PostGrid. [See the documentation](https://docs.postgrid.com/#fe8c4cd6-7617-4023-9437-669fa847ccc1)",
  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.",
    },
    frontHTML: {
      type: "string",
      label: "Front HTML",
      description: "The HTML content for the front of the postcard.",
    },
    backHTML: {
      type: "string",
      label: "Back HTML",
      description: "The HTML content for the back of the postcard.",
    },
    size: {
      type: "string",
      label: "Size",
      description: "The size of the postcard. Must be one of either 6x4, 9x6 or 11x6.",
      options: constants.POSTCARD_SIZE,
    },
    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,
    },
    express: {
      type: "boolean",
      label: "Express",
      description: "Express shipping.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description for the postcard.",
      optional: true,
    },
    mailingClass: {
      type: "string",
      label: "Mailing Class",
      description: "Mailing class. Defaults to first_class.",
      options: constants.MAILING_CLASS,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      postgrid,
      ...data
    } = this;

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

    if (response.id) {
      $.export("$summary", `Successfully created postcard 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.
Front HTML	`frontHTML`	`string`	The HTML content for the front of the postcard.
Back HTML	`backHTML`	`string`	The HTML content for the back of the postcard.
Size	`size`	`string`	Select a value from the drop down menu:`6x49x611x6`
Send Date	`sendDate`	`string`	The desired date for the letter to be sent out. Example: `2023-02-16T15:40:35.873Z`
Express	`express`	`boolean`	Express shipping.
Description	`description`	`string`	A description for the postcard.
Mailing Class	`mailingClass`	`string`	Select a value from the drop down menu:`{ "value": "standard_class", "label": "Standard Class" }{ "value": "first_class", "label": "First Class" }`

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,