← Onfleet

Create Linked Pickup & Dropoff Tasks with Onfleet API

Pipedream makes it easy to connect APIs for Onfleet and 1200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Linked Pickup & Dropoff Tasks with the Onfleet API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to Create Linked Pickup & Dropoff Tasks with the Onfleet API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Linked Pickup & Dropoff Tasks with Onfleet API on New Requests from HTTP / Webhook API
HTTP / Webhook + Onfleet
 
Try it
Create Linked Pickup & Dropoff Tasks with Onfleet API on New Submission from Typeform API
Typeform + Onfleet
 
Try it
Create Linked Pickup & Dropoff Tasks with Onfleet API on New Submission (Instant) from Jotform API
Jotform + Onfleet
 
Try it
Create Linked Pickup & Dropoff Tasks with Onfleet API on New Custom Webhook Events from Stripe API
Stripe + Onfleet
 
Try it
Create Linked Pickup & Dropoff Tasks with Onfleet API on New Scheduled Tasks from Pipedream API
Pipedream + Onfleet
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
    },
};

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.
LabelPropTypeDescription
OnfleetonfleetappThis component uses the Onfleet app.
MerchantmerchantstringSelect a value from the drop down menu.
ExecutorexecutorstringSelect a value from the drop down menu.
Has A Pickup RecipienthasPickupRecipientboolean

If the pickup have a recipient who should be notified of task status changes.

Has A Dropoff RecipienthasDropoffRecipientboolean

If the dropoff have a recipient who should be notified of task status changes.

Destination Latitudelatitudestring

The Latitude of the destination.

Destination Longitudelongitudestring

The Longitude of the destination.

Address Line 1streetstring

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 2apartmentstring

For display purposes only. Used for Apartment, suite or other descriptive information.

Address Citycitystring

If coordinates used, for display purposes only. Coordinates will be relied on for actual location.

Address State / Provincestatestring

If coordinates used, for display purposes only. Coordinates will be relied on for actual location.

Address Post Code / ZippostalCodestring

If coordinates used, for display purposes only. Coordinates will be relied on for actual location.

Address Countrycountrystring

If coordinates used, for display purposes only. Coordinates will be relied on for actual location.

Task Link OrdertaskLinkOrderintegerSelect a value from the drop down menu:{ "label": "Pickup first", "value": 1 }{ "label": "Dropoff first", "value": 2 }
AssignmentautoAssignstringSelect a value from the drop down menu:auto-assignteamdriver
Quantityquantityinteger

The number of units to be dropped off while completing this task, for route optimization purposes.

Service TimeserviceTimeinteger

The number of minutes to be spent by the worker on arrival at this task's destination, for route optimization purposes.

Signature RequirementsignatureRequirementboolean

A signature must be collected to complete this task.

Photo RequirementphotoRequirementboolean

A photo must be collected to complete this task.

Notes RequirementnotesRequirementboolean

Task completion notes must be submitted to complete this task.

Minimum Age RequirementminimumAgeRequirementinteger

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 AftercompleteAfterinteger

A timestamp in unix time for the earliest time the task should be completed, in milliseconds precision.

Complete BeforecompleteBeforeinteger

A timestamp in unix time for the latest time the task should be completed, in milliseconds precision.

Notesnotesstring

Notes for the task. Field length cannot exceed 10,000 characters.

Appearanceappearanceobject

Set triangle colored pins on the map.

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

About Onfleet

Onfleet is the world's most advanced last mile delivery platform.

More Ways to Use Onfleet

Triggers

New SMS Recipient Response Missed (Instant) from the Onfleet API

Emit new event when a new SMS recipient response is missed.

 
Try it
New Task Arrival (Instant) from the Onfleet API

Emit new event when a new task is arrival.

 
Try it
New Task Assigned (Instant) from the Onfleet API

Emit new event when a new task is assigned.

 
Try it
New Task Cloned (Instant) from the Onfleet API

Emit new event when a new task is cloned.

 
Try it
New Task Completed (Instant) from the Onfleet API

Emit new event when a new task is completed.

 
Try it

Actions

Create New Task with the Onfleet API

Create a new task. See the docs here

 
Try it
Create Task (Template Use) with the Onfleet API

Creates a single task. Used for simple templates only. See the docs here

 
Try it

Explore Other Apps

1
-
12
of
1200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Beta
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.