Create Email Template with Amazon SES API on New Conversation Created (Instant) from Help Scout API

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

Trigger workflow on

New Conversation Created (Instant) from the Help Scout 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 Help Scout 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 Conversation Created (Instant) trigger
1. Connect your Help Scout account
2. Optional- Configure Label
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 Conversation Created (Instant) on Help Scout

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

Version:0.0.1

Key:help_scout-new-conversation-created-instant

View on GitHub

Help Scout Overview#

The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "help_scout-new-conversation-created-instant",
  name: "New Conversation Created (Instant)",
  description: "Emit new event when a new conversation is created.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventType() {
      return [
        "convo.created",
      ];
    },
    getSummary(body) {
      return `New conversation created: ${body.subject}`;
    },
  },
  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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
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.
Label	`label`	`string`	Label associated with this WebHook for better clarity.

Trigger Authentication#

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

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

About Help Scout#

Simple Customer Service Software and Education

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.