Add Subscriber with ReferralHero API on New Document from MongoDB API

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

Trigger workflow on

New Document from the MongoDB API

Next, do this

Add Subscriber with the ReferralHero API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MongoDB trigger and ReferralHero 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 Subscriber action
1. Connect your ReferralHero account
2. Select a List
3. Configure Email
4. Configure Domain
5. Optional- Configure Name
6. Optional- Configure Double Opt-in
7. Optional- Configure Source
8. Optional- Configure Referrer
9. Optional- Configure Conversion Value
10. Optional- Configure Pending
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.8

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

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.8",
  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];
      }
    },
    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 documents = await collection.find().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 Subscriber on ReferralHero

Description:Adds a new subscriber to to a list. [See the documentation](https://support.referralhero.com/integrate/rest-api/endpoints-reference#add-a-subscriber)

Version:0.0.1

Key:referralhero-add-subscriber

View on GitHub

ReferralHero Overview#

The ReferralHero API allows you to build custom referral marketing campaigns, manage participants, and track referral performance directly from Pipedream. You can automate participant registration, reward distribution, and integrate with other services for enhanced functionality like email marketing, CRM updates, or analytics. By leveraging Pipedream’s serverless platform, you can create workflows that react to events in ReferralHero, enrich referral data, or synchronize it with other apps.

Action Code#

import referralhero from "../../referralhero.app.mjs";

export default {
  key: "referralhero-add-subscriber",
  name: "Add Subscriber",
  description: "Adds a new subscriber to to a list. [See the documentation](https://support.referralhero.com/integrate/rest-api/endpoints-reference#add-a-subscriber)",
  version: "0.0.1",
  type: "action",
  props: {
    referralhero,
    listId: {
      propDefinition: [
        referralhero,
        "listId",
      ],
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the subscriber",
    },
    domain: {
      type: "string",
      label: "Domain",
      description: "The URL for the referral link",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the subscriber",
      optional: true,
    },
    doubleOptin: {
      type: "boolean",
      label: "Double Opt-in",
      description: "If set to `false`, the subscriber will not receive a confirmation email",
      default: true,
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "The source of the subscriber. Used for analytics.",
      optional: true,
    },
    referrer: {
      type: "boolean",
      label: "Referrer",
      description: "Set a referrer for the subscriber by providing the referrer's referral code or email",
      optional: true,
    },
    conversionValue: {
      type: "string",
      label: "Conversion Value",
      description: "The monetary value of the referral",
      optional: true,
    },
    pending: {
      type: "boolean",
      label: "Pending",
      description: "Set to `true` to set the referral status to pending",
      default: false,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.referralhero.addSubscriber({
      listId: this.listId,
      params: {
        email: this.email,
        name: this.name,
        double_optin: this.doubleOptin,
        source: this.source,
        referrer: this.referrer,
        domain: this.domain,
        conversion_value: this.conversionValue,
        status: this.pending
          ? "custom_event_pending"
          : undefined,
      },
      $,
    });

    if (response?.status === "error") {
      throw new Error(response.message);
    }

    if (response?.data?.id) {
      $.export("$summary", `Successfully added subscriber with ID ${response.data.id}.`);
    }

    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
ReferralHero	`referralhero`	`app`	This component uses the ReferralHero app.
List	`listId`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	Email address of the subscriber
Domain	`domain`	`string`	The URL for the referral link
Name	`name`	`string`	Name of the subscriber
Double Opt-in	`doubleOptin`	`boolean`	If set to `false`, the subscriber will not receive a confirmation email
Source	`source`	`string`	The source of the subscriber. Used for analytics.
Referrer	`referrer`	`boolean`	Set a referrer for the subscriber by providing the referrer's referral code or email
Conversion Value	`conversionValue`	`string`	The monetary value of the referral
Pending	`pending`	`boolean`	Set to `true` to set the referral status to pending

Add Subscriber with ReferralHero API on New Document from MongoDB API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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