Find Document with MongoDB API on New Submission from ByteForms API

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

Trigger workflow on

New Submission from the ByteForms API

Next, do this

Find Document with the MongoDB 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 ByteForms trigger and MongoDB action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your ByteForms account
2. Configure timer
3. Select a Form ID
Configure the Find Document action
1. Connect your MongoDB account
2. Select a Database
3. Select a Collection
4. Configure Filter
5. Optional- Configure Options
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 Submission on ByteForms

Description:Emit new event when a user submission to a form occurs. [See the documentation](https://forms.bytesuite.io/docs/api#endpoints)

Version:0.0.1

Key:byteforms-new-submission

View on GitHub

Trigger Code#

import byteforms from "../../byteforms.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "byteforms-new-submission",
  name: "New Submission",
  description: "Emit new event when a user submission to a form occurs. [See the documentation](https://forms.bytesuite.io/docs/api#endpoints)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    byteforms,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    formId: {
      propDefinition: [
        byteforms,
        "formId",
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastCreated() {
      return this.db.get("lastCreated") || 0;
    },
    _setLastCreated(lastCreated) {
      this.db.set("lastCreated", lastCreated);
    },
    generateMeta(submission) {
      return {
        id: submission.id,
        summary: `New Form Submission: ${submission.id}`,
        ts: Date.parse(submission.created_at),
      };
    },
    async getSubmissions(max, lastCreated, params) {
      const submissions = [];
      do {
        const {
          cursor, data = [],
        } = await this.byteforms.listFormResponses({
          formId: this.formId,
          params,
        });
        if (!data?.length) {
          return submissions;
        }
        for (const item of data) {
          const ts = Date.parse(item.created_at);
          if (ts >= lastCreated) {
            submissions.push(item);
            if (max && submissions.length >= max) {
              return submissions;
            }
          } else {
            return submissions;
          }
        }
        params.after = cursor?.after;
      } while (params.after);
      return submissions;
    },
    async processEvent(max) {
      const lastCreated = this._getLastCreated();
      const params = {
        order: "desc",
      };
      const submissions = await this.getSubmissions(max, lastCreated, params);
      if (!submissions?.length) {
        return;
      }
      this._setLastCreated(Date.parse(submissions[0].created_at));
      submissions.forEach((submission) => {
        const meta = this.generateMeta(submission);
        this.$emit(submission, meta);
      });
    },
  },
  async run() {
    await this.processEvent();
  },
  sampleEmit,
};

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
ByteForms	`byteforms`	`app`	This component uses the ByteForms app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Form ID	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About ByteForms#

All-in-one solution for form creation, submission management, and data integration.

Action#

Find Document on MongoDB

Description:Finds a document by a query filter. [See the documentation](https://docs.mongodb.com/manual/reference/method/db.collection.find/)

Version:0.0.1

Key:mongodb-find-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.

Action Code#

import app from "../../mongodb.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "mongodb-find-document",
  name: "Find Document",
  description: "Finds a document by a query filter. [See the documentation](https://docs.mongodb.com/manual/reference/method/db.collection.find/)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    database: {
      propDefinition: [
        app,
        "database",
      ],
    },
    collectionName: {
      propDefinition: [
        app,
        "collection",
        ({ database }) => ({
          database,
        }),
      ],
    },
    filter: {
      type: "string",
      label: "Filter",
      description: "JSON string to use as a filter. Eg. `{ \"name\": \"Twitter\" }`",
    },
    options: {
      type: "string",
      label: "Options",
      description: "JSON string to use as options. Eg. `{ \"projection\": { \"_id\": 0, \"title\": 1 } }`",
      optional: true,
    },
  },
  methods: {
    async findDocument({
      database, collectionName, filter, options,
    } = {}) {
      const { app } = this;
      const client = await app.getClient();
      const collection = app.getCollection(client, database, collectionName);
      const result = await collection.findOne(filter, options);
      await client.close();
      return result;
    },
  },
  async run({ $ }) {
    const {
      findDocument,
      database,
      collectionName,
      filter,
      options,
    } = this;

    const response = await findDocument({
      database,
      collectionName,
      filter: utils.valueToObject(filter),
      options: utils.valueToObject(options),
    });

    if (!response) {
      $.export("$summary", "Document not found in the collection.");
      return;
    }

    $.export("$summary", "Successfully found a document in the collection.");
    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
MongoDB	`app`	`app`	This component uses the MongoDB app.
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collectionName`	`string`	Select a value from the drop down menu.
Filter	`filter`	`string`	JSON string to use as a filter. Eg. `{ "name": "Twitter" }`
Options	`options`	`string`	JSON string to use as options. Eg. `{ "projection": { "_id": 0, "title": 1 } }`

Action 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.

Find Document with MongoDB API on New Submission from ByteForms API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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