Create Letter with Lob API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Create Letter with the Lob API

No credit card required

▶

Watch us build a workflow

4 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 Slack 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 Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.14

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. When you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions, or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.14",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      console.log(event.s);
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return 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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

Slack uses OAuth authentication. When you connect your Slack account, Pipedream will open a popup window where you can sign into Slack and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Slack API.

Pipedream requests the following authorization scopes when you connect your account:

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

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.

About Lob#

Direct Mail Automation and Address Verification APIs

More Ways to Connect Lob + Slack#

Other Popular Integrations#

Cancel Postcard with Lob API on New Star Added To Message (Instant) from Slack API

Slack + Lob

Create Letter with Lob API on New Message In Channels (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular