← Pipedream + Onfleet integrations

Create New Task with Onfleet API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on
New Scheduled Tasks from the Pipedream API
Next, do this
Create New Task 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

This integration creates a workflow with a Pipedream trigger and Onfleet action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Scheduled Tasks trigger
    1. Connect your Pipedream account
    2. Optional- Configure Secret
  3. Configure the Create New Task action
    1. Connect your Onfleet account
    2. Select a Merchant
    3. Select a Executor
    4. Optional- Configure Pickup Task
    5. Configure Recipient Name
    6. Configure Recipient Phone
    7. Optional- Configure Recipient Notes
    8. Optional- Configure Destination Latitude
    9. Optional- Configure Destination Longitude
    10. Configure Address Line 1
    11. Optional- Configure Address Line 2
    12. Configure Address City
    13. Configure Address State / Province
    14. Configure Address Post Code / Zip
    15. Configure Address Country
    16. Select a Assignment
    17. Optional- Select one or more Dependencies
    18. Optional- Configure Quantity
    19. Optional- Configure Service Time
    20. Configure Signature Requirement
    21. Configure Photo Requirement
    22. Configure Notes Requirement
    23. Optional- Configure Minimum Age Requirement
    24. Optional- Configure Complete After
    25. Optional- Configure Complete Before
    26. Optional- Configure Notes
    27. Optional- Configure Use Merchant For Proxy
    28. Optional- Configure Scan Only Required Barcodes
    29. Optional- Configure Appearance
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time
Version:0.3.1
Key:pipedream-new-scheduled-tasks

Pipedream Overview

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

  • An application that can extract data from a database, transform it, and then
    load it into another database.
  • An application that can monitor a data source for changes, and then trigger a
    workflow in response to those changes.
  • An application that can poll an API for new data, and then process that data
    in real-time.

Trigger Code

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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.
LabelPropTypeDescription
PipedreampipedreamappThis component uses the Pipedream app.
Secretsecretstring

Optional but recommended: if you enter a secret here, you must pass this value in the x-pd-secret HTTP header when making requests

N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.

Trigger Authentication

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

Enter the API key from your Pipedream Account Settings

About Pipedream

Integration platform for developers

Action

Description:Create a new task. [See the docs here](https://docs.onfleet.com/reference/create-task)
Version:0.0.1
Key:onfleet-create-task

Onfleet Overview

Tired of manually managing your local delivery tasks and execution? Onfleet API
provides a way to automate and streamline your local delivery operations. With
Onfleet API, you can build powerful applications that can dramatically increase
the efficiency of your delivery business.

Here are some examples of what you can build with Onfleet API:

  • Automated routing for fleets of drivers
  • Automated billing and invoicing
  • Integration with existing business software
  • Assets and package tracking
  • Multi-lingual support
  • Analyzing delivery data to learn and optimize routes
  • Real-time insights into delivery performance
  • Automated after-delivery surveys
  • Scheduling services for special deliveries and pickups

Action Code

import onfleet from "../../app/onfleet.app.mjs";
import { clearObj, prepareData } from "../common/utils.mjs";
export default {
    key: "onfleet-create-task",
    name: "Create New Task",
    description: "Create a new task. [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.",
        },
        pickupTask: {
            propDefinition: [
                onfleet,
                "pickupTask",
            ],
            optional: true,
        },
        recipientName: {
            propDefinition: [
                onfleet,
                "recipientName",
            ],
        },
        recipientPhone: {
            propDefinition: [
                onfleet,
                "recipientPhone",
            ],
        },
        recipientNotes: {
            propDefinition: [
                onfleet,
                "recipientNotes",
            ],
            optional: 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",
            ],
        },
        autoAssign: {
            propDefinition: [
                onfleet,
                "autoAssign",
            ],
            reloadProps: true,
        },
        dependencies: {
            propDefinition: [
                onfleet,
                "dependencies",
            ],
            optional: 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,
        },
        useMerchantForProxy: {
            type: "boolean",
            label: "Use Merchant For Proxy",
            description: "Override the organization ID to use the merchant orgID when set to true for this task only.",
            optional: true,
        },
        scanOnlyRequiredBarcodes: {
            type: "boolean",
            label: "Scan Only Required Barcodes",
            description: "Set restrictions to block the scanning of non-required barcodes.",
            optional: true,
        },
        appearance: {
            propDefinition: [
                onfleet,
                "appearance",
            ],
            optional: true,
        },
    },
    async additionalProps() {
        let props = {};
        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;
    },
    async run({ $ }) {
        const { onfleet, ...data } = this;
        const preparedData = prepareData(data);
        const response = await onfleet.createTask(clearObj(preparedData));
        $.export("$summary", `A new task with id ${response.id} was successfully created!`);
        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.

LabelPropTypeDescription
OnfleetonfleetappThis component uses the Onfleet app.
MerchantmerchantstringSelect a value from the drop down menu.
ExecutorexecutorstringSelect a value from the drop down menu.
Pickup TaskpickupTaskboolean

Whether the task is a pickup task.

Recipient NamerecipientNamestring

The person to be notified that the dropoff is occurring.

Recipient PhonerecipientPhonestring

The phone of the recipient.

Recipient NotesrecipientNotesstring

Notes related the recipient or the destination like door codes, beware of dog, etc.

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.

AssignmentautoAssignstringSelect a value from the drop down menu:auto-assignteamdriver
Dependenciesdependenciesstring[]Select a value from the drop down menu.
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.

Use Merchant For ProxyuseMerchantForProxyboolean

Override the organization ID to use the merchant orgID when set to true for this task only.

Scan Only Required BarcodesscanOnlyRequiredBarcodesboolean

Set restrictions to block the scanning of non-required barcodes.

Appearanceappearanceobject

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

About Onfleet

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

More Ways to Connect Onfleet + Pipedream

Create a Subscription with Pipedream API on New SMS Recipient Response Missed (Instant) from Onfleet API
Onfleet + Pipedream
 
Try it
Delete a Subscription with Pipedream API on New SMS Recipient Response Missed (Instant) from Onfleet API
Onfleet + Pipedream
 
Try it
Get Component with Pipedream API on New SMS Recipient Response Missed (Instant) from Onfleet API
Onfleet + Pipedream
 
Try it
Create a Subscription with Pipedream API on New Task Completed (Instant) from Onfleet API
Onfleet + Pipedream
 
Try it
Delete a Subscription with Pipedream API on New Task Completed (Instant) from Onfleet API
Onfleet + Pipedream
 
Try it
New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

 
Try it
New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

 
Try it
New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

 
Try it
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
Create a Subscription with the Pipedream API

Create a Subscription. See Doc

 
Try it
Delete a Subscription with the Pipedream API

Delete a Subscription. See Doc

 
Try it
Generate Component Code with the Pipedream API

Generate component code using AI.

 
Try it
Get Component with the Pipedream API

Get info for a published component. See docs

 
Try it
Create Linked Pickup & Dropoff Tasks with the Onfleet API

Create a pickup task and dropoff task linked with each other. See the docs here

 
Try it

Explore Other Apps

1
-
12
of
1400+
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.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
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.
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.