Create Email Template with Amazon SES API on New Subscriber Added from Mailwizz API

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

Trigger workflow on

New Subscriber Added from the Mailwizz 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 Mailwizz 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 Subscriber Added trigger
1. Connect your Mailwizz account
2. Configure Polling interval
3. Select a List UID
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 Subscriber Added on Mailwizz

Description:Emit new event when a new subscriber is created.

Version:0.0.1

Key:mailwizz-subscriber-added

View on GitHub

Mailwizz Overview#

Mailwizz offers a potent API that enables automation of email marketing tasks, subscriber management, campaign tracking, and more. Using Pipedream, you can harness this API to create custom workflows that trigger on specific events, process data, or synchronize with other apps. Pipedream's serverless architecture allows you to handle workflows at scale without managing infrastructure.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import mailwizz from "../../mailwizz.app.mjs";

export default {
  key: "mailwizz-subscriber-added",
  name: "New Subscriber Added",
  description: "Emit new event when a new subscriber is created.",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    mailwizz,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Mailwizz on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    listId: {
      propDefinition: [
        mailwizz,
        "listId",
      ],
      description: "The list uid.",
    },
  },
  methods: {
    _getLastDate () {
      return this.db.get( "lastDate" ) || 0;
    },
    _setLastDate ( lastDate ) {
      this.db.set( "lastDate", lastDate );
    },
    async startEvent ( maxResults ) {
      const lastDate = this._getLastDate();
      const responseArray = [];
      let tempLastDate = lastDate;

      const items = this.mailwizz.paginate( {
        fn: this.mailwizz.listSubscribers,
        args: {
          listId: this.listId,
        },
        maxResults,
      } );

      for await ( const item of items ) {
        const newLastDate = moment( item.date_added ).format( "YYYY-MM-DD HH:mm:ss" );

        if ( moment( newLastDate ).isAfter( lastDate ) ) {
          if ( moment( newLastDate ).isAfter( tempLastDate ) ) {
            tempLastDate = newLastDate;
          }
          responseArray.push( item );
        } else {
          break;
        }
      }

      if ( lastDate != tempLastDate )
        this._setLastDate( tempLastDate );

      for ( const responseItem of responseArray.reverse() ) {
        this.$emit(
          responseItem,
          {
            id: responseItem.subscriber_uid,
            summary: `A new subscriber with email "${responseItem.EMAIL}" was added!`,
            ts: responseItem.date_added,
          },
        );
      }
    },
  },
  hooks: {
    async deploy () {
      await this.startEvent( 25 );
    },
  },
  async run () {
    await this.startEvent();
  },
};

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
Mailwizz	`mailwizz`	`app`	This component uses the Mailwizz app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Mailwizz on this schedule
List UID	`listId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API Key,

Navigate to your Mailwizz account and sign in
Click the option with the Star icon in the left navigation menu
Go to “API Keys”

The URL field below is your Mailwizz host domain.

For example, if you have a Mailwizz instance hosted at https://example.com, then enter example.com in the url field below.

Please note that if the MailWizz hosted website doesn't have clean urls enabled, make sure your url has the index.php part of url included, i.e:
example.com/api/index.php

About Mailwizz#

Full-featured self-hosted email marketing software.

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.3

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.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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.