Send Event Data with Amplitude API on New Field in Document from MongoDB API

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

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

Send Event Data with the Amplitude 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 Amplitude 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 Send Event Data action
1. Connect your Amplitude account
2. Configure User ID
3. Configure Device ID
4. Configure Event Type
5. Optional- Configure Time
6. Optional- Configure Event Properties
7. Optional- Configure User Properties
8. Optional- Configure Groups
9. Optional- Configure Group Properties
10. Optional- Configure Skip User Properties Sync
11. Optional- Configure App Version
12. Optional- Configure Platform
13. Optional- Configure OS Name
14. Optional- Configure OS Version
15. Optional- Configure Device Brand
16. Optional- Configure Device Manufacturer
17. Optional- Configure Device Model
18. Optional- Configure Carrier
19. Optional- Configure Country
20. Optional- Configure Region
21. Optional- Configure City
22. Optional- Configure DMA
23. Optional- Configure Language
24. Optional- Configure Price
25. Optional- Configure Quantity
26. Optional- Configure Revenue
27. Optional- Configure Product ID
28. Optional- Configure Revenue Type
29. Optional- Configure Location Latitude
30. Optional- Configure Location Longitude
31. Optional- Configure IP
32. Optional- Configure IDFA
33. Optional- Configure IDFV
34. Optional- Configure ADID
35. Optional- Configure Android ID
36. Optional- Configure Event ID
37. Optional- Configure Session ID
38. Optional- Configure Insert ID
39. Optional- Configure Plan
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#

Send Event Data on Amplitude

