Create and Run Task with Skyvern API on New Document from MongoDB API

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

Trigger workflow on

New Document from the MongoDB API

Next, do this

Create and Run Task with the Skyvern 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 Skyvern 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 Create and Run Task action
1. Connect your Skyvern account
2. Configure URL
3. Optional- Configure Navigation Goal
4. Optional- Configure Data Extraction Goal
5. Optional- Configure Navigation Payload
6. Optional- Configure Webhook Callback URL
7. Optional- Configure Extracted Information Schema
8. Optional- Configure TOTP Verification URL
9. Optional- Configure TOTP Identifier
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.9

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";
import { Timestamp } from "mongodb";

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.9",
  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];
      }
    },
    convertToTimestamp(timestampStr) {
      const bigIntValue = BigInt(timestampStr);
      const seconds = Number(bigIntValue >> 32n);
      const increment = Number(bigIntValue & 0xFFFFFFFFn);
      return new Timestamp({
        t: seconds,
        i: increment,
      });
    },
    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 query = {
        [this.timestampField]: {
          $gt: this.convertToTimestamp(lastTs),
        },
      };
      const documents = await collection.find(query).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#

Create and Run Task on Skyvern

Description:Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)

Version:0.0.1

Key:skyvern-create-run-task

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import skyvern from "../../skyvern.app.mjs";

export default {
  key: "skyvern-create-run-task",
  name: "Create and Run Task",
  description: "Create a new task and run it instantly in Skyvern. Useful for one-off automations. [See the documentation](https://docs.skyvern.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    skyvern,
    url: {
      type: "string",
      label: "URL",
      description: "It must be a http or https URL.",
    },
    navigationGoal: {
      type: "string",
      label: "Navigation Goal",
      description: "The prompt that tells the agent what the user-facing goal is. This is the guiding light for the LLM as it navigates a particular website / sitemap to achieve this specified goal.",
      optional: true,
    },
    dataExtractionGoal: {
      type: "string",
      label: "Data Extraction Goal",
      description: "The prompt that instructs the agent to extract information once the agent has achieved its **User Goal**.",
      optional: true,
    },
    navigationPayload: {
      type: "object",
      label: "Navigation Payload",
      description: "JSON-formatted payload with any \"facts\" or information that would help the agent perform its job. In the case of navigating an insurance quote, this payload would include any user information to help fill out the insurance flow such as date of birth, or age they got their license, and so on. This can include nested information, and the formatting isn't validated.",
      optional: true,
    },
    webhookCallbackUrl: {
      propDefinition: [
        skyvern,
        "webhookCallbackUrl",
      ],
      description: "The callback URL once our system is finished processing this async task.",
      optional: true,
    },
    extractedInformationSchema: {
      type: "object",
      label: "Extracted Information Schema",
      description: "Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to [https://json-schema.org/](https://json-schema.org/) definition.",
      optional: true,
    },
    totpVerificationUrl: {
      type: "string",
      label: "TOTP Verification URL",
      description: "The URL of your TOTP endpoint. If this field is provided, Skyvern will call the URL to fetch the TOTP/2FA/MFA code when needed.",
      optional: true,
    },
    totpIdentifier: {
      type: "string",
      label: "TOTP Identifier",
      description: "The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to [Skyvern's TOTP API](https://docs.skyvern.com/running-tasks/advanced-features#push-code-to-skyvern).",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.skyvern.createAndRunTask({
      $,
      data: {
        url: this.url,
        navigation_goal: this.navigationGoal,
        data_extraction_goal: this.dataExtractionGoal,
        navigation_payload: parseObject(this.navigationPayload),
        webhook_callback_url: this.webhookCallbackUrl,
        proxyLocation: "RESIDENTIAL",
        extracted_information_schema: parseObject(this.extractedInformationSchema),
        totp_verification_url: this.totpVerificationUrl,
        totp_identifier: this.totpIdentifier,
      },
    });
    $.export("$summary", `Created and ran task with ID ${response.task_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
Skyvern	`skyvern`	`app`	This component uses the Skyvern app.
URL	`url`	`string`	It must be a http or https URL.
Navigation Goal	`navigationGoal`	`string`	The prompt that tells the agent what the user-facing goal is. This is the guiding light for the LLM as it navigates a particular website / sitemap to achieve this specified goal.
Data Extraction Goal	`dataExtractionGoal`	`string`	The prompt that instructs the agent to extract information once the agent has achieved its User Goal.
Navigation Payload	`navigationPayload`	`object`	JSON-formatted payload with any "facts" or information that would help the agent perform its job. In the case of navigating an insurance quote, this payload would include any user information to help fill out the insurance flow such as date of birth, or age they got their license, and so on. This can include nested information, and the formatting isn't validated.
Webhook Callback URL	`webhookCallbackUrl`	`string`	The callback URL once our system is finished processing this async task.
Extracted Information Schema	`extractedInformationSchema`	`object`	Used to enforce a JSON schema spec to be enforced in the data_extraction_goal. Similar to https://json-schema.org/ definition.
TOTP Verification URL	`totpVerificationUrl`	`string`	The URL of your TOTP endpoint. If this field is provided, Skyvern will call the URL to fetch the TOTP/2FA/MFA code when needed.
TOTP Identifier	`totpIdentifier`	`string`	The email address or the phone number which receives the TOTP/2FA/MFA code. If this field is provided, Skyvern will fetch the code that is pushed to Skyvern's TOTP API.

Create and Run Task with Skyvern API on New Document from MongoDB API

Pipedream makes it easy to connect APIs for Skyvern, MongoDB 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