Create Job with Click2Mail API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Job with the Click2Mail API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Create Job action
1. Connect your Click2Mail account
2. Select a Document Class
3. Select a Layout
4. Select a Envelope
5. Select a Color
6. Select a Paper Type
7. Select a Print Option
8. Optional- Select a Document Id
9. Optional- Select a Address Id
10. Optional- Configure RTN Name
11. Optional- Configure RTN Organization
12. Optional- Configure RTN Address1
13. Optional- Configure RTN Address2
14. Optional- Configure RTN City
15. Optional- Configure RTN State
16. Optional- Configure RTN Zip
17. Optional- Select a Mail Class
18. Optional- Configure APP Signature
19. Optional- Select a Project Id
20. Optional- Configure Mailing Date
21. Optional- Configure Quantity
22. Optional- Select a Job Document Id
23. Optional- Configure Job Address Id
24. Optional- Configure Business Reply Address Id
25. Optional- Configure Courtesy Reply Address Id
26. Optional- Configure Return Address Id
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Create Job on Click2Mail

Description:Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).

Version:0.0.1

Key:click2mail2-create-job

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 click2mail2 from "../../click2mail2.app.mjs";
import {
  COLOR,
  ENVELOPE,
  LAYOUT,
  MAILCLASS,
  PAPERTYPE,
  PRINTOPTION,
} from "../../common/constants.mjs";

export default {
  key: "click2mail2-create-job",
  name: "Create Job",
  version: "0.0.1",
  description: "Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).",
  type: "action",
  props: {
    click2mail2,
    documentClass: {
      propDefinition: [
        click2mail2,
        "documentClass",
      ],
    },
    layout: {
      type: "string",
      label: "Layout",
      description: "The specific type of the product",
      options: LAYOUT,
    },
    envelope: {
      type: "string",
      label: "Envelope",
      description: "If this is an enveloped product this determines the envelope in which the product is to be mailed; otherwise provide no value.",
      options: ENVELOPE,
    },
    color: {
      type: "string",
      label: "Color",
      description: "Print in color or black and white.",
      options: COLOR,
    },
    paperType: {
      type: "string",
      label: "Paper Type",
      description: "Sets the paper the mailing is to be printed on.",
      options: PAPERTYPE,
    },
    printOption: {
      type: "string",
      label: "Print Option",
      description: "Sets simplex or duplex printing.",
      options: PRINTOPTION,
    },
    documentId: {
      propDefinition: [
        click2mail2,
        "documentId",
      ],
      optional: true,
    },
    addressId: {
      propDefinition: [
        click2mail2,
        "addressId",
      ],
      optional: true,
    },
    rtnName: {
      type: "string",
      label: "RTN Name",
      description: "Return address Name.",
      optional: true,
    },
    rtnOrganization: {
      type: "string",
      label: "RTN Organization",
      description: "Return address Organization.",
      optional: true,
    },
    rtnaddress1: {
      type: "string",
      label: "RTN Address1",
      description: "Return address line 1.",
      optional: true,
    },
    rtnaddress2: {
      type: "string",
      label: "RTN Address2",
      description: "Return address line 2.",
      optional: true,
    },
    rtnCity: {
      type: "string",
      label: "RTN City",
      description: "Return address City.",
      optional: true,
    },
    rtnState: {
      type: "string",
      label: "RTN State",
      description: "Return address State.",
      optional: true,
    },
    rtnZip: {
      type: "string",
      label: "RTN Zip",
      description: "Return address Zip.",
      optional: true,
    },
    mailClass: {
      type: "string",
      label: "Mail Class",
      description: "Overrides the default of First Class for mailed products.",
      options: MAILCLASS,
      optional: true,
    },
    appSignature: {
      type: "string",
      label: "APP Signature",
      description: "This is a short signature to identify orders that come from your app.",
      optional: true,
    },
    projectId: {
      propDefinition: [
        click2mail2,
        "projectId",
      ],
      optional: true,
    },
    mailingDate: {
      type: "string",
      label: "Mailing Date",
      description: "Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.",
      optional: true,
    },
    quantity: {
      type: "string",
      label: "Quantity",
      description: "For products that do not use mailing lists. Quantity to print.",
      optional: true,
    },
    jobDocumentId: {
      propDefinition: [
        click2mail2,
        "jobDocumentId",
        ({ documentId }) => ({
          documentId,
        }),
      ],
      optional: true,
    },
    jobAddressId: {
      type: "string",
      label: "Job Address Id",
      description: "Address List Id of the job version.",
      optional: true,
    },
    businessReplyAddressId: {
      type: "integer",
      label: "Business Reply Address Id",
      description: "If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.",
      optional: true,
    },
    courtesyReplyAddressId: {
      type: "integer",
      label: "Courtesy Reply Address Id",
      description: "If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.",
      optional: true,
    },
    returnAddressId: {
      type: "integer",
      label: "Return Address Id",
      description: "You may use the return address id to specify a return address already in your account.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      click2mail2,
      ...params
    } = this;

    const response = await click2mail2.create({
      $,
      path: "jobs",
      params: {
        productionTime: "Next Day",
        ...params,
      },
    });

    $.export("$summary", `A new job 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 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`
Layout	`layout`	`string`	Select a value from the drop down menu:`Address on Separate PageAddress on First PagePicture and Address First PageAddress Back Page`
Envelope	`envelope`	`string`	Select a value from the drop down menu:`#10 Double WindowBest Fit#10 Open Window Envelope6 x 9.5 Double Window6 x 9.5 Open WindowFlat Envelope`
Color	`color`	`string`	Select a value from the drop down menu:`Full ColorBlack and White`
Paper Type	`paperType`	`string`	Select a value from the drop down menu:`White 24#Off-White 28#Canary 24#White 28#White 28# Matte`
Print Option	`printOption`	`string`	Select a value from the drop down menu:`Printing One sidePrinting both sides`
Document Id	`documentId`	`string`	Select a value from the drop down menu.
Address Id	`addressId`	`string`	Select a value from the drop down menu.
RTN Name	`rtnName`	`string`	Return address Name.
RTN Organization	`rtnOrganization`	`string`	Return address Organization.
RTN Address1	`rtnaddress1`	`string`	Return address line 1.
RTN Address2	`rtnaddress2`	`string`	Return address line 2.
RTN City	`rtnCity`	`string`	Return address City.
RTN State	`rtnState`	`string`	Return address State.
RTN Zip	`rtnZip`	`string`	Return address Zip.
Mail Class	`mailClass`	`string`	Select a value from the drop down menu:`First ClassStandardFirst Class Live StampFirst Class Specialty StampFirst Class No Move Update`
APP Signature	`appSignature`	`string`	This is a short signature to identify orders that come from your app.
Project Id	`projectId`	`integer`	Select a value from the drop down menu.
Mailing Date	`mailingDate`	`string`	Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.
Quantity	`quantity`	`string`	For products that do not use mailing lists. Quantity to print.
Job Document Id	`jobDocumentId`	`string`	Select a value from the drop down menu.
Job Address Id	`jobAddressId`	`string`	Address List Id of the job version.
Business Reply Address Id	`businessReplyAddressId`	`integer`	If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.
Courtesy Reply Address Id	`courtesyReplyAddressId`	`integer`	If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.
Return Address Id	`returnAddressId`	`integer`	You may use the return address id to specify a return address already in your account.

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 + Pipedream#

Other Popular Integrations#

Create Document with Click2Mail API on New Scheduled Tasks from Pipedream API

Pipedream + Click2Mail

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Upcoming Event Type Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event of the specified type ("default", "focusTime", "outOfOffice", "workingLocation") in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it