Send Email With Template with Postmark API on New Posts (Instant) from Discourse API

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

Trigger workflow on

New Posts (Instant) from the Discourse 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 Discourse 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 Posts (Instant) trigger
1. Connect your Discourse account
2. Select one or more Categories
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 Posts (Instant) on Discourse

Description:Emit new posts added to a topic in one of your chosen categories

Version:0.2.1

Key:discourse-new-posts-added

View on GitHub

Discourse Overview#

The Discourse API empowers developers to interact programmatically with Discourse forums, allowing for a myriad of automations and integrations. Using Pipedream, you can harness this API for tasks such as syncing forum data with other platforms, automating user management, or triggering workflows based on forum activity. The key is in creatively coupling Discourse events with Pipedream's capabilities to streamline community interactions and administration.

Trigger Code#

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

export default {
  name: "New Posts (Instant)",
  key: "discourse-new-posts-added",
  version: "0.2.1",
  type: "source",
  description: "Emit new posts added to a topic in one of your chosen categories",
  ...common,
  props: {
    ...common.props,
    categories: {
      propDefinition: [
        discourse,
        "categories",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      const latestPosts = await this.discourse.getLatestPosts(this.categories);
      for (const post of latestPosts) {
        this.$emit(post, this.generateMeta(post));
      }
    },
    async activate() {
      await this.activate({
        category_ids: this.categories,
        web_hook_event_type_ids: [
          "2",
        ], // https://github.com/discourse/discourse/blob/master/app/models/web_hook_event_type.rb#L5
      });
    },
  },
  methods: {
    ...common.methods,
    generateMeta(post) {
      const {
        id,
        raw,
        created_at: createdAt,
      } = post;
      const MAX_LENGTH = 40;
      return {
        id,
        summary:
          raw.length > MAX_LENGTH
            ? `${raw.slice(0, MAX_LENGTH)}...`
            : raw, // truncate long text
        ts: +new Date(createdAt),
      };
    },
  },
  async run(event) {
    this.validateEventAndEmit(event, "post_created", "post");
  },
};

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
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Discourse	`discourse`	`app`	This component uses the Discourse app.
Categories	`categories`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

For domain, enter the hostname, without the protocol, that you'd use in this API call: https://[domain]/admin/users/list/active.json. For example: example.com.

If you host Discourse on a subfolder (for example: https://pipedream.com/community), enter the subfolder as a part of the domain (pipedream.com/community).

Create an API key in your Admin panel, and enter the associated api_username and api_key.

About Discourse#

Conversation platform

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.