Mail Postcard with DocuPost API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Mail Postcard with the DocuPost 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 Slack trigger and DocuPost 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 Mail Postcard action
1. Connect your DocuPost account
2. Configure Front Image URL
3. Configure Back Image URL
4. Configure Recipient's Name
5. Configure Recipient's Address Line 1
6. Optional- Configure Recipient's Address Line 2
7. Configure Recipient's City
8. Select a Recipient's State
9. Configure Recipient's Postal Code
10. Configure Sender's Name
11. Configure Sender's Address Line 1
12. Optional- Configure Sender's Address Line 2
13. Configure Sender's City
14. Select a Sender's State
15. Configure Sender's Postal Code
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.22

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. Once 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 constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.22",
  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;
      }
      // 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#

Mail Postcard on DocuPost

Description:Dispatches a glossy, color 4x6 postcard via the US Postal Service. [See the documentation](https://help.docupost.com/help/send-postcard-api)

Version:0.0.1

Key:docupost-mail-postcard

View on GitHub

DocuPost Overview#

The DocuPost API enables automated mail handling, offering services like sending letters, postcards, and checks via a programmatic interface. Within Pipedream, you can harness this API to create dynamic, serverless workflows that trigger postal mail actions based on various events from a plethora of supported apps. Think of automating thank-you notes, payment disbursements, or direct mail marketing campaigns, all reacting in real-time to user behavior, payment events, or custom triggers.

Action Code#

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

export default {
  key: "docupost-mail-postcard",
  name: "Mail Postcard",
  description: "Dispatches a glossy, color 4x6 postcard via the US Postal Service. [See the documentation](https://help.docupost.com/help/send-postcard-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    frontImage: {
      type: "string",
      label: "Front Image URL",
      description: "A valid image URL for the front of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size.",
    },
    backImage: {
      type: "string",
      label: "Back Image URL",
      description: "A valid image URL for the back of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Important: Your recipient/sender and postage information will be automatically overlaid onto your image. See [this template](https://docupost.s3.us-east-2.amazonaws.com/postcardtemplateback_ip0jws.png) as an example. ",
    },
    toName: {
      propDefinition: [
        app,
        "toName",
      ],
    },
    toAddress1: {
      propDefinition: [
        app,
        "toAddress1",
      ],
    },
    toAddress2: {
      propDefinition: [
        app,
        "toAddress2",
      ],
    },
    toCity: {
      propDefinition: [
        app,
        "toCity",
      ],
    },
    toState: {
      propDefinition: [
        app,
        "toState",
      ],
    },
    toZip: {
      propDefinition: [
        app,
        "toZip",
      ],
    },
    fromName: {
      propDefinition: [
        app,
        "fromName",
      ],
    },
    fromAddress1: {
      propDefinition: [
        app,
        "fromAddress1",
      ],
    },
    fromAddress2: {
      propDefinition: [
        app,
        "fromAddress2",
      ],
    },
    fromCity: {
      propDefinition: [
        app,
        "fromCity",
      ],
    },
    fromState: {
      propDefinition: [
        app,
        "fromState",
      ],
    },
    fromZip: {
      propDefinition: [
        app,
        "fromZip",
      ],
    },
  },
  methods: {
    sendPostcard(args = {}) {
      return this.app.post({
        path: "/sendpostcard",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      sendPostcard,
      frontImage,
      backImage,
      toName,
      toAddress1,
      toAddress2,
      toCity,
      toState,
      toZip,
      fromName,
      fromAddress1,
      fromAddress2,
      fromCity,
      fromState,
      fromZip,
    } = this;

    const response = await sendPostcard({
      $,
      params: {
        front_image: frontImage,
        back_image: backImage,
        to_name: toName,
        to_address1: toAddress1,
        to_address2: toAddress2,
        to_city: toCity,
        to_state: toState,
        to_zip: toZip,
        from_name: fromName,
        from_address1: fromAddress1,
        from_address2: fromAddress2,
        from_city: fromCity,
        from_state: fromState,
        from_zip: fromZip,
      },
    });

    $.export("$summary", "Successfully sent 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
DocuPost	`app`	`app`	This component uses the DocuPost app.
Front Image URL	`frontImage`	`string`	A valid image URL for the front of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size.
Back Image URL	`backImage`	`string`	A valid image URL for the back of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Important: Your recipient/sender and postage information will be automatically overlaid onto your image. See this template as an example.
Recipient's Name	`toName`	`string`	The name of the recipient (who the letter/postcard is being sent to). Must be less than 40 characters.
Recipient's Address Line 1	`toAddress1`	`string`	The first line of the recipient's address.
Recipient's Address Line 2	`toAddress2`	`string`	The second line of the recipient's address.
Recipient's City	`toCity`	`string`	The city of the recipient.
Recipient's State	`toState`	`string`	Select a value from the drop down menu:`{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }`
Recipient's Postal Code	`toZip`	`string`	The 5-digit postal code for the recipient.
Sender's Name	`fromName`	`string`	Your sender/return address name. Must be less than 40 characters.
Sender's Address Line 1	`fromAddress1`	`string`	The first line of your sender/return address.
Sender's Address Line 2	`fromAddress2`	`string`	The second line of your sender/return address.
Sender's City	`fromCity`	`string`	The city of your sender/return address.
Sender's State	`fromState`	`string`	Select a value from the drop down menu:`{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }`
Sender's Postal Code	`fromZip`	`string`	The 5-digit postal code for your sender/return address.

Mail Postcard with DocuPost API on New Message In Channels (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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