Send Email with Amazon SES API on New Document in Firestore Collection from Firebase Admin SDK API

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

Trigger workflow on

New Document in Firestore Collection from the Firebase Admin SDK API

Next, do this

Send Email 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 Firebase Admin SDK 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 Document in Firestore Collection trigger
1. Connect your Firebase Admin SDK account
2. Configure Polling Interval
3. Optional- Select a Database Region
4. Configure Structured Query
Configure the Send Email action
1. Connect your Amazon SES account
2. Select a AWS Region
3. Configure To Addresses
4. Optional- Configure CC Addresses
5. Optional- Configure BCC Addresses
6. Optional- Configure Reply To Addresses
7. Configure Subject
8. Configure Text
9. Optional- Configure HTML
10. Configure From
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 Document in Firestore Collection on Firebase Admin SDK

Description:Emit new event when a structured query returns new documents

Version:0.0.6

Key:firebase_admin_sdk-new-doc-in-firestore-collection

View on GitHub

Firebase Admin SDK Overview#

The Firebase Admin SDK API provides powerful backend functionality for Firebase apps. It allows you to interact with Firebase services like Firestore, Firebase Realtime Database, Firebase Storage, and Firebase Authentication directly from a server. With Pipedream, you can harness this API to automate complex workflows, respond to Firebase events in real-time, and integrate with countless other services.

Trigger Code#

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

export default {
  ...common,
  key: "firebase_admin_sdk-new-doc-in-firestore-collection",
  name: "New Document in Firestore Collection",
  description: "Emit new event when a structured query returns new documents",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    query: {
      propDefinition: [
        common.props.firebase,
        "query",
      ],
    },
  },
  methods: {
    ...common.methods,
    async processEvent() {
      const structuredQuery = JSON.parse(this.query);

      const queryResults = await this.firebase.runQuery(structuredQuery);

      for (const result of queryResults) {
        const meta = this.generateMeta(result);
        this.$emit(result, meta);
      }
    },
    generateMeta({ document }) {
      const {
        name,
        createTime,
      } = document;
      const id = name.substring(name.lastIndexOf("/") + 1);
      return {
        id,
        summary: name,
        ts: Date.parse(createTime),
      };
    },
  },
};

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
Firebase Admin SDK	`firebase`	`app`	This component uses the Firebase Admin SDK app.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database Region	`databaseRegion`	`string`	Select a value from the drop down menu:`{ "label": "us-central1", "value": "firebaseio.com" }{ "label": "europe-west1", "value": "europe-west1.firebasedatabase.app" }{ "label": "asia-southeast1", "value": "asia-southeast1.firebasedatabase.app" }`
Structured Query	`query`	`string`	Enter a structured query that returns new records from your target collection. Example: `{ "select": { "fields": [] }, "from": [ { "collectionId": "<YOUR COLLECTION>", "allDescendants": "true" } ] }`

Trigger Authentication#

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

Enable the Cloud Firestore API on your Firebase account, and make sure you've created at least one collection in the database.
Follow these instructions to generate a private key tied to your Firebase service account. This will generate a JSON file that contains the project ID, private key, and client email that you should paste below.
When entering the private key, please add the full string included in the JSON file, from -----BEGIN PRIVATE KEY----- to -----END PRIVATE KEY-----, with all newline characters included.

About Firebase Admin SDK#

Firebase is Google's mobile platform that helps you quickly develop high-quality apps and grow your business.

Action#

Send Email on Amazon SES

Description:Send an email using Amazon SES. Supports simple email messaging. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/sendemailcommand.html)

Version:0.9.0

Key:amazon_ses-send-email

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-send-email",
  name: "Send Email",
  description: "Send an email using Amazon SES. Supports simple email messaging. [See the docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sesv2/classes/sendemailcommand.html)",
  version: "0.9.0",
  type: "action",
  props: {
    ...base.props,
    ToAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "ToAddresses",
      ],
    },
    CcAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "CcAddresses",
      ],
    },
    BccAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "BccAddresses",
      ],
    },
    ReplyToAddresses: {
      propDefinition: [
        base.props.amazonSes,
        "ReplyToAddresses",
      ],
    },
    Subject: {
      propDefinition: [
        base.props.amazonSes,
        "Subject",
      ],
    },
    Text: {
      propDefinition: [
        base.props.amazonSes,
        "Text",
      ],
      default: "",
    },
    Html: {
      propDefinition: [
        base.props.amazonSes,
        "Html",
      ],
      optional: true,
    },
    FromEmailAddress: {
      propDefinition: [
        base.props.amazonSes,
        "FromEmailAddress",
      ],
    },
  },
  async run({ $ }) {
    if (!(this.Text || this.Html)) {
      throw new ConfigurationError("Email Text or HTML must be supplied");
    }

    const params = {
      Content: {
        Simple: {
          Subject: this.amazonSes.createCharsetContent(this.Subject),
          Body: {
            Text: this.amazonSes.createCharsetContent(this.Text),
          },
        },
      },
      Destination: {
        ToAddresses: this.ToAddresses,
        CcAddresses: this.CcAddresses,
        BccAddresses: this.BccAddresses,
      },
      FromEmailAddress: this.FromEmailAddress,
      ReplyToAddresses: this.ReplyToAddresses,
    };

    if (this.Html) {
      params.Content.Simple.Body.Html = this.amazonSes.createCharsetContent(this.Html);
    }

    const response = await this.amazonSes.sendEmail(this.region, params);
    $.export("$summary", "Sent email 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
Amazon SES	`amazonSes`	`app`	This component uses the Amazon SES app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
To Addresses	`ToAddresses`	`string[]`	An array of recipient email addresses you want to send to
CC Addresses	`CcAddresses`	`string[]`	An array of email addresses you want to CC
BCC Addresses	`BccAddresses`	`string[]`	An array of email addresses you want to BCC
Reply To Addresses	`ReplyToAddresses`	`string[]`	An array of reply-to addresses
Subject	`Subject`	`string`	The email subject line. 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\}\}`.
HTML	`Html`	`string`	The HTML email body. Use `\{\{` and `\}\}` to insert tags. Example: `This is a \{\{tagname\}\}`.
From	`FromEmailAddress`	`string`	The email from which the email is addressed

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.