Create Campaign with listmonk API on New Collection from MongoDB API

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

Trigger workflow on

New Collection from the MongoDB API

Next, do this

Create Campaign with the listmonk 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 listmonk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Collection trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
Configure the Create Campaign action
1. Connect your listmonk account
2. Configure Campaign Name
3. Configure Subject
4. Select one or more Lists
5. Select a Type
6. Select a Content Type
7. Configure Body
8. Optional- Configure From Email
9. Optional- Configure Tags
10. Optional- Configure Send At
11. Optional- Select a Template
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 Collection on MongoDB

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

Version:0.0.7

Key:mongodb-new-collection

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";

export default {
  ...common,
  key: "mongodb-new-collection",
  name: "New Collection",
  description: "Emit new an event when a new collection is added to a database",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getCollectionIds() {
      return this.db.get("collectionIds");
    },
    _setCollectionIds(collectionIds) {
      this.db.set("collectionIds", collectionIds);
    },
    isRelevant(uuid, collectionIds) {
      return !collectionIds.includes(uuid);
    },
    async processEvent(client, ts) {
      const collectionIds = this._getCollectionIds() || [];
      const collections = await this.mongodb.listCollections(client, this.database);
      for (const collection of collections) {
        const uuid = JSON.stringify(collection.info.uuid);
        if (!this.isRelevant(uuid, collectionIds)) {
          continue;
        }
        collectionIds.push(uuid);
        this.emitEvent(collection, ts);
      }
      this._setCollectionIds(collectionIds);
    },
    generateMeta({
      info, name,
    }, ts) {
      return {
        id: info.uuid,
        summary: name,
        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.

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#

Create Campaign on listmonk

Description:Creates a new campaign in Listmonk. [See the documentation](https://listmonk.app/docs/apis/campaigns/#post-apicampaigns)

Version:0.0.2

Key:listmonk-create-campaign

View on GitHub

listmonk Overview#

The listmonk API enables you to interact programmatically with the listmonk platform, which specializes in managing mailing lists and sending out newsletters. Using this API, you can automate subscriber management, campaign dispatching, and performance tracking. When you integrate listmonk with Pipedream, you can create powerful workflows that react to events from other apps, process data, and use that data to trigger actions within listmonk.

Action Code#

import listmonk from "../../listmonk.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "listmonk-create-campaign",
  name: "Create Campaign",
  description: "Creates a new campaign in Listmonk. [See the documentation](https://listmonk.app/docs/apis/campaigns/#post-apicampaigns)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    listmonk,
    name: {
      type: "string",
      label: "Campaign Name",
      description: "The name of the campaign to create.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the campaign.",
    },
    listIds: {
      propDefinition: [
        listmonk,
        "listIds",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the campaign.",
      options: constants.CAMPAIGN_TYPE_OPTIONS,
    },
    contentType: {
      type: "string",
      label: "Content Type",
      description: "The content type of the campaign.",
      options: constants.CONTENT_TYPE_OPTIONS,
    },
    body: {
      type: "string",
      label: "Body",
      description: "The body of the campaign.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "From e-mail to show on the campaign e-mails. If left empty, the default value from settings is used.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Array of string tags to mark the campaign.",
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "A timestamp to schedule the campaign at. Eg: 2021-12-25T06:00:00 (YYYY-MM-DDTHH:MM:SS)",
      optional: true,
    },
    templateId: {
      propDefinition: [
        listmonk,
        "templateId",
      ],
    },
  },
  async run({ $ }) {
    const { data } = await this.listmonk.createCampaign({
      data: {
        name: this.name,
        subject: this.subject,
        lists: this.listIds,
        from_email: this.fromEmail,
        type: this.type,
        content_type: this.contentType,
        body: this.body,
        tags: this.tags,
        send_at: this.sendAt,
        template_id: this.templateId,
      },
      $,
    });

    if (data?.id) {
      $.export("$summary", `Successfully created campaign with ID ${data.id}.`);
    }

    return data;
  },
};

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
listmonk	`listmonk`	`app`	This component uses the listmonk app.
Campaign Name	`name`	`string`	The name of the campaign to create.
Subject	`subject`	`string`	The subject of the campaign.
Lists	`listIds`	`string[]`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`regularoptin`
Content Type	`contentType`	`string`	Select a value from the drop down menu:`richtexthtmlmarkdownplain`
Body	`body`	`string`	The body of the campaign.
From Email	`fromEmail`	`string`	From e-mail to show on the campaign e-mails. If left empty, the default value from settings is used.
Tags	`tags`	`string[]`	Array of string tags to mark the campaign.
Send At	`sendAt`	`string`	A timestamp to schedule the campaign at. Eg: 2021-12-25T06:00:00 (YYYY-MM-DDTHH:MM:SS)
Template	`templateId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

Please enter your listmonk admin username and password below. For more info, refer to listmonk’s documentation

Pipedream recommends using a strong and unique password for your listmonk account.

Create Campaign with listmonk API on New Collection from MongoDB API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular