Add Customers to Segment with Customer.io API on New Field in Document from MongoDB API

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

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

Add Customers to Segment with the Customer.io 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 Customer.io action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Add Customers to Segment action
1. Connect your Customer.io account
2. Configure Customer ID
3. Configure Segment ID
4. Optional- Select a Id Type
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 Field in Document on MongoDB

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

Version:0.0.7

Key:mongodb-new-field-in-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-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        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.
Document	`document`	`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#

Add Customers to Segment on Customer.io

Description:Add people to a manual segment by ID. You are limited to 1000 customer IDs per request. [See the docs here](https://www.customer.io/docs/api/#operation/add_to_segment)

Version:0.0.1

Key:customer_io-add-customers-to-segment

View on GitHub

Customer.io Overview#

Customer.io is a versatile automation tool that allows you to harness the power of email, SMS, and push notifications to create personalized customer experiences. With its comprehensive API, Customer.io enables you to track customer interactions, segment audiences, and trigger targeted communications based on user behavior and data. By leveraging Pipedream, you can easily connect Customer.io to various other services and APIs to automate complex workflows, synthesize data, and respond to events in real-time.

Action Code#

import app from "../../customer_io.app.mjs";
import options from "../../common/options.mjs";

export default {
  key: "customer_io-add-customers-to-segment",
  name: "Add Customers to Segment",
  description: "Add people to a manual segment by ID. You are limited to 1000 customer IDs per request. [See the docs here](https://www.customer.io/docs/api/#operation/add_to_segment)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    customerIds: {
      propDefinition: [
        app,
        "customerId",
      ],
      type: "string[]",
      description: "The customer IDs you want to add to the segment.",
    },
    segmentId: {
      type: "string",
      label: "Segment ID",
      description: "The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage.",
    },
    idType: {
      label: "Id Type",
      type: "string",
      description: "The type of ids you want to use. All of the values in the `ids` array must be of this type. If you don't provide this parameter, we assume that the `ids` array contains `id` values.",
      options: options.ID_TYPES,
      optional: true,
    },
  },
  async run({ $ }) {
    await this.app.addCustomersToSegment(
      this.segmentId,
      this.customerIds,
      this.idType,
      $,
    );
    $.export("$summary", "Successfully added customers to segment");
  },
};

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
Customer.io	`app`	`app`	This component uses the Customer.io app.
Customer ID	`customerIds`	`string[]`	The customer IDs you want to add to the segment.
Segment ID	`segmentId`	`string`	The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to Segments, select your segment, and find the ID under Usage.
Id Type	`idType`	`string`	Select a value from the drop down menu:`idemailcio_id`