Send Email With Template with Postmark API on New Message In Channels (Instant) from Slack API

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

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

Send Email With Template with the Postmark 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 Postmark 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 Send Email With Template action
1. Connect your Postmark account
2. Select a Template
3. Configure Template Model
4. Configure "From" email address
5. Configure Recipient email address(es)
6. Optional- Configure CC email address(es)
7. Optional- Configure BCC email address(es)
8. Optional- Configure Tag
9. Optional- Configure "Reply To" email address
10. Optional- Configure Custom Headers
11. Optional- Configure Track Opens
12. Optional- Select a Track Links
13. Optional- Configure Attachments
14. Optional- Configure Metadata
15. Optional- Configure Message stream
16. Optional- Configure Inline CSS
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#

Send Email With Template on Postmark

Description:Send a single email with Postmark using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#email-with-template)

Version:0.0.4

Key:postmark-send-email-with-template

View on GitHub

Postmark Overview#

The Postmark API enables developers to easily integrate programmatic emailing into their applications. With the API, developers can create, send, and track transactional emails that are designed to enhance user experience and user engagement. The API also provides developers with access to powerful analytics and insights, such as open/click rates, spam complaints, bounces, and unsubscribes.

Action Code#

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

const {
  postmark, ...props
} = common.props;

export default {
  ...common,
  key: "postmark-send-email-with-template",
  name: "Send Email With Template",
  description: "Send a single email with Postmark using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#email-with-template)",
  version: "0.0.4",
  type: "action",
  props: {
    postmark,
    templateAlias: {
      type: "string",
      label: "Template",
      description: "The template to use for this email.",
      async options ({ page }) {
        const data = await this.postmark.listTemplates(page);
        const options = data.Templates?.map((obj) => {
          return {
            label: obj.Name,
            value: obj.Alias,
          };
        }) ?? [];

        return {
          options,
          context: {
            page,
          },
        };
      },
    },
    templateModel: {
      type: "object",
      label: "Template Model",
      description:
        "The model to be applied to the specified template to generate the email body and subject.",
    },
    ...props,
    inlineCss: {
      type: "boolean",
      label: "Inline CSS",
      description:
        "By default, if the specified template contains an HTMLBody, Postmark will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      ...this.getTemplateRequestData(),
      InlineCSS: this.inlineCss,
    };
    const response = await this.postmark.sendEmailWithTemplate({
      $,
      data,
    });
    $.export("$summary", "Sent email with template successfully");
    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
Postmark	`postmark`	`app`	This component uses the Postmark app.
Template	`templateAlias`	`string`	Select a value from the drop down menu.
Template Model	`templateModel`	`object`	The model to be applied to the specified template to generate the email body and subject.
"From" email address	`fromEmail`	`string`	The sender email address. Must have a registered and confirmed Sender Signature. To include a name, use the format 'Full Name <sender@domain.com>' for the address.
Recipient email address(es)	`toEmail`	`string`	Recipient email address. Multiple addresses are comma separated. Max 50.
CC email address(es)	`ccEmail`	`string`	Cc recipient email address. Multiple addresses are comma separated. Max 50.
BCC email address(es)	`bccEmail`	`string`	Bcc recipient email address. Multiple addresses are comma separated. Max 50.
Tag	`tag`	`string`	Email tag that allows you to categorize outgoing emails and get detailed statistics.
"Reply To" email address	`replyTo`	`string`	Reply To override email address. Defaults to the Reply To set in the sender signature.
Custom Headers	`customHeaders`	`string[]`	List of custom headers to include.
Track Opens	`trackOpens`	`boolean`	Activate open tracking for this email. Note: the email must have `HTML Body` to enable open tracking.
Track Links	`trackLinks`	`string`	Select a value from the drop down menu:`NoneHtmlAndTextHtmlOnlyTextOnly`
Attachments	`attachments`	`string[]`	Each attachment should be a string with the parameters separated by a pipe character `\|`, in the format: `Name\|Content\|ContentType`. Alternatively, you can pass a string representing an object. All three parameters are required: `Name` - the filename with extension, i.e. `readme.txt` `Content` - the base64-encoded string with the binary data for the file, i.e. `dGVzdCBjb250ZW50` `ContentType` - the MIME content type, i.e. `text/plain` Example with pipe-separated parameters: `readme.txt\|dGVzdCBjb250ZW50\|text/plain` Example with JSON-stringified object: `{"Name":"readme.txt","Content":"dGVzdCBjb250ZW50","ContentType":"text/plain"}`
Metadata	`metadata`	`object`	Custom metadata key/value pairs.
Message stream	`messageStream`	`string`	Set message stream ID that's used for sending. If not provided, message will default to the outbound transactional stream.
Inline CSS	`inlineCss`	`boolean`	By default, if the specified template contains an HTMLBody, Postmark will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.