Mail PDF Document with OnlineCheckWriter API on New Webhook Event (Instant) from Supabase API

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

Trigger workflow on

New Webhook Event (Instant) from the Supabase API

Next, do this

Mail PDF Document 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 Supabase 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 Webhook Event (Instant) trigger
1. Connect your Supabase account
2. Configure Table
3. Optional- Configure Row Identifier
Configure the Mail PDF Document action
1. Connect your OnlineCheckWriter account
2. Optional- Configure Document Title
3. Configure File Path
4. Select a Shipping Type ID
5. Optional- Configure Sender Name
6. Optional- Configure Sender Company
7. Optional- Configure Sender Address 1
8. Optional- Configure Sender Address 2
9. Optional- Configure Sender City
10. Optional- Configure Sender State
11. Optional- Configure Sender Zip
12. Optional- Configure Sender Phone
13. Optional- Configure Sender Email
14. Configure Destination Name
15. Optional- Configure Destination Company
16. Configure Destination Address 1
17. Optional- Configure Destination Address 2
18. Configure Destination City
19. Configure Destination State
20. Configure Destination Zip
21. Optional- Configure Destination Phone
22. Optional- Configure Destination Email
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 Webhook Event (Instant) on Supabase

Description:Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)

Version:0.0.4

Key:supabase-new-webhook-event

View on GitHub

Supabase Overview#

Supabase is a real-time backend-as-a-service that provides developers with a suite of tools to quickly build and scale their applications. It offers database storage, authentication, instant APIs, and real-time subscriptions. With the Supabase API, you can perform CRUD operations on your database, manage users, and listen to database changes in real time. When integrated with Pipedream, you can automate workflows that react to these database events, synchronize data across multiple services, or streamline user management processes.

Trigger Code#

import base from "../common/base.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "supabase-new-webhook-event",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)",
  version: "0.0.4",
  type: "source",
  props: {
    ...base.props,
    http: {
      type: "$.interface.http",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.supabase._client();
      const query = client
        .from(this.table)
        .select()
        .range(0, constants.HISTORICAL_EVENT_LIMIT);
      const { data } = await query;
      for (const row of data) {
        this.$emit({
          record: row,
        }, {
          summary: "Historical row in table",
        });
      }
    },
  },
  async run(event) {
    const { body: data } = event;
    let summary = `New ${data.type} event in table`;
    if (data.record?.[this.rowIdentifier]) {
      summary = `${summary}: ${data.record[this.rowIdentifier]}`;
    }
    this.$emit(data, {
      summary,
    });
  },
};

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
Supabase	`supabase`	`app`	This component uses the Supabase app.
Table	`table`	`string`	The name of the table to watch for new rows
Row Identifier	`rowIdentifier`	`string`	The column name to use as the row identifier
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.

Trigger Authentication#

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

Supabase provides a Service Key to get started. You can find the service_role in the API Settings page.

Finding the Supabase subdomain

About Supabase#

Supabase is an open source Firebase alternative.

Action#

Mail PDF Document on OnlineCheckWriter

Description:Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).

Version:0.0.1

Key:onlinecheckwriter-mail-pdf-document

View on GitHub

Action Code#

import fs from "fs";
import FormData from "form-data";
import { ConfigurationError } from "@pipedream/platform";
import app from "../../onlinecheckwriter.app.mjs";

