Create Linked Pickup & Dropoff Tasks with Onfleet API on New Document from MongoDB API

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

Trigger workflow on

New Document from the MongoDB API

Next, do this

Create Linked Pickup & Dropoff Tasks with the Onfleet 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 Onfleet 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 Linked Pickup & Dropoff Tasks action
1. Connect your Onfleet account
2. Select a Merchant
3. Select a Executor
4. Configure Has A Pickup Recipient
5. Configure Has A Dropoff Recipient
6. Optional- Configure Destination Latitude
7. Optional- Configure Destination Longitude
8. Configure Address Line 1
9. Optional- Configure Address Line 2
10. Configure Address City
11. Configure Address State / Province
12. Configure Address Post Code / Zip
13. Configure Address Country
14. Select a Task Link Order
15. Select a Assignment
16. Optional- Configure Quantity
17. Optional- Configure Service Time
18. Configure Signature Requirement
19. Configure Photo Requirement
20. Configure Notes Requirement
21. Optional- Configure Minimum Age Requirement
22. Optional- Configure Complete After
23. Optional- Configure Complete Before
24. Optional- Configure Notes
25. Optional- Configure Appearance
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 Linked Pickup & Dropoff Tasks on Onfleet

Description:Create a pickup task and dropoff task linked with each other. [See the docs here](https://docs.onfleet.com/reference/create-task)

Version:0.0.1

Key:onfleet-create-pickup-dropoff-task

View on GitHub

Onfleet Overview#

The Onfleet API integrates with Pipedream to power logistics and delivery operations, offering real-time tracking, optimized routes, automatic dispatch, analytics, and communication with drivers. With Pipedream's serverless platform, one can automate complex workflows involving Onfleet and other apps, triggering actions based on events, scheduling tasks, or processing data to enhance delivery services.

Action Code#

import onfleet from "../../app/onfleet.app.mjs";
import { clearObj, prepareData } from "../common/utils.mjs";
export default {
    key: "onfleet-create-pickup-dropoff-task",
    name: "Create Linked Pickup & Dropoff Tasks",
    description: "Create a pickup task and dropoff task linked with each other. [See the docs here](https://docs.onfleet.com/reference/create-task)",
    type: "action",
    version: "0.0.1",
    props: {
        onfleet,
        merchant: {
            propDefinition: [
                onfleet,
                "merchant",
            ],
        },
        executor: {
            propDefinition: [
                onfleet,
                "merchant",
            ],
            label: "Executor",
            description: "The ID of the organization that will be responsible for fulfilling the task. Defaults to the creating organization. If you delegate your deliveries to a third party, provide their organization ID.",
        },
        hasPickupRecipient: {
            type: "boolean",
            label: "Has A Pickup Recipient",
            description: "If the pickup have a recipient who should be notified of task status changes.",
            reloadProps: true,
        },
        hasDropoffRecipient: {
            type: "boolean",
            label: "Has A Dropoff Recipient",
            description: "If the dropoff have a recipient who should be notified of task status changes.",
            reloadProps: true,
        },
        latitude: {
            propDefinition: [
                onfleet,
                "latitude",
            ],
            optional: true,
        },
        longitude: {
            propDefinition: [
                onfleet,
                "longitude",
            ],
            optional: true,
        },
        street: {
            propDefinition: [
                onfleet,
                "street",
            ],
        },
        apartment: {
            propDefinition: [
                onfleet,
                "apartment",
            ],
            optional: true,
        },
        city: {
            propDefinition: [
                onfleet,
                "city",
            ],
        },
        state: {
            propDefinition: [
                onfleet,
                "state",
            ],
        },
        postalCode: {
            propDefinition: [
                onfleet,
                "postalCode",
            ],
        },
        country: {
            propDefinition: [
                onfleet,
                "country",
            ],
        },
        taskLinkOrder: {
            type: "integer",
            label: "Task Link Order",
            description: "The order in which to create the linked task relationship. By default, the pickup is created as the prerequisite to the dropoff. Choose \"Dropoff first\" to reverse this order, requiring completion of the dropoff before the pickup.",
            default: 1,
            options: [
                {
                    label: "Pickup first",
                    value: 1,
                },
                {
                    label: "Dropoff first",
                    value: 2,
                },
            ],
        },
        autoAssign: {
            propDefinition: [
                onfleet,
                "autoAssign",
            ],
            reloadProps: true,
        },
        quantity: {
            propDefinition: [
                onfleet,
                "quantity",
            ],
            optional: true,
        },
        serviceTime: {
            propDefinition: [
                onfleet,
                "serviceTime",
            ],
            optional: true,
        },
        signatureRequirement: {
            propDefinition: [
                onfleet,
                "signatureRequirement",
            ],
        },
        photoRequirement: {
            propDefinition: [
                onfleet,
                "photoRequirement",
            ],
        },
        notesRequirement: {
            propDefinition: [
                onfleet,
                "notesRequirement",
            ],
        },
        minimumAgeRequirement: {
            propDefinition: [
                onfleet,
                "minimumAgeRequirement",
            ],
            optional: true,
        },
        completeAfter: {
            propDefinition: [
                onfleet,
                "completeAfter",
            ],
            optional: true,
        },
        completeBefore: {
            propDefinition: [
                onfleet,
                "completeBefore",
            ],
            optional: true,
        },
        notes: {
            propDefinition: [
                onfleet,
                "notes",
            ],
            optional: true,
        },
        appearance: {
            propDefinition: [
                onfleet,
                "appearance",
            ],
            optional: true,
        },
    },
    async additionalProps() {
        let props = {};
        if (this.hasPickupRecipient) {
            props = {
                ...props,
                pickupRecipientName: {
                    type: "string",
                    label: "Pickup Recipient Name",
                    description: "The person to be notified that the pickup is occurring.",
                },
                pickupRecipientPhone: {
                    type: "string",
                    label: "Pickup Recipient Phone",
                    description: "The phone of the pickup recipient.",
                },
                pickupRecipientNotes: {
                    type: "string",
                    label: "Pickup Recipient Notes",
                    description: "Notes related the recipient or the destination like door codes, beware of dog, etc.",
                    optional: true,
                },
            };
        }
        if (this.hasDropoffRecipient) {
            props = {
                ...props,
                dropoffRecipientName: {
                    type: "string",
                    label: "Dropoff Recipient Name",
                    description: "The person to be notified that the pickup is occurring.",
                },
                dropoffRecipientPhone: {
                    type: "string",
                    label: "Dropoff Recipient Phone",
                    description: "The phone of the dropoff recipient.",
                },
                dropoffRecipientNotes: {
                    type: "string",
                    label: "Dropoff Recipient Notes",
                    description: "Notes related the recipient or the destination like door codes, beware of dog, etc.",
                    optional: true,
                },
            };
        }
        if (this.autoAssign) {
            if (this.autoAssign != "auto-assign") {
                props = {
                    ...props,
                    team: {
                        type: "string",
                        label: "Team Id",
                        description: "The team's Id",
                        options: async () => {
                            const teams = await this.onfleet.listTeams();
                            return teams.map(({ id: value, name: label, }) => ({
                                label,
                                value,
                            }));
                        },
                    },
                };
            }
            if (this.autoAssign === "driver") {
                props = {
                    ...props,
                    worker: {
                        type: "string",
                        label: "Driver",
                        description: "The driver's Id",
                        options: async () => {
                            const drivers = await this.onfleet.listWorkers({
                                teamId: this.team,
                            });
                            return drivers.map(({ id: value, name: label, }) => ({
                                label,
                                value,
                            }));
                        },
                    },
                };
            }
        }
        return props;
    },
    methods: {
        async createTask(onfleet, data) {
            const preparedData = prepareData(data);
            return await onfleet.createTask(clearObj(preparedData));
        },
    },
    async run({ $ }) {
        const { onfleet, pickupRecipientName, pickupRecipientPhone, pickupRecipientNotes, dropoffRecipientName, dropoffRecipientPhone, dropoffRecipientNotes, taskLinkOrder, pickupLatitude, pickupLongitude, pickupAddress, dropoffLatitude, dropoffLongitude, dropoffAddress, recipientPickup, recipientDropoff, ...data } = this;
        const pickupObject = {
            ...data,
            recipientName: pickupRecipientName,
            recipientPhone: pickupRecipientPhone,
            recipientNotes: pickupRecipientNotes,
            recipient: recipientPickup,
            latitude: pickupLatitude,
            longitude: pickupLongitude,
            address: pickupAddress,
        };
        const dropoffObject = {
            ...data,
            recipientName: dropoffRecipientName,
            recipientPhone: dropoffRecipientPhone,
            recipientNotes: dropoffRecipientNotes,
            recipient: recipientDropoff,
            latitude: dropoffLatitude,
            longitude: dropoffLongitude,
            address: dropoffAddress,
        };
        let pickupResponse = {};
        let dropoffResponse = {};
        let response = {};
        let summary = "";
        if (taskLinkOrder == "1") {
            pickupResponse = await this.createTask(onfleet, {
                ...pickupObject,
            });
            dropoffResponse = await this.createTask(onfleet, {
                dependencies: [
                    pickupResponse.id,
                ],
                ...dropoffObject,
            });
            summary = `A new pickup task with id ${pickupResponse.id} was successfully created, then a new dropff task with id ${dropoffResponse.id} was successfully created!`;
        }
        else {
            dropoffResponse = await this.createTask(onfleet, {
                ...dropoffObject,
            });
            pickupResponse = await this.createTask(onfleet, {
                dependencies: [
                    dropoffResponse.id,
                ],
                ...pickupObject,
            });
            summary = `A new dropff task with id ${dropoffResponse.id} was successfully created, then a new pickup task with id ${pickupResponse.id} was successfully created!`;
        }
        response = {
            dropoffResponse,
            pickupResponse,
        };
        $.export("$summary", summary);
        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
Onfleet	`onfleet`	`app`	This component uses the Onfleet app.
Merchant	`merchant`	`string`	Select a value from the drop down menu.
Executor	`executor`	`string`	Select a value from the drop down menu.
Has A Pickup Recipient	`hasPickupRecipient`	`boolean`	If the pickup have a recipient who should be notified of task status changes.
Has A Dropoff Recipient	`hasDropoffRecipient`	`boolean`	If the dropoff have a recipient who should be notified of task status changes.
Destination Latitude	`latitude`	`string`	The Latitude of the destination.
Destination Longitude	`longitude`	`string`	The Longitude of the destination.
Address Line 1	`street`	`string`	If coordinates used, this will be for display purposes only. Coordinates will be relied on for actual location. Used for the number and name of the street.
Address Line 2	`apartment`	`string`	For display purposes only. Used for Apartment, suite or other descriptive information.
Address City	`city`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address State / Province	`state`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address Post Code / Zip	`postalCode`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Address Country	`country`	`string`	If coordinates used, for display purposes only. Coordinates will be relied on for actual location.
Task Link Order	`taskLinkOrder`	`integer`	Select a value from the drop down menu:`{ "label": "Pickup first", "value": 1 }{ "label": "Dropoff first", "value": 2 }`
Assignment	`autoAssign`	`string`	Select a value from the drop down menu:`auto-assignteamdriver`
Quantity	`quantity`	`integer`	The number of units to be dropped off while completing this task, for route optimization purposes.
Service Time	`serviceTime`	`integer`	The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes.
Signature Requirement	`signatureRequirement`	`boolean`	A signature must be collected to complete this task.
Photo Requirement	`photoRequirement`	`boolean`	A photo must be collected to complete this task.
Notes Requirement	`notesRequirement`	`boolean`	Task completion notes must be submitted to complete this task.
Minimum Age Requirement	`minimumAgeRequirement`	`integer`	The recipient's ID must be scanned and their age verified to be greater than or equal to the `minimumAge` in order to complete the task. Must be in a plan that supports ID verification.
Complete After	`completeAfter`	`integer`	A timestamp in unix time for the earliest time the task should be completed, in milliseconds precision.
Complete Before	`completeBefore`	`integer`	A timestamp in unix time for the latest time the task should be completed, in milliseconds precision.
Notes	`notes`	`string`	Notes for the task. Field length cannot exceed 10,000 characters.
Appearance	`appearance`	`object`	Set triangle colored pins on the map.

Action Authentication#

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

To retrieve your API key,

Navigate to your Onfleet account and sign in
Go to Settings > API & Webhooks

Create Linked Pickup & Dropoff Tasks with Onfleet API on New Document from MongoDB API

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