Create Mail Check with OnlineCheckWriter API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Mail Check with the OnlineCheckWriter 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 Pipedream trigger and OnlineCheckWriter 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 Mail Check action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Shipping To Custom Address?
3. Optional- Select a Custom From Address ID
4. Optional- Select a Custom To Address ID
5. Optional- Select a Custom Shipping Type ID
6. Select a Check ID
7. Select a Shipping Type ID
8. Select a Paper Type ID
9. Optional- Select a Inform Type ID
10. Optional- Configure Enable SMS Inform
11. Optional- Configure Enable Email Inform
12. Optional- Configure Payee Email
13. Optional- Configure Payee Phone
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 Mail Check on OnlineCheckWriter

Description:Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).

Version:0.0.1

Key:onlinecheckwriter-create-mail-check

View on GitHub

Action Code#

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

export default {
  key: "onlinecheckwriter-create-mail-check",
  name: "Create Mail Check",
  description: "Creates a mail check. [See the documentation](https://apiv3.onlinecheckwriter.com/#f4562b65-70e8-4c4d-8444-8898e61ab7f0).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    isShippingToCustomAddress: {
      type: "boolean",
      label: "Shipping To Custom Address?",
      description: "Value is `true` if sending mail to custom address. Default `false`",
      optional: true,
    },
    customFromAddressId: {
      description: "Must be a custom from address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customFromAddressId",
      ],
    },
    customToAddressId: {
      description: "Must be a custom to address ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "customToAddressId",
      ],
    },
    customShippingTypeId: {
      label: "Custom Shipping Type ID",
      description: "Must be a valid custom shipping type ID. Required if **Shipping To Custom Address?** is `true`.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    checkId: {
      propDefinition: [
        app,
        "checkId",
      ],
    },
    shippingTypeId: {
      optional: false,
      description: "The shipping type ID of the check.",
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    paperTypeId: {
      propDefinition: [
        app,
        "paperTypeId",
      ],
    },
    informTypeId: {
      propDefinition: [
        app,
        "informTypeId",
      ],
    },
    enableSmsInform: {
      propDefinition: [
        app,
        "enableSmsInform",
      ],
    },
    enableEmailInform: {
      type: "boolean",
      label: "Enable Email Inform",
      description: "Value is `true` if email inform is enabled. Default `false`.",
      optional: true,
    },
    payeeEmail: {
      description: "Required if **Enable Email Inform** is `true` and there is no email on the associated payee.",
      propDefinition: [
        app,
        "payeeEmail",
      ],
    },
    payeePhone: {
      description: "Required if **Enable SMS Inform** is `true` and there is no phone on the associated payee.",
      propDefinition: [
        app,
        "payeePhone",
      ],
    },
  },
  methods: {
    createMailChecks(args = {}) {
      return this.app.post({
        path: "/mailchecks",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createMailChecks,
      isShippingToCustomAddress,
      customFromAddressId,
      customToAddressId,
      customShippingTypeId,
      checkId,
      shippingTypeId,
      paperTypeId,
      informTypeId,
      enableSmsInform,
      enableEmailInform,
      payeeEmail,
      payeePhone,
    } = this;

    const response = await createMailChecks({
      $,
      data: {
        isShippingToCustomAddress,
        customFromAddressId,
        customToAddressId,
        customShippingTypeId,
        mailChecks: [
          {
            checkId,
            shippingTypeId,
            paperTypeId,
            informTypeId,
            ...(enableSmsInform !== undefined && {
              enableSmsInform: +enableSmsInform,
            }),
            ...(enableEmailInform !== undefined && {
              enableEmailInform: +enableEmailInform,
            }),
            payeeEmail,
            payeePhone,
          },
        ],
      },
    });
    $.export("$summary", "Successfully created and mailed checks.");
    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
OnlineCheckWriter	`app`	`app`	This component uses the OnlineCheckWriter app.
Shipping To Custom Address?	`isShippingToCustomAddress`	`boolean`	Value is `true` if sending mail to custom address. Default `false`
Custom From Address ID	`customFromAddressId`	`string`	Select a value from the drop down menu.
Custom To Address ID	`customToAddressId`	`string`	Select a value from the drop down menu.
Custom Shipping Type ID	`customShippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Check ID	`checkId`	`string`	Select a value from the drop down menu.
Shipping Type ID	`shippingTypeId`	`string`	Select a value from the drop down menu:`{ "label": "First Class", "value": "1" }{ "label": "First Class with Tracking", "value": "3" }{ "label": "Priority Mail", "value": "4" }{ "label": "Express Mail", "value": "5" }{ "label": "Standard Overnight -Fedex-By 3pm the next business day", "value": "12" }{ "label": "Fedex Saturday Delivery", "value": "20" }`
Paper Type ID	`paperTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Regular Check Paper", "value": "7" }{ "label": "Hollogram Check Paper", "value": "8" }{ "label": "Ultra Hollogram Check Paper", "value": "9" }`
Inform Type ID	`informTypeId`	`string`	Select a value from the drop down menu:`{ "label": "Notify Receiver by Sms", "value": "10" }`
Enable SMS Inform	`enableSmsInform`	`boolean`	Value is `true` if SMS inform is enabled. Default `false`
Enable Email Inform	`enableEmailInform`	`boolean`	Value is `true` if email inform is enabled. Default `false`.
Payee Email	`payeeEmail`	`string`	Required if Enable Email Inform is `true` and there is no email on the associated payee.
Payee Phone	`payeePhone`	`string`	Required if Enable SMS Inform is `true` and there is no phone on the associated payee.

Action Authentication#

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

About OnlineCheckWriter#

Online Check Writer: Online Check Printing, eChecks, Mail Checks

More Ways to Connect OnlineCheckWriter + Pipedream#

Other Popular Integrations#

Create Check with OnlineCheckWriter API on New Scheduled Tasks from Pipedream API

Pipedream + OnlineCheckWriter

Try it

Create Email Check with OnlineCheckWriter API on New Scheduled Tasks from Pipedream API

Pipedream + OnlineCheckWriter

Try it

Mail PDF Document with OnlineCheckWriter API on New Scheduled Tasks from Pipedream API

Pipedream + OnlineCheckWriter

Try it

Create Payee with OnlineCheckWriter API on New Scheduled Tasks from Pipedream API

Pipedream + OnlineCheckWriter

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

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

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