export default {
  key: "onlinecheckwriter-mail-pdf-document",
  name: "Mail PDF Document",
  description: "Mails a PDF document to a destination. [See the documentation](https://apiv3.onlinecheckwriter.com/#878daf05-e36e-44a2-bce8-15f24d72f82e).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    documentTitle: {
      type: "string",
      label: "Document Title",
      description: "The title of the document.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).",
    },
    shippingTypeId: {
      optional: false,
      propDefinition: [
        app,
        "shippingTypeId",
      ],
    },
    senderName: {
      type: "string",
      label: "Sender Name",
      description: "The name of the sender.",
      optional: true,
    },
    senderCompany: {
      type: "string",
      label: "Sender Company",
      description: "The company of the sender.",
      optional: true,
    },
    senderAddress1: {
      type: "string",
      label: "Sender Address 1",
      description: "The first line of the sender's address.",
      optional: true,
    },
    senderAddress2: {
      type: "string",
      label: "Sender Address 2",
      description: "The second line of the sender's address.",
      optional: true,
    },
    senderCity: {
      type: "string",
      label: "Sender City",
      description: "The city of the sender.",
      optional: true,
    },
    senderState: {
      type: "string",
      label: "Sender State",
      description: "The state of the sender.",
      optional: true,
    },
    senderZip: {
      type: "string",
      label: "Sender Zip",
      description: "The zip code of the sender.",
      optional: true,
    },
    senderPhone: {
      type: "string",
      label: "Sender Phone",
      description: "The phone number of the sender.",
      optional: true,
    },
    senderEmail: {
      type: "string",
      label: "Sender Email",
      description: "The email address of the sender.",
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The name of the recipient.",
    },
    destinationCompany: {
      type: "string",
      label: "Destination Company",
      description: "The company of the recipient.",
      optional: true,
    },
    destinationAddress1: {
      type: "string",
      label: "Destination Address 1",
      description: "The first line of the recipient's address.",
    },
    destinationAddress2: {
      type: "string",
      label: "Destination Address 2",
      description: "The second line of the recipient's address.",
      optional: true,
    },
    destinationCity: {
      type: "string",
      label: "Destination City",
      description: "The city of the recipient.",
    },
    destinationState: {
      type: "string",
      label: "Destination State",
      description: "The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.",
    },
    destinationZip: {
      type: "string",
      label: "Destination Zip",
      description: "The zip code of the recipient.",
    },
    destinationPhone: {
      type: "string",
      label: "Destination Phone",
      description: "The phone number of the recipient.",
      optional: true,
    },
    destinationEmail: {
      type: "string",
      label: "Destination Email",
      description: "The email address of the recipient.",
      optional: true,
    },
  },
  methods: {
    mailPdfDocument(args = {}) {
      return this.app.post({
        path: "/documentmailing/mail",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      mailPdfDocument,
      documentTitle,
      filePath,
      shippingTypeId,
      senderName,
      senderCompany,
      senderAddress1,
      senderAddress2,
      senderCity,
      senderState,
      senderZip,
      senderPhone,
      senderEmail,
      destinationName,
      destinationCompany,
      destinationAddress1,
      destinationAddress2,
      destinationCity,
      destinationState,
      destinationZip,
      destinationPhone,
      destinationEmail,
    } = this;

    if (!filePath?.startsWith("/tmp/")) {
      throw new ConfigurationError("The file path must start with `/tmp/`.");
    }

    const data = new FormData();
    const file = fs.createReadStream(filePath);
    data.append("document_details[file]", file);
    data.append("document_details[title]", documentTitle || "");
    data.append("shipping[shippingTypeId]", shippingTypeId || "");
    data.append("destination[name]", destinationName || "");
    data.append("destination[company]", destinationCompany || "");
    data.append("destination[address1]", destinationAddress1 || "");
    data.append("destination[address2]", destinationAddress2 || "");
    data.append("destination[city]", destinationCity || "");
    data.append("destination[state]", destinationState || "");
    data.append("destination[zip]", destinationZip || "");
    data.append("destination[phone]", destinationPhone || "");
    data.append("destination[email]", destinationEmail || "");
    data.append("from_address[name]", senderName || "");
    data.append("from_address[company]", senderCompany || "");
    data.append("from_address[address1]", senderAddress1 || "");
    data.append("from_address[address2]", senderAddress2 || "");
    data.append("from_address[city]", senderCity || "");
    data.append("from_address[state]", senderState || "");
    data.append("from_address[zip]", senderZip || "");
    data.append("from_address[phone]", senderPhone || "");
    data.append("from_address[email]", senderEmail || "");
    const response = await mailPdfDocument({
      $,
      data,
      headers: data.getHeaders(),
    });

    $.export("$summary", "Successfully generated and mailed PDF document");
    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.
Document Title	`documentTitle`	`string`	The title of the document.
File Path	`filePath`	`string`	The path to the pdf file saved to the `/tmp` directory (e.g. `/tmp/example.pdf`). See the documentation.
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" }`
Sender Name	`senderName`	`string`	The name of the sender.
Sender Company	`senderCompany`	`string`	The company of the sender.
Sender Address 1	`senderAddress1`	`string`	The first line of the sender's address.
Sender Address 2	`senderAddress2`	`string`	The second line of the sender's address.
Sender City	`senderCity`	`string`	The city of the sender.
Sender State	`senderState`	`string`	The state of the sender.
Sender Zip	`senderZip`	`string`	The zip code of the sender.
Sender Phone	`senderPhone`	`string`	The phone number of the sender.
Sender Email	`senderEmail`	`string`	The email address of the sender.
Destination Name	`destinationName`	`string`	The name of the recipient.
Destination Company	`destinationCompany`	`string`	The company of the recipient.
Destination Address 1	`destinationAddress1`	`string`	The first line of the recipient's address.
Destination Address 2	`destinationAddress2`	`string`	The second line of the recipient's address.
Destination City	`destinationCity`	`string`	The city of the recipient.
Destination State	`destinationState`	`string`	The state of the recipient. Use 2 characters Eg. `Tx` instead of `Texas` for example.
Destination Zip	`destinationZip`	`string`	The zip code of the recipient.
Destination Phone	`destinationPhone`	`string`	The phone number of the recipient.
Destination Email	`destinationEmail`	`string`	The email address of the recipient.

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

Other Popular Integrations#

Create Check with OnlineCheckWriter API on New Row Added from Supabase API

Supabase + OnlineCheckWriter

Try it

Create Check with OnlineCheckWriter API on New Webhook Event (Instant) from Supabase API

Supabase + OnlineCheckWriter

Try it

Mail PDF Document with OnlineCheckWriter API on New Row Added from Supabase API

Supabase + OnlineCheckWriter

Try it

Create Email Check with OnlineCheckWriter API on New Row Added from Supabase API

Supabase + OnlineCheckWriter

Try it

Create Email Check with OnlineCheckWriter API on New Webhook Event (Instant) from Supabase API

Supabase + OnlineCheckWriter

Try it

Popular Triggers#

New Row Added from the Supabase API

Emit new event for every new row added in a table. See documentation here

Try it

New Webhook Event (Instant) from the Supabase API

Emit new event for every insert, update, or delete operation in a table. This source requires user configuration using the Supabase website. More information in the README. Also see documentation here

Try it