Create Task (Template Use) with Onfleet API on New Event (Instant) from Zoho CRM API

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

Trigger workflow on

New Event (Instant) from the Zoho CRM API

Next, do this

Create Task (Template Use) 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 Zoho CRM 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 Event (Instant) trigger
1. Connect your Zoho CRM account
2. Configure Subscription Renewal Timer
3. Select one or more Events
Configure the Create Task (Template Use) action
1. Connect your Onfleet account
2. Select a Merchant
3. Select a Executor
4. Configure Recipient Name
5. Configure Recipient Phone
6. Optional- Configure Recipient Notes
7. Optional- Configure Destination Latitude
8. Optional- Configure Destination Longitude
9. Configure Address Line 1
10. Optional- Configure Address Line 2
11. Configure Address City
12. Configure Address State / Province
13. Configure Address Post Code / Zip
14. Configure Address Country
15. Optional- Configure Notes
16. Optional- Configure Complete After
17. Optional- Configure Complete Before
18. Optional- Configure Pickup Task
19. Select a Assignment
20. Optional- Configure Quantity
21. Optional- Configure Service Time
22. Configure Signature Requirement
23. Configure Photo Requirement
24. Configure Notes Requirement
25. Optional- Configure Minimum Age Requirement
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 Event (Instant) on Zoho CRM

Description:Emit new custom events from Zoho CRM

Version:0.0.15

Key:zoho_crm-new-event

View on GitHub

Zoho CRM Overview#

The Zoho CRM API enables the manipulation and retrieval of data within Zoho CRM, a platform for managing your sales, marketing, support, and inventory in a single system. Leveraging this on Pipedream, you can automate tasks like syncing contacts, updating lead statuses, or creating custom CRM operations that trigger actions in other apps. Pipedream's serverless platform allows for real-time data processing, transforming, and orchestrating workflows that respond to events in Zoho CRM with minimal latency.

Trigger Code#

import sortBy from "lodash.sortby";
import common from "../common/http-based/base.mjs";
import crudOps from "../common/http-based/common-crud-operations.mjs";

export default {
  ...common,
  key: "zoho_crm-new-event",
  name: "New Event (Instant)",
  description: "Emit new custom events from Zoho CRM",
  version: "0.0.15",
  type: "source",
  props: {
    ...common.props,
    events: {
      type: "string[]",
      label: "Events",
      description: "Choose one or more module events to trigger this event source.",
      async options({ page = 0 }) {
        if (page !== 0) {
          return [];
        }

        const { modules } = await this.zohoCrm.listModules();
        return sortBy(modules.flatMap(this._moduleSupportedEvents), "label");
      },
    },
  },
  methods: {
    ...common.methods,
    _moduleSupportedEvents(module) {
      // See the docs for more information about these attributes:
      // https://www.zoho.com/crm/developer/docs/api/v2/modules-api.html
      const {
        api_name: moduleKey,
        singular_label: moduleName,
      } = module;

      // As per the docs, the notation for a CRUD event on a record/module is
      // {capitalized record name}.{operation} (e.g. `Contacts.create` will
      // issue notifications when a contact is created). See the docs for more
      // details:
      // https://www.zoho.com/crm/developer/docs/api/v2/notifications/enable.html
      return this
        .getSupportedOps()
        .filter(({ flagName }) => module[flagName])
        .map(({
          description,
          op,
        }) => ({
          label: `${moduleName} ${description}`,
          value: `${moduleKey}.${op}`,
        }));
    },
    getSupportedOps() {
      return crudOps.allOpsData();
    },
    getEvents() {
      return this.events;
    },
  },
};

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
Zoho CRM	`zohoCrm`	`app`	This component uses the Zoho CRM app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Subscription Renewal Timer	`timer`	`$.interface.timer`	Zoho CRM webhooks subscriptions have an expiration date of up to 1 day. This event source renews the subscription every 12 hours by default.
Events	`events`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Zoho CRM uses OAuth authentication. When you connect your Zoho CRM account, Pipedream will open a popup window where you can sign into Zoho CRM and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho CRM API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoCRM.settings.allZohoCRM.users.allZohoCRM.org.allZohoCRM.modules.allZohoCRM.bulk.allZohoCRM.notifications.readZohoCRM.notifications.createZohoCRM.notifications.updateZohoCRM.notifications.deleteZohoCRM.coql.READZohoCRM.functions.execute.READZohoCRM.functions.execute.CREATEZohoCRM.templates.email.READZohoCRM.templates.inventory.READ

About Zoho CRM#

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

Action#

Create Task (Template Use) on Onfleet

Description:Creates a single task. Used for simple templates only. [See the docs here](https://docs.onfleet.com/reference/create-task)

Version:0.0.1

Key:onfleet-create-task-template

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-template",
    name: "Create Task (Template Use)",
    description: "Creates a single task. Used for simple templates only. [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.",
        },
        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",
            ],
        },
        notes: {
            propDefinition: [
                onfleet,
                "notes",
            ],
            optional: true,
        },
        completeAfter: {
            propDefinition: [
                onfleet,
                "completeAfter",
            ],
            optional: true,
        },
        completeBefore: {
            propDefinition: [
                onfleet,
                "completeBefore",
            ],
            optional: true,
        },
        pickupTask: {
            propDefinition: [
                onfleet,
                "pickupTask",
            ],
            optional: true,
        },
        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,
        },
    },
    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.
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.
Notes	`notes`	`string`	Notes for the task. Field length cannot exceed 10,000 characters.
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.
Pickup Task	`pickupTask`	`boolean`	Whether the task is a pickup task.
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.

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 Task (Template Use) with Onfleet API on New Event (Instant) from Zoho CRM API

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