Create Letter with Lob API on New Collection from MongoDB API

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

Trigger workflow on

New Collection from the MongoDB API

Next, do this

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

Select this integration
Configure the New Collection trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
Configure the Create Letter action
1. Connect your Lob account
2. Select a To
3. Configure Description
4. Select a From
5. Optional- Configure Name
6. Optional- Configure Company
7. Optional- Configure Email
8. Optional- Configure Phone
9. Optional- Configure Address Line 1
10. Optional- Configure Address Line 2
11. Optional- Configure City
12. Optional- Configure State
13. Optional- Configure ZIP Code
14. Optional- Configure Country
15. Configure File
16. Configure Color
17. Select a Use Type
18. Optional- Select a Mail Type
19. Optional- Configure Send Date
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 Collection on MongoDB

Description:Emit new an event when a new collection is added to a database

Version:0.0.7

Key:mongodb-new-collection

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

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

export default {
  ...common,
  key: "mongodb-new-collection",
  name: "New Collection",
  description: "Emit new an event when a new collection is added to a database",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getCollectionIds() {
      return this.db.get("collectionIds");
    },
    _setCollectionIds(collectionIds) {
      this.db.set("collectionIds", collectionIds);
    },
    isRelevant(uuid, collectionIds) {
      return !collectionIds.includes(uuid);
    },
    async processEvent(client, ts) {
      const collectionIds = this._getCollectionIds() || [];
      const collections = await this.mongodb.listCollections(client, this.database);
      for (const collection of collections) {
        const uuid = JSON.stringify(collection.info.uuid);
        if (!this.isRelevant(uuid, collectionIds)) {
          continue;
        }
        collectionIds.push(uuid);
        this.emitEvent(collection, ts);
      }
      this._setCollectionIds(collectionIds);
    },
    generateMeta({
      info, name,
    }, ts) {
      return {
        id: info.uuid,
        summary: name,
        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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Create Letter on Lob

Description:Creates a new letter. [See docs here](https://docs.lob.com/#tag/Letters/operation/letter_create).

Version:0.0.1

Key:lob-create-letter

View on GitHub

Lob Overview#

The Lob API provides a suite of automation capabilities focused on direct mail, address verification, and print management. With Lob, you can automate the sending of physical mail programmatically, verify addresses to ensure deliverability, and manage printing logistics for marketing campaigns or operational needs. It's a powerful tool for bridging the digital and physical mailing worlds, particularly useful for marketing, billing, and compliance communications.

Action Code#

import { defineAction } from "@pipedream/types";
import lob from "../../app/lob.app.mjs";
import constants from "../../app/common/constants.mjs";
export default defineAction({
    key: "lob-create-letter",
    name: "Create Letter",
    description: "Creates a new letter. [See docs here](https://docs.lob.com/#tag/Letters/operation/letter_create).",
    version: "0.0.1",
    type: "action",
    props: {
        lob,
        to: {
            propDefinition: [
                lob,
                "addressId",
            ],
            label: "To",
            description: "Must either be an `addressId` or an inline object with correct address parameters",
        },
        description: {
            type: "string",
            label: "Description",
            description: "An internal description that identifies this resource",
        },
        from: {
            propDefinition: [
                lob,
                "addressId",
            ],
            label: "From",
            description: "Required if `to` address is international. Must either be an `addressId` or an inline object with correct address parameters",
        },
        name: {
            type: "string",
            label: "Name",
            description: "Name of the recipient.",
            optional: true,
        },
        company: {
            type: "string",
            label: "Company",
            description: "Company name associated with the recipient.",
            optional: true,
        },
        email: {
            type: "string",
            label: "Email",
            description: "Email address of the recipient.",
            optional: true,
        },
        phone: {
            type: "string",
            label: "Phone",
            description: "Phone number of the recipient.",
            optional: true,
        },
        addressLine1: {
            type: "string",
            label: "Address Line 1",
            description: "First line of the address.",
            optional: true,
        },
        addressLine2: {
            type: "string",
            label: "Address Line 2",
            description: "Second line of the address.",
            optional: true,
        },
        addressCity: {
            type: "string",
            label: "City",
            description: "City of the address.",
            optional: true,
        },
        addressState: {
            type: "string",
            label: "State",
            description: "State of the address.",
            optional: true,
        },
        addressZip: {
            type: "string",
            label: "ZIP Code",
            description: "ZIP code of the address.",
            optional: true,
        },
        addressCountry: {
            type: "string",
            label: "Country",
            description: "Country of the address.",
            optional: true,
        },
        file: {
            type: "string",
            label: "File",
            description: "Letter content in HTML",
        },
        color: {
            type: "boolean",
            label: "Color",
            description: "Set to true if you want to print in color; set to false for black and white.",
        },
        useType: {
            type: "string",
            label: "Use Type",
            description: "The use type of the mail. It can only be null if an account default use_type is selected).",
            options: constants.USE_TYPES,
        },
        mailType: {
            type: "string",
            label: "Mail Type",
            description: "Designates the mail postage type.",
            options: constants.MAIL_TYPES,
            optional: true,
        },
        sendDate: {
            type: "string",
            label: "Send Date",
            description: "Specifies the date to send the letter off for production (ISO 8601 format, up to 180 days in the future).",
            optional: true,
        },
    },
    async run({ $ }) {
        const response = await this.lob.createLetter({
            to: this.to ?? {
                name: this.name,
                company: this.company,
                email: this.email,
                phone: this.phone,
                address_line1: this.addressLine1,
                address_line2: this.addressLine2,
                address_city: this.addressCity,
                address_state: this.addressState,
                address_zip: this.addressZip,
                address_country: this.addressCountry,
            },
            description: this.description,
            from: this.from,
            file: this.file,
            color: this.color,
            use_type: this.useType,
            mail_type: this.mailType,
            send_date: this.sendDate,
        });
        $.export("$summary", `Successfully created letter 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
Lob	`lob`	`app`	This component uses the Lob app.
To	`to`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	An internal description that identifies this resource
From	`from`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the recipient.
Company	`company`	`string`	Company name associated with the recipient.
Email	`email`	`string`	Email address of the recipient.
Phone	`phone`	`string`	Phone number of the recipient.
Address Line 1	`addressLine1`	`string`	First line of the address.
Address Line 2	`addressLine2`	`string`	Second line of the address.
City	`addressCity`	`string`	City of the address.
State	`addressState`	`string`	State of the address.
ZIP Code	`addressZip`	`string`	ZIP code of the address.
Country	`addressCountry`	`string`	Country of the address.
File	`file`	`string`	Letter content in HTML
Color	`color`	`boolean`	Set to true if you want to print in color; set to false for black and white.
Use Type	`useType`	`string`	Select a value from the drop down menu:`{ "label": "Marketing", "value": "marketing" }{ "label": "Operational", "value": "operational" }`
Mail Type	`mailType`	`string`	Select a value from the drop down menu:`usps_first_classusps_standard`
Send Date	`sendDate`	`string`	Specifies the date to send the letter off for production (ISO 8601 format, up to 180 days in the future).

Action Authentication#

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

Enter your Live Lob secret API key below.

You can find this key under your account settings in the Lob dashboard.

Alternatively, you can use your Test Secret API Key, but you'll need to create a new Lob Connected Account in Pipedream in order to make Live requests.