Add Email with SARE API on New Document from MongoDB API

Pipedream makes it easy to connect APIs for SARE, MongoDB and 2,400+ other apps remarkably fast.

Trigger workflow on

New Document from the MongoDB API

Next, do this

Add Email with the SARE 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 MongoDB trigger and SARE 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 trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Configure Timestamp Field
Configure the Add Email action
1. Connect your SARE account
2. Configure Email
3. Optional- Configure GSM
4. Optional- Select one or more Groups
5. Optional- Configure Name
6. Optional- Configure Comment
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 on MongoDB

Description:Emit new an event when a new document is added to a collection

Version:0.0.9

Key:mongodb-new-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";
import { Timestamp } from "mongodb";

export default {
  ...common,
  key: "mongodb-new-document",
  name: "New Document",
  description: "Emit new an event when a new document is added to a collection",
  version: "0.0.9",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    timestampField: {
      type: "string",
      label: "Timestamp Field",
      description: "The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.mongodb.getClient();
      await this.processEvent(client, Date.now(), 25);
      await client.close();
    },
  },
  methods: {
    ...common.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    getTs(doc) {
      try {
        return JSON.parse(doc[this.timestampField]);
      } catch {
        return doc[this.timestampField];
      }
    },
    convertToTimestamp(timestampStr) {
      const bigIntValue = BigInt(timestampStr);
      const seconds = Number(bigIntValue >> 32n);
      const increment = Number(bigIntValue & 0xFFFFFFFFn);
      return new Timestamp({
        t: seconds,
        i: increment,
      });
    },
    async processEvent(client, eventTs, max) {
      const lastTs = this._getLastTs() || 0;
      let maxTs = lastTs;
      let count = 0;
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const sort = {
        [this.timestampField]: -1,
      };
      const query = {
        [this.timestampField]: {
          $gt: this.convertToTimestamp(lastTs),
        },
      };
      const documents = await collection.find(query).sort(sort)
        .toArray();
      const docs = [];
      for (const doc of documents) {
        const ts = this.getTs(doc);
        if (!(ts > lastTs) || (max && count >= max)) {
          break;
        }
        if (ts > maxTs) {
          maxTs = ts;
        }
        docs.push(doc);
        count++;
      }
      docs.reverse().forEach((doc) => this.emitEvent(doc, eventTs));
      this._setLastTs(maxTs);
    },
    generateMeta({ _id: id }, ts) {
      return {
        id,
        summary: `New Document ID ${JSON.stringify(id)}`,
        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
MongoDB	`mongodb`	`app`	This component uses the MongoDB 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 API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Timestamp Field	`timestampField`	`string`	The key of a timestamp field, such as 'created_at' that is set to the current timestamp when a document is created. Must be of type Timestamp.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Add Email on SARE

Description:Add an email to SARE. Optionally, assign the subscriber to a group. [See the documentation](https://dev.sare.pl/rest-api/other/index.html#post-/email/add)

Version:0.0.1

Key:sare-add-email

View on GitHub

SARE Overview#

The SARE API provides robust tools for email marketing and automation, enabling users to manage subscribers, send emails, and analyze campaigns directly via API. By leveraging SARE's features on Pipedream, you can automate workflows involving email operations, integrate with other platforms for enhanced data handling and customer engagement, and streamline communications in various marketing campaigns. This integration can particularly benefit marketers looking to automate responses based on subscriber behavior or integrate email marketing metrics with other business tools.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import sare from "../../sare.app.mjs";

export default {
  key: "sare-add-email",
  name: "Add Email",
  description: "Add an email to SARE. Optionally, assign the subscriber to a group. [See the documentation](https://dev.sare.pl/rest-api/other/index.html#post-/email/add)",
  version: "0.0.1",
  type: "action",
  props: {
    sare,
    email: {
      propDefinition: [
        sare,
        "email",
      ],
    },
    gsm: {
      propDefinition: [
        sare,
        "gsm",
      ],
    },
    groups: {
      propDefinition: [
        sare,
        "groups",
      ],
      description: "The group to assign the email to.",
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name assigned to the email address.",
      optional: true,
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "Address comment.",
      optional: true,
    },
  },
  async run({ $ }) {
    const { response } = await this.sare.addEmail({
      $,
      data: {
        emails: [
          {
            email: this.email,
            gsm: this.gsm,
            groups: this.groups && parseObject(this.groups),
            name: this.name,
            comment: this.comment,
          },
        ],
      },
    });

    if (response.error?.length) {
      throw new ConfigurationError(response.error[0].why);
    }

    $.export("$summary", `Successfully added email: ${this.email}`);
    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
SARE	`sare`	`app`	This component uses the SARE app.
Email	`email`	`string`	The email address of the subscriber.
GSM	`gsm`	`string`	The GSM number of the subscriber.
Groups	`groups`	`string[]`	Select a value from the drop down menu.
Name	`name`	`string`	The name assigned to the email address.
Comment	`comment`	`string`	Address comment.