Create Postcard with Lob API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Create Postcard 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 Schedule 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 Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Postcard action
1. Connect your Lob account
2. Configure Description
3. Select a To
4. Configure Front
5. Configure Back
6. Select a Size
7. Select a Mail Type
8. Optional- Configure Merge Variables
9. Optional- Configure Send Date
10. Optional- Select a From
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#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Postcard on Lob

Description:Creates a new postcard given information. [See docs here](https://docs.lob.com/#tag/Postcards/operation/postcard_create).

Version:0.0.2

Key:lob-create-postcard

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-postcard",
    name: "Create Postcard",
    description: "Creates a new postcard given information. [See docs here](https://docs.lob.com/#tag/Postcards/operation/postcard_create).",
    version: "0.0.2",
    type: "action",
    props: {
        lob,
        description: {
            type: "string",
            label: "Description",
            description: "An internal description that identifies this resource",
        },
        to: {
            propDefinition: [
                lob,
                "addressId",
            ],
            label: "To",
            description: "Must either be an `addressId` or an inline object with correct address parameters",
        },
        front: {
            type: "string",
            label: "Front",
            description: "The artwork to use as the front of your postcard. May be a `templateId` or a HTML string. [HTML Examples](https://docs.lob.com/#section/HTML-Examples)",
        },
        back: {
            type: "string",
            label: "Back",
            description: "The artwork to use as the back of your postcard. May be a `templateId` or a HTML string. Be sure to leave room for address and postage information as in this [example template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/postcards/4x6_postcard.pdf).",
        },
        size: {
            type: "string",
            label: "Size",
            description: "Specifies the size of the postcard. Only **4x6** postcards can be sent to international destinations",
            options: constants.POSTCARD_SIZES,
            default: "4x6",
        },
        mailType: {
            type: "string",
            label: "Mail Type",
            description: "The mail postage type: `usps_first_class` (default) or `usps_standard` - a cheaper option which is less predictable and takes longer to deliver",
            options: constants.MAIL_TYPES,
            default: "usps_first_class",
        },
        mergeVariables: {
            type: "object",
            label: "Merge Variables",
            description: "An object for substituting variables to render dynamic content in your template. [Merge Variables Guide](https://help.lob.com/en_US/print_mail/dynamic-personalization#using-html-and-merge-variables)",
            optional: true,
        },
        sendDate: {
            type: "string",
            label: "Send Date",
            description: "A timestamp in **ISO 8601** format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Until the `send_date` has passed, the mailpiece can be canceled",
            optional: true,
        },
        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",
            optional: true,
        },
    },
    async run({ $ }) {
        const response = await this.lob.createPostcard({
            description: this.description,
            to: this.to,
            front: this.front,
            back: this.back,
            size: this.size,
            mailType: this.mailType,
            merge_variables: this.mergeVariables,
            send_date: this.sendDate,
            from: this.from,
        });
        $.export("$summary", "Successfully created postcard");
        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.
Description	`description`	`string`	An internal description that identifies this resource
To	`to`	`string`	Select a value from the drop down menu.
Front	`front`	`string`	The artwork to use as the front of your postcard. May be a `templateId` or a HTML string. HTML Examples
Back	`back`	`string`	The artwork to use as the back of your postcard. May be a `templateId` or a HTML string. Be sure to leave room for address and postage information as in this example template.
Size	`size`	`string`	Select a value from the drop down menu:`4x66x96x11`
Mail Type	`mailType`	`string`	Select a value from the drop down menu:`usps_first_classusps_standard`
Merge Variables	`mergeVariables`	`object`	An object for substituting variables to render dynamic content in your template. Merge Variables Guide
Send Date	`sendDate`	`string`	A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Until the `send_date` has passed, the mailpiece can be canceled
From	`from`	`string`	Select a value from the drop down menu.

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.

Try it

Cancel Postcard with Lob API on Weekly schedule from Schedule API

Schedule + Lob

Try it

Cancel Postcard with Lob API on Custom Interval from Schedule API

Schedule + Lob

Try it

Cancel Postcard with Lob API on Monthly Schedule from Schedule API

Schedule + Lob

Try it

Create Postcard with Lob API on Daily schedule from Schedule API

Schedule + Lob

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

Popular Actions#

Cancel Postcard with the Lob API

Completely removes a postcard from production. This can only be done if the postcard has a send_date and the send_date has not yet passed. See docs here.

Try it

Create Letter with the Lob API

Creates a new letter. See docs here.

Try it

Create Postcard with the Lob API

Creates a new postcard given information. See docs here.

Try it

List Postcards with the Lob API

Returns a list of your postcards. See docs here.

Try it

Retrieve Postcard with the Lob API

Retrieves the details of an existing postcard. See docs here.