Send Batch With Templates with Postmark API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send Batch With Templates 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#

Create a workflow to Send Batch With Templates with the Postmark API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Send Batch With Templates action
1. Connect your Postmark account
2. Optional- Configure Messages
3. Optional- Configure Amount of emails
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Batch With Templates with Postmark API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Postmark

Try it

Send Batch With Templates with Postmark API on New Submission from Typeform API

Typeform + Postmark

Try it

Send Batch With Templates with Postmark API on Custom Events from Zoom API

Zoom + Postmark

Try it

Send Batch With Templates with Postmark API on New Submission (Instant) from Jotform API

Jotform + Postmark

Try it

Send Batch With Templates with Postmark API on New Scheduled Tasks from Pipedream API

Pipedream + Postmark

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Send Batch With Templates on Postmark

Description:Send a batch of emails using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#send-batch-with-templates)

Version:0.0.3

Key:postmark-send-batch-with-templates

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import postmark from "../../postmark.app.mjs";
import common from "../common/common.mjs";
import props from "../common/props.mjs";
import templateProps from "../common/templateProps.mjs";

export default {
  ...common,
  key: "postmark-send-batch-with-templates",
  name: "Send Batch With Templates",
  description: "Send a batch of emails using a template [See the documentation](https://postmarkapp.com/developer/api/templates-api#send-batch-with-templates)",
  version: "0.0.3",
  type: "action",
  props: {
    postmark,
    messages: {
      type: "string[]",
      label: "Messages",
      description: `You can specify the JSON-stringified email objects here directly. Example value:
\`\`\`
{
  "From": "sender@example.com",
  "To": "receiver2@example.com",
  "TemplateAlias": "welcome-notification",
  "TemplateModel": {
      "fizz": "buzz"
  }
}
\`\`\``,
      optional: true,
    },
    amountOfEmails: {
      type: "integer",
      label: "Amount of emails",
      description: "The amount of emails to send in the batch. Use this to build the email objects instead of using the `Messages` prop.",
      min: 1,
      max: 20,
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const allProps = {
      ...templateProps,
      ...props,
    };
    const amount = this.amountOfEmails ?? 0;
    const arr = [];
    for (let i = 1; i <= amount; i++) {
      arr.push(i);
    }
    return Object.fromEntries(arr.flatMap((i) => Object.entries(allProps).map(([
      key,
      value,
    ]) => [
      `${i}_${key}`,
      {
        ...value,
        label: `Email #${i} - ${value.label}`,
      },
    ])));
  },
  async run({ $ }) {
    let {
      amountOfEmails, messages,
    } = this;
    if (!amountOfEmails && !messages?.length) {
      throw new ConfigurationError("You must either specify the `Messages` object or use `Amount of Emails` to build the objects.");
    }
    const useMessages = messages?.length;
    const data = {
      Messages: useMessages || [],
    };
    if (useMessages) {
      try {
        data.Messages = typeof messages === "string"
          ? JSON.parse(messages)
          : messages.map(JSON.parse);
      } catch (err) {
        throw new ConfigurationError("Error when parsing `Messages` as JSON. Make sure all items are a valid JSON-stringified object.");
      }
    }

    else {
      for (let i = 1; i <= amountOfEmails; i++) {
        data.Messages.push(Object.fromEntries(Object.entries({
          From: this[`${i}_fromEmail`],
          To: this[`${i}_toEmail`],
          Cc: this[`${i}_ccEmail`],
          Bcc: this[`${i}_bccEmail`],
          Tag: this[`${i}_tag`],
          ReplyTo: this[`${i}_replyTo`],
          Headers: this[`${i}_customHeaders`],
          TrackOpens: this[`${i}_trackOpens`],
          TrackLinks: this[`${i}_trackLinks`],
          Attachments: this.getAttachmentData(this[`${i}_attachments`]),
          Metadata: this[`${i}_metadata`],
          MessageStream: this[`${i}_messageStream`],
          TemplateAlias: this[`${i}_templateAlias`],
          TemplateModel: this[`${i}_templateModel`],
        }).filter(([
          , value,
        ]) => value !== undefined)));
      }
    }

    const response = await this.postmark.sendBatchWithTemplate({
      $,
      data,
    });
    $.export("$summary", `Sent batch of ${data.Messages.length} emails successfully`);
    return response;
  },
};

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
Postmark	`postmark`	`app`	This component uses the Postmark app.
Messages	`messages`	`string[]`	You can specify the JSON-stringified email objects here directly. Example value: `{ "From": "sender@example.com", "To": "receiver2@example.com", "TemplateAlias": "welcome-notification", "TemplateModel": { "fizz": "buzz" } }`
Amount of emails	`amountOfEmails`	`integer`	The amount of emails to send in the batch. Use this to build the email objects instead of using the `Messages` prop.