Description:Sends user event data to Amplitude for analytics. [See the documentation](https://www.docs.developers.amplitude.com/analytics/apis/http-v2-api/#keys-for-the-event-argument)

Version:0.0.1

Key:amplitude-send-event-data

View on GitHub

Amplitude Overview#

The Amplitude API empowers you to sync and analyze product data within Amplitude's analytics platform. With Pipedream, you can automate interactions with the Amplitude API to create complex workflows. Send event and user data, query metrics, and automate cohort analysis, which can streamline your data science and product development processes. Integrating Amplitude with Pipedream allows you to connect this data to hundreds of other services for enhanced analytics, marketing automation, and personalized customer experiences.

Action Code#

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

export default {
  key: "amplitude-send-event-data",
  name: "Send Event Data",
  description: "Sends user event data to Amplitude for analytics. [See the documentation](https://www.docs.developers.amplitude.com/analytics/apis/http-v2-api/#keys-for-the-event-argument)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      type: "string",
      label: "User ID",
      description: "A unique identifier for a user.",
    },
    deviceId: {
      type: "string",
      label: "Device ID",
      description: "A unique identifier for a device.",
    },
    eventType: {
      type: "string",
      label: "Event Type",
      description: "The type of event being sent.",
    },
    time: {
      type: "integer",
      label: "Time",
      description: "The time the event occurred in milliseconds since epoch.",
      optional: true,
    },
    eventProperties: {
      type: "object",
      label: "Event Properties",
      description: "A dictionary of key-value pairs that represent additional data to be sent along with the event.",
      optional: true,
    },
    userProperties: {
      type: "object",
      label: "User Properties",
      description: "A dictionary of key-value pairs that represent additional data tied to the user.",
      optional: true,
    },
    groups: {
      type: "object",
      label: "Groups",
      description: "Dictionary of key-value pairs that represent groups to associate with the user.",
      optional: true,
    },
    groupProperties: {
      type: "object",
      label: "Group Properties",
      description: "Dictionary of key-value pairs that represent additional data tied to the groups.",
      optional: true,
    },
    skipUserPropertiesSync: {
      type: "boolean",
      label: "Skip User Properties Sync",
      description: "If true, user property operations in the same event are not applied to the user.",
      optional: true,
    },
    appVersion: {
      type: "string",
      label: "App Version",
      description: "The version of the application.",
      optional: true,
    },
    platform: {
      type: "string",
      label: "Platform",
      description: "The platform the user is on.",
      optional: true,
    },
    osName: {
      type: "string",
      label: "OS Name",
      description: "The name of the operating system the user is using.",
      optional: true,
    },
    osVersion: {
      type: "string",
      label: "OS Version",
      description: "The version of the operating system the user is using.",
      optional: true,
    },
    deviceBrand: {
      type: "string",
      label: "Device Brand",
      description: "The brand of the device the user is using.",
      optional: true,
    },
    deviceManufacturer: {
      type: "string",
      label: "Device Manufacturer",
      description: "The manufacturer of the device the user is using.",
      optional: true,
    },
    deviceModel: {
      type: "string",
      label: "Device Model",
      description: "The model of the device the user is using.",
      optional: true,
    },
    carrier: {
      type: "string",
      label: "Carrier",
      description: "The carrier the user is using.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country of the user.",
      optional: true,
    },
    region: {
      type: "string",
      label: "Region",
      description: "The region of the user.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city of the user.",
      optional: true,
    },
    dma: {
      type: "string",
      label: "DMA",
      description: "The designated market area of the user.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "The language set by the user.",
      optional: true,
    },
    price: {
      type: "string",
      label: "Price",
      description: "The price of the product.",
      optional: true,
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The quantity of the product.",
      optional: true,
    },
    revenue: {
      type: "string",
      label: "Revenue",
      description: "The revenue from the product.",
      optional: true,
    },
    productId: {
      type: "string",
      label: "Product ID",
      description: "The ID of the product.",
      optional: true,
    },
    revenueType: {
      type: "string",
      label: "Revenue Type",
      description: "The type of revenue.",
      optional: true,
    },
    locationLat: {
      type: "string",
      label: "Location Latitude",
      description: "The latitude of the user's location.",
      optional: true,
    },
    locationLng: {
      type: "string",
      label: "Location Longitude",
      description: "The longitude of the user's location.",
      optional: true,
    },
    ip: {
      type: "string",
      label: "IP",
      description: "The IP address of the user.",
      optional: true,
    },
    idfa: {
      type: "string",
      label: "IDFA",
      description: "Identifier for Advertisers.",
      optional: true,
    },
    idfv: {
      type: "string",
      label: "IDFV",
      description: "Identifier for Vendors.",
      optional: true,
    },
    adid: {
      type: "string",
      label: "ADID",
      description: "Google Play Advertising ID.",
      optional: true,
    },
    androidId: {
      type: "string",
      label: "Android ID",
      description: "Android ID.",
      optional: true,
    },
    eventId: {
      type: "integer",
      label: "Event ID",
      description: "A unique identifier for the event.",
      optional: true,
    },
    sessionId: {
      type: "integer",
      label: "Session ID",
      description: "A unique identifier for the session.",
      optional: true,
    },
    insertId: {
      type: "string",
      label: "Insert ID",
      description: "A unique identifier for the event that is used for deduplication.",
      optional: true,
    },
    plan: {
      type: "object",
      label: "Plan",
      description: "Dictionary of key-value pairs that represent the plan.",
      optional: true,
      default: {
        branch: "",
        source: "",
        version: "",
      },
    },
  },
  async run({ $ }) {
    const eventData = {
      user_id: this.userId,
      device_id: this.deviceId,
      event_type: this.eventType,
      time: this.time,
      event_properties: this.eventProperties,
      user_properties: this.userProperties,
      groups: this.groups,
      group_properties: this.groupProperties,
      $skip_user_properties_sync: this.skipUserPropertiesSync,
      app_version: this.appVersion,
      platform: this.platform,
      os_name: this.osName,
      os_version: this.osVersion,
      device_brand: this.deviceBrand,
      device_manufacturer: this.deviceManufacturer,
      device_model: this.deviceModel,
      carrier: this.carrier,
      country: this.country,
      region: this.region,
      city: this.city,
      dma: this.dma,
      language: this.language,
      price: this.price,
      quantity: this.quantity,
      revenue: this.revenue,
      productId: this.productId,
      revenueType: this.revenueType,
      location_lat: this.locationLat,
      location_lng: this.locationLng,
      ip: this.ip,
      idfa: this.idfa,
      idfv: this.idfv,
      adid: this.adid,
      android_id: this.androidId,
      event_id: this.eventId,
      session_id: this.sessionId,
      insert_id: this.insertId,
      plan: this.plan,
    };

    const response = await this.app.sendEventData({
      $,
      data: {
        events: [
          eventData,
        ],
      },
    });

    $.export("$summary", "Successfully sent new event data");
    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
Amplitude	`app`	`app`	This component uses the Amplitude app.
User ID	`userId`	`string`	A unique identifier for a user.
Device ID	`deviceId`	`string`	A unique identifier for a device.
Event Type	`eventType`	`string`	The type of event being sent.
Time	`time`	`integer`	The time the event occurred in milliseconds since epoch.
Event Properties	`eventProperties`	`object`	A dictionary of key-value pairs that represent additional data to be sent along with the event.
User Properties	`userProperties`	`object`	A dictionary of key-value pairs that represent additional data tied to the user.
Groups	`groups`	`object`	Dictionary of key-value pairs that represent groups to associate with the user.
Group Properties	`groupProperties`	`object`	Dictionary of key-value pairs that represent additional data tied to the groups.
Skip User Properties Sync	`skipUserPropertiesSync`	`boolean`	If true, user property operations in the same event are not applied to the user.
App Version	`appVersion`	`string`	The version of the application.
Platform	`platform`	`string`	The platform the user is on.
OS Name	`osName`	`string`	The name of the operating system the user is using.
OS Version	`osVersion`	`string`	The version of the operating system the user is using.
Device Brand	`deviceBrand`	`string`	The brand of the device the user is using.
Device Manufacturer	`deviceManufacturer`	`string`	The manufacturer of the device the user is using.
Device Model	`deviceModel`	`string`	The model of the device the user is using.
Carrier	`carrier`	`string`	The carrier the user is using.
Country	`country`	`string`	The country of the user.
Region	`region`	`string`	The region of the user.
City	`city`	`string`	The city of the user.
DMA	`dma`	`string`	The designated market area of the user.
Language	`language`	`string`	The language set by the user.
Price	`price`	`string`	The price of the product.
Quantity	`quantity`	`integer`	The quantity of the product.
Revenue	`revenue`	`string`	The revenue from the product.
Product ID	`productId`	`string`	The ID of the product.
Revenue Type	`revenueType`	`string`	The type of revenue.
Location Latitude	`locationLat`	`string`	The latitude of the user's location.
Location Longitude	`locationLng`	`string`	The longitude of the user's location.
IP	`ip`	`string`	The IP address of the user.
IDFA	`idfa`	`string`	Identifier for Advertisers.
IDFV	`idfv`	`string`	Identifier for Vendors.
ADID	`adid`	`string`	Google Play Advertising ID.
Android ID	`androidId`	`string`	Android ID.
Event ID	`eventId`	`integer`	A unique identifier for the event.
Session ID	`sessionId`	`integer`	A unique identifier for the session.
Insert ID	`insertId`	`string`	A unique identifier for the event that is used for deduplication.
Plan	`plan`	`object`	Dictionary of key-value pairs that represent the plan.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Amplitude account and sign in
In the Amplitude Analytics web app, click Settings in the lower left navigation.
Click Projects, then find your target project.
On the General tab, copy your API key and secret key.

Please select your region; for EU data residency, the project must be set up inside Amplitude EU.