Create Email Template with Amazon SES API on New Message Sent in Channel (Instant) from Mattermost API

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

Trigger workflow on

New Message Sent in Channel (Instant) from the Mattermost API

Next, do this

Create Email Template with the Amazon SES 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 Mattermost trigger and Amazon SES 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 Sent in Channel (Instant) trigger
1. Connect your Mattermost account
2. Select a Team
3. Select a Channel
4. Optional- Configure Display Name
5. Configure Trigger Words
6. Optional- Select a Trigger When
Configure the Create Email Template action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Configure Template Name
4. Configure Subject
5. Optional- Configure HTML
6. Optional- Configure Text
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 Sent in Channel (Instant) on Mattermost

Description:Emit new event when a message matching the requirements is sent in a channel. [See the documentation](https://api.mattermost.com/#tag/webhooks/operation/CreateOutgoingWebhook)

Version:0.0.2

Key:mattermost-new-message-sent-in-channel

View on GitHub

Mattermost Overview#

Mattermost is an open-source platform for secure collaboration across the entire software development lifecycle. With the Mattermost API on Pipedream, you can automate common chat operations, integrate with DevOps tools for real-time alerts, orchestrate workflows based on chat events, and connect with other services to enhance team productivity. For instance, you could trigger actions on issue tracking platforms when discussing bugs or link project management tools to update task statuses directly from your Mattermost channels.

Trigger Code#

import mattermost from "../../app/mattermost.app.mjs";
import { defineSource, } from "@pipedream/types";
export default defineSource({
    name: "New Message Sent in Channel (Instant)",
    description: "Emit new event when a message matching the requirements is sent in a channel. [See the documentation](https://api.mattermost.com/#tag/webhooks/operation/CreateOutgoingWebhook)",
    key: "mattermost-new-message-sent-in-channel",
    version: "0.0.2",
    type: "source",
    dedupe: "unique",
    props: {
        mattermost,
        db: "$.service.db",
        http: "$.interface.http",
        teamId: {
            propDefinition: [
                mattermost,
                "teamId",
            ],
        },
        channelId: {
            propDefinition: [
                mattermost,
                "publicChannelId",
                ({ teamId }) => ({
                    teamId,
                }),
            ],
        },
        displayName: {
            type: "string",
            label: "Display Name",
            description: "The display name of the webhook in Mattermost",
            optional: true,
            default: "Pipedream source",
        },
        triggerWords: {
            type: "string[]",
            label: "Trigger Words",
            description: "List of words that will trigger an event",
        },
        triggerWhen: {
            type: "integer",
            label: "Trigger When",
            description: "When to trigger an event",
            optional: true,
            options: [
                {
                    label: "When a trigger word is present in the message",
                    value: 0,
                },
                {
                    label: "If the message starts with a trigger word",
                    value: 1,
                },
            ],
        },
    },
    methods: {
        _getWebhookId() {
            return this.db.get("webhookId");
        },
        _setWebhookId(value) {
            this.db.set("webhookId", value);
        },
    },
    hooks: {
        async activate() {
            const data = {
                team_id: this.teamId,
                channel_id: this.channelId,
                display_name: this.displayName,
                description: `Pipedream - New Message Sent in Channel ${this.channelId}`,
                trigger_words: this.triggerWords,
                trigger_when: this.triggerWhen,
                callback_urls: [
                    this.http.endpoint,
                ],
                content_type: "application/json",
            };
            const { id } = await this.mattermost.createWebhook(data);
            this._setWebhookId(id);
        },
        async deactivate() {
            const id = this._getWebhookId();
            await this.mattermost.deleteWebhook(id);
        },
    },
    async run({ body }) {
        if (body) {
            const ts = Date.now();
            this.$emit(body, {
                id: typeof body.id === "string"
                    ? body.id
                    : ts,
                summary: "New message",
                ts,
            });
        }
    },
});

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
Mattermost	`mattermost`	`app`	This component uses the Mattermost app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Team	`teamId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.
Display Name	`displayName`	`string`	The display name of the webhook in Mattermost
Trigger Words	`triggerWords`	`string[]`	List of words that will trigger an event
Trigger When	`triggerWhen`	`integer`	Select a value from the drop down menu:`{ "label": "When a trigger word is present in the message", "value": 0 }{ "label": "If the message starts with a trigger word", "value": 1 }`

Trigger Authentication#

Mattermost uses OAuth authentication. When you connect your Mattermost account, Pipedream will open a popup window where you can sign into Mattermost and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Mattermost API.

Pipedream requests the following authorization scopes when you connect your account:

About Mattermost#

Open-source, self-hostable online chat service

Action#

Create Email Template on Amazon SES

Description:Create a HTML or a plain text email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/createemailtemplatecommand.html)

Version:0.0.1

Key:amazon_ses-create-email-template

View on GitHub

Amazon SES Overview#

Amazon Simple Email Service (SES) is a powerful cloud-based email sending service designed to help digital marketers and application developers send marketing, notification, and transactional emails. With the SES API, you can reliably send emails at scale, manage sender reputations, view email sending statistics, and maintain a high deliverability rate. Leveraging Pipedream's capabilities, you can integrate SES seamlessly into serverless workflows, automate email responses based on triggers from other apps, and analyze the effectiveness of your email campaigns by connecting to data analytics platforms.

Action Code#

import base from "../common/base.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "amazon_ses-create-email-template",
  name: "Create Email Template",
  description: "Create a HTML or a plain text email template. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/createemailtemplatecommand.html)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    TemplateName: {
      type: "string",
      label: "Template Name",
      description: "The email template name",
    },
    Subject: {
      propDefinition: [
        base.props.amazonSes,
        "Subject",
      ],
    },
    Html: {
      propDefinition: [
        base.props.amazonSes,
        "Html",
      ],
      optional: true,
    },
    Text: {
      propDefinition: [
        base.props.amazonSes,
        "Text",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.Html && !this.Text) {
      throw new ConfigurationError("Html or Text must be configured");
    }

    const params = {
      TemplateName: this.TemplateName,
      TemplateContent: {
        Subject: this.amazonSes.replaceCurlyBrackets(this.Subject),
        Html: this.amazonSes.replaceCurlyBrackets(this.Html),
        Text: this.amazonSes.replaceCurlyBrackets(this.Text),
      },
    };
    const response = await this.amazonSes.createEmailTemplate(this.region, params);
    $.export("$summary", "Successfully created email template");
    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
Amazon SES	`amazonSes`	`app`	This component uses the Amazon SES app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Template Name	`TemplateName`	`string`	The email template name
Subject	`Subject`	`string`	The email subject line. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
HTML	`Html`	`string`	The HTML email body. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
Text	`Text`	`string`	The email body that will be visible to recipients whose email clients do not display HTML. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.

Action Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key, with the minimum IAM permissions necessary to send email or hit the desired SES APIs from Pipedream.

Enter the access and secret key below.