Create Document with Click2Mail API on New Page from Shopify API

Pipedream makes it easy to connect APIs for Click2Mail, Shopify and 2,700+ other apps remarkably fast.

Trigger workflow on

New Page from the Shopify API

Next, do this

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

Select this integration
Configure the New Page trigger
1. Connect your Shopify account
2. Configure timer
Configure the Create Document action
1. Connect your Click2Mail account
2. Optional- Configure Document Name
3. Select a Document Format
4. Select a Document Class
5. Configure File Path Or Url
6. Optional- Configure syncDir
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 Page on Shopify

Description:Emit new event for each new page published.

Version:0.0.7

Key:shopify_developer_app-new-page

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration

Trigger Code#

import shopify from "../../shopify_developer_app.app.mjs";
import common from "@pipedream/shopify/sources/new-page/new-page.mjs";

import { adjustPropDefinitions } from "../../common/utils.mjs";

const {
  name, description, type, ...others
} = common;
const props = adjustPropDefinitions(others.props, shopify);

export default {
  ...others,
  key: "shopify_developer_app-new-page",
  version: "0.0.7",
  name,
  description,
  type,
  props: {
    app: shopify,
    ...props,
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Create Document on Click2Mail

Description:Creates a new document in your account from an uploaded file or a URL. [See the documentation for file](https://developers.click2mail.com/reference/createdocument_1). [See the documentation for URL](https://developers.click2mail.com/reference/createdocumentfromurl)

Version:1.0.1

Key:click2mail2-create-document

View on GitHub

Click2Mail Overview#

The Click2Mail API enables automated mailing solutions, letting you integrate direct mail processes within your digital workflows. On Pipedream, you can harness this API to craft serverless workflows that interact with other apps and services. Create, manage, and send postal mail without leaving your digital ecosystem. Automate mail for marketing, invoicing, or any correspondence that requires a physical mail presence.

Action Code#

import FormData from "form-data";
import { getFileStreamAndMetadata } from "@pipedream/platform";
import click2mail2 from "../../click2mail2.app.mjs";
import { FORMATS } from "../../common/constants.mjs";

export default {
  key: "click2mail2-create-document",
  name: "Create Document",
  version: "1.0.1",
  description: "Creates a new document in your account from an uploaded file or a URL. [See the documentation for file](https://developers.click2mail.com/reference/createdocument_1).  [See the documentation for URL](https://developers.click2mail.com/reference/createdocumentfromurl)",
  type: "action",
  props: {
    click2mail2,
    documentName: {
      type: "string",
      label: "Document Name",
      description: "Document name as it will be stored in your account.",
      optional: true,
    },
    documentFormat: {
      type: "string",
      label: "Document Format",
      description: "The format of the document.",
      options: FORMATS,
    },
    documentClass: {
      propDefinition: [
        click2mail2,
        "documentClass",
      ],
    },
    file: {
      type: "string",
      label: "File Path Or Url",
      description: "Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`).",
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      click2mail2,
      file,
      documentName,
      documentFormat,
      documentClass,
    } = this;

    const isUrl = file.startsWith("http://") || file.startsWith("https://");

    const objToSend = {
      params: {
        documentName,
        documentFormat,
        documentClass,
      },
    };

    if (!isUrl) {
      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(file);
      const formData = new FormData();
      formData.append("file", stream, {
        contentType: metadata.contentType,
        knownLength: metadata.size,
        filename: metadata.name,
      });

      objToSend.data = formData;
      objToSend.headers = formData.getHeaders();

    } else {
      objToSend.params.url = file;
    }

    const response = await click2mail2.create({
      $,
      path: `${!isUrl
        ? "documents"
        : "documents/url"}`,
      ...objToSend,
    });

    $.export("$summary", `A new file with Id: ${response.id} was successfully created!`);
    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
Click2Mail	`click2mail2`	`app`	This component uses the Click2Mail app.
Document Name	`documentName`	`string`	Document name as it will be stored in your account.
Document Format	`documentFormat`	`string`	Select a value from the drop down menu:`PDFDOCDOCXPUBPPTPPTXODTJPEGJPGPNG`
Document Class	`documentClass`	`string`	Select a value from the drop down menu:`Postcard 6 x 11Postcard 5 x 8Postcard 4.25 x 6Postcard 3.5 x 5Postcard 4 x 9Postcard 6 x 9Notecard 4.25 x 5.5Notecard - Folded 4.25 x 5.5Rack Card 4 x 9 - MailedFlyer 8.5 x 11Brochure 11 x 8.5Letter 8.5 x 11Letter 8.5 x 14Secure Self Mailer 8.5 x 11Booklet Self Mailer 8.5 x 11Booklet 8.5 x 11 - Address Front PageBooklet 8.5 x 11 - Address Back PageReply Letter 8.5 x 11Reply Postcard 4.25 x 6Certified Letter 8.5 x 11Certified Self Mailer 8.5 x 11Certified Self Mailer - with Green Card ReceiptPriority Letter 8.5 x 11Priority Mail Express Letter 8.5 x 11EDDM Mailer 6.25 x 11EDDM Mailer 6.5 x 9EDDM Mailer 8.5 x 12EDDM Mailer 8.5 x 11Postcard 3.5 x 5 - ShippedBrochure 11 x 8.5 - ShippedPostcard 4.25 x 6 - ShippedPostcard 5 x 8 - ShippedPostcard 6 x 11 - ShippedPostcard 6.5 x 9 - ShippedCardstock 12 x 4.5 - ShippedFlyer 8.5 x 11 - ShippedPostcard 4 x 9 - ShippedRack Card 4 x 9 - ShippedPostcard 4.25 x 6 Movers Format`
File Path Or Url	`file`	`string`	Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`).
syncDir	`syncDir`	`dir`

Action Authentication#

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

Click2Mail requires their users enter their Click2Mail username and password in order to connect to their API. For more info, refer to Click2Mail’s documentation.

About Click2Mail#

We build tech that lets you send mail from your computer in just a few clicks. Yes, you can call us the #MailNerds.

More Ways to Connect Click2Mail + Shopify#

Other Popular Integrations#

Create Document with Click2Mail API on New Abandoned Cart from Shopify Developer App API

Shopify + Click2Mail

Create Document with Click2Mail API on New Page from Shopify API

Pipedream makes it easy to connect APIs for Click2Mail, Shopify and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Get your Access Token

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular