Create Job with Click2Mail API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Create Job with the Click2Mail 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 Slack trigger and Click2Mail 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 Job action
1. Connect your Click2Mail account
2. Select a Document Class
3. Select a Layout
4. Select a Envelope
5. Select a Color
6. Select a Paper Type
7. Select a Print Option
8. Optional- Select a Document Id
9. Optional- Select a Address Id
10. Optional- Configure RTN Name
11. Optional- Configure RTN Organization
12. Optional- Configure RTN Address1
13. Optional- Configure RTN Address2
14. Optional- Configure RTN City
15. Optional- Configure RTN State
16. Optional- Configure RTN Zip
17. Optional- Select a Mail Class
18. Optional- Configure APP Signature
19. Optional- Select a Project Id
20. Optional- Configure Mailing Date
21. Optional- Configure Quantity
22. Optional- Select a Job Document Id
23. Optional- Configure Job Address Id
24. Optional- Configure Business Reply Address Id
25. Optional- Configure Courtesy Reply Address Id
26. Optional- Configure Return Address Id
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.15

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.15",
  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 Job on Click2Mail

Description:Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).

Version:0.0.1

Key:click2mail2-create-job

View on GitHub

Click2Mail Overview#

The Click2Mail API enables automated mailing solutions, letting you integrate direct mail processes within your digital workflows. On Pipedream, you can harness this API to craft serverless workflows that interact with other apps and services. Create, manage, and send postal mail without leaving your digital ecosystem. Automate mail for marketing, invoicing, or any correspondence that requires a physical mail presence.

Action Code#

import click2mail2 from "../../click2mail2.app.mjs";
import {
  COLOR,
  ENVELOPE,
  LAYOUT,
  MAILCLASS,
  PAPERTYPE,
  PRINTOPTION,
} from "../../common/constants.mjs";

export default {
  key: "click2mail2-create-job",
  name: "Create Job",
  version: "0.0.1",
  description: "Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).",
  type: "action",
  props: {
    click2mail2,
    documentClass: {
      propDefinition: [
        click2mail2,
        "documentClass",
      ],
    },
    layout: {
      type: "string",
      label: "Layout",
      description: "The specific type of the product",
      options: LAYOUT,
    },
    envelope: {
      type: "string",
      label: "Envelope",
      description: "If this is an enveloped product this determines the envelope in which the product is to be mailed; otherwise provide no value.",
      options: ENVELOPE,
    },
    color: {
      type: "string",
      label: "Color",
      description: "Print in color or black and white.",
      options: COLOR,
    },
    paperType: {
      type: "string",
      label: "Paper Type",
      description: "Sets the paper the mailing is to be printed on.",
      options: PAPERTYPE,
    },
    printOption: {
      type: "string",
      label: "Print Option",
      description: "Sets simplex or duplex printing.",
      options: PRINTOPTION,
    },
    documentId: {
      propDefinition: [
        click2mail2,
        "documentId",
      ],
      optional: true,
    },
    addressId: {
      propDefinition: [
        click2mail2,
        "addressId",
      ],
      optional: true,
    },
    rtnName: {
      type: "string",
      label: "RTN Name",
      description: "Return address Name.",
      optional: true,
    },
    rtnOrganization: {
      type: "string",
      label: "RTN Organization",
      description: "Return address Organization.",
      optional: true,
    },
    rtnaddress1: {
      type: "string",
      label: "RTN Address1",
      description: "Return address line 1.",
      optional: true,
    },
    rtnaddress2: {
      type: "string",
      label: "RTN Address2",
      description: "Return address line 2.",
      optional: true,
    },
    rtnCity: {
      type: "string",
      label: "RTN City",
      description: "Return address City.",
      optional: true,
    },
    rtnState: {
      type: "string",
      label: "RTN State",
      description: "Return address State.",
      optional: true,
    },
    rtnZip: {
      type: "string",
      label: "RTN Zip",
      description: "Return address Zip.",
      optional: true,
    },
    mailClass: {
      type: "string",
      label: "Mail Class",
      description: "Overrides the default of First Class for mailed products.",
      options: MAILCLASS,
      optional: true,
    },
    appSignature: {
      type: "string",
      label: "APP Signature",
      description: "This is a short signature to identify orders that come from your app.",
      optional: true,
    },
    projectId: {
      propDefinition: [
        click2mail2,
        "projectId",
      ],
      optional: true,
    },
    mailingDate: {
      type: "string",
      label: "Mailing Date",
      description: "Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.",
      optional: true,
    },
    quantity: {
      type: "string",
      label: "Quantity",
      description: "For products that do not use mailing lists. Quantity to print.",
      optional: true,
    },
    jobDocumentId: {
      propDefinition: [
        click2mail2,
        "jobDocumentId",
        ({ documentId }) => ({
          documentId,
        }),
      ],
      optional: true,
    },
    jobAddressId: {
      type: "string",
      label: "Job Address Id",
      description: "Address List Id of the job version.",
      optional: true,
    },
    businessReplyAddressId: {
      type: "integer",
      label: "Business Reply Address Id",
      description: "If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.",
      optional: true,
    },
    courtesyReplyAddressId: {
      type: "integer",
      label: "Courtesy Reply Address Id",
      description: "If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.",
      optional: true,
    },
    returnAddressId: {
      type: "integer",
      label: "Return Address Id",
      description: "You may use the return address id to specify a return address already in your account.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      click2mail2,
      ...params
    } = this;

    const response = await click2mail2.create({
      $,
      path: "jobs",
      params: {
        productionTime: "Next Day",
        ...params,
      },
    });

    $.export("$summary", `A new job with Id: ${response.id} was successfully created!`);
    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
Click2Mail	`click2mail2`	`app`	This component uses the Click2Mail app.
Document Class	`documentClass`	`string`	Select a value from the drop down menu:`Postcard 6 x 11Postcard 5 x 8Postcard 4.25 x 6Postcard 3.5 x 5Postcard 4 x 9Postcard 6 x 9Notecard 4.25 x 5.5Notecard - Folded 4.25 x 5.5Rack Card 4 x 9 - MailedFlyer 8.5 x 11Brochure 11 x 8.5Letter 8.5 x 11Letter 8.5 x 14Secure Self Mailer 8.5 x 11Booklet Self Mailer 8.5 x 11Booklet 8.5 x 11 - Address Front PageBooklet 8.5 x 11 - Address Back PageReply Letter 8.5 x 11Reply Postcard 4.25 x 6Certified Letter 8.5 x 11Certified Self Mailer 8.5 x 11Certified Self Mailer - with Green Card ReceiptPriority Letter 8.5 x 11Priority Mail Express Letter 8.5 x 11EDDM Mailer 6.25 x 11EDDM Mailer 6.5 x 9EDDM Mailer 8.5 x 12EDDM Mailer 8.5 x 11Postcard 3.5 x 5 - ShippedBrochure 11 x 8.5 - ShippedPostcard 4.25 x 6 - ShippedPostcard 5 x 8 - ShippedPostcard 6 x 11 - ShippedPostcard 6.5 x 9 - ShippedCardstock 12 x 4.5 - ShippedFlyer 8.5 x 11 - ShippedPostcard 4 x 9 - ShippedRack Card 4 x 9 - ShippedPostcard 4.25 x 6 Movers Format`
Layout	`layout`	`string`	Select a value from the drop down menu:`Address on Separate PageAddress on First PagePicture and Address First PageAddress Back Page`
Envelope	`envelope`	`string`	Select a value from the drop down menu:`#10 Double WindowBest Fit#10 Open Window Envelope6 x 9.5 Double Window6 x 9.5 Open WindowFlat Envelope`
Color	`color`	`string`	Select a value from the drop down menu:`Full ColorBlack and White`
Paper Type	`paperType`	`string`	Select a value from the drop down menu:`White 24#Off-White 28#Canary 24#White 28#White 28# Matte`
Print Option	`printOption`	`string`	Select a value from the drop down menu:`Printing One sidePrinting both sides`
Document Id	`documentId`	`string`	Select a value from the drop down menu.
Address Id	`addressId`	`string`	Select a value from the drop down menu.
RTN Name	`rtnName`	`string`	Return address Name.
RTN Organization	`rtnOrganization`	`string`	Return address Organization.
RTN Address1	`rtnaddress1`	`string`	Return address line 1.
RTN Address2	`rtnaddress2`	`string`	Return address line 2.
RTN City	`rtnCity`	`string`	Return address City.
RTN State	`rtnState`	`string`	Return address State.
RTN Zip	`rtnZip`	`string`	Return address Zip.
Mail Class	`mailClass`	`string`	Select a value from the drop down menu:`First ClassStandardFirst Class Live StampFirst Class Specialty StampFirst Class No Move Update`
APP Signature	`appSignature`	`string`	This is a short signature to identify orders that come from your app.
Project Id	`projectId`	`integer`	Select a value from the drop down menu.
Mailing Date	`mailingDate`	`string`	Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.
Quantity	`quantity`	`string`	For products that do not use mailing lists. Quantity to print.
Job Document Id	`jobDocumentId`	`string`	Select a value from the drop down menu.
Job Address Id	`jobAddressId`	`string`	Address List Id of the job version.
Business Reply Address Id	`businessReplyAddressId`	`integer`	If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.
Courtesy Reply Address Id	`courtesyReplyAddressId`	`integer`	If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.
Return Address Id	`returnAddressId`	`integer`	You may use the return address id to specify a return address already in your account.

Action Authentication#

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

Click2Mail requires their users enter their Click2Mail username and password in order to connect to their API. For more info, refer to Click2Mail’s documentation.

About Click2Mail#

We build tech that lets you send mail from your computer in just a few clicks. Yes, you can call us the #MailNerds.

More Ways to Connect Click2Mail + Slack#

Other Popular Integrations#

Create Document with Click2Mail API on New Star Added To Message (Instant) from Slack API

Slack + Click2Mail

Create Job with Click2Mail API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Click2Mail, 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