Create New Task with Onfleet API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Onfleet, Twilio SendGrid and 2,000+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Create New Task with the Onfleet API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Twilio SendGrid 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 Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
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
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
N/A	`http`	`$.interface.http`	This 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create New Task on Onfleet

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

Version:0.0.1

Key:onfleet-create-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-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.

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.
Pickup Task	`pickupTask`	`boolean`	Whether the task is a pickup task.
Recipient Name	`recipientName`	`string`	The person to be notified that the dropoff is occurring.
Recipient Phone	`recipientPhone`	`string`	The phone of the recipient.
Recipient Notes	`recipientNotes`	`string`	Notes related the recipient or the destination like door codes, beware of dog, etc.
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.
Assignment	`autoAssign`	`string`	Select a value from the drop down menu:`auto-assignteamdriver`
Dependencies	`dependencies`	`string[]`	Select a value from the drop down menu.
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.
Use Merchant For Proxy	`useMerchantForProxy`	`boolean`	Override the organization ID to use the merchant orgID when set to true for this task only.
Scan Only Required Barcodes	`scanOnlyRequiredBarcodes`	`boolean`	Set restrictions to block the scanning of non-required barcodes.
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 New Task with Onfleet API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Onfleet, Twilio SendGrid and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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