Simplify Zoho API integration with Deluge’s invokeAPI task

Hello all!

Happy New Year! As we kick off 2025, we’re excited to share some of the latest updates to enhance your Deluge experience. 

While Deluge already offered robust API integration capabilities, we’ve taken it to the next level with the introduction of our new invokeAPI task. The new task has been launched with the aim to streamline the process of connecting with Zoho’s extensive suite of services. Unlike the invokeURL task, where you need to provide the complete URL, with invokeAPI, you only need to specify the path. The system will automatically fetch the domain based on the respective Zoho service’s data center, ensuring seamless access across all data centers when making API calls.

This capability of the invokeAPI task is especially useful when working with multiple Zoho services across different data centers. This streamlines the development process by eliminating the need to manually specify the base domain for each service, saving you a lot of time and effort.

What is invokeAPI?

The invokeAPI task in Deluge allows you to make REST API calls to access and modify data in one Zoho service from another Zoho service. 

The invokeAPI task can be used across all Zoho services that support Deluge. However, it's currently limited to performing integrations with specific Zoho services. These include Zoho CRM, Zoho Books, Zoho Invoice, Zoho Billing, Zoho Inventory, Zoho Bookings, Zoho Cliq, and Zoho Creator.

We’re excited to share that plans are underway to extend this capability to even more services across the Zoho ecosystem!

Key benefits

The main objective of the invokeAPI task is to simplify API integrations within the Zoho ecosystem. Here are its key benefits:

• URL requirements: You no longer need to specify the full URL; simply provide the API path.
• Domain detection: The domain is automatically determined based on the Zoho service you’re interacting with (e.g., Zoho CRM, Zoho Books) and its corresponding data center. This ensures accurate routing of API calls regardless of the hosting data center. Further, it reduces the risk of errors associated with incorrect URLs or misconfigured endpoints.
• Enhanced response handling: The response object includes the header and status attributes by default. This enables you to branch logic based on the status code and utilize header values effectively. For example, when the status code is 301, the redirection URL is included in the header. Further, we’re working on supporting the redirection attribute by default in future updates.

Some additional capabilities that set the invokeAPI task apart include:

• Support for body parameters in GET and DELETE methods: Unlike the invokeURL task, which only supports query strings for DELETE requests, the invokeAPI task allows you to pass values in the request body for GET and DELETE operations.
  
• This task also provides the flexibility to customize each parameter in your API request. For instance, you can set parameters such as the name, content type, and encoding type to tailor the requests to your specific needs. 
  

How it works

When you use the invokeAPI task, you simply need to specify the service and the path to the API endpoint. 

Here’s the basic syntax:

response = invokeapi
[
  service: <service_name>
  path: <path_value>
  type: <type_value>
  parameters: <parameters_value>
  body: <body_value>
  headers: <headers_value>
  connection: <connection_name>
  response-format: <response_format_value>
  response-decoding: <encoding_format_value>
];

Example: Creating a lead in Zoho CRM

Assume that you want to create a new lead in Zoho CRM. In the invokeAPI task, you only need to provide the service (crm) and the path (/crm/v2/Leads). 

data = {"data": [{"Last_Name": "Doe", "First_Name": "John", "Email": "john.doe@example.com", "Company": "ABC Corp"}]};

response = invokeapi

[

  service: zohocrm

  path: "/crm/v7/Leads"

  type: POST

  body: data.tostring()

  headers: {"Content-Type": "application/json"}

  response-format: COLLECTION

  response-decoding: "UTF-8"

  connection: "<connection_name>"

];

info response;

In this example:

• service: We specify the Zoho CRM service (zohocrm).
  
• path: This is the API endpoint path for creating leads (/crm/v7/Leads).
  
• type: The HTTP method is POST because we're creating a new lead.
  
• body: This is the data sent in the request body (the lead information).
  
• headers: We specify that the request body is in JSON format.
  
• response-format: We expect the response to be in COLLECTION format.
  
• response-decoding: The response will be decoded using UTF-8 encoding.
  
• connection: This is the TEXT that represents the name of the connection.

Use cases for invokeAPI

Here are some popular use cases of how the invokeAPI task can be utilized:

• Sync leads between Zoho CRM and Zoho Projects: Automatically create a new project in Zoho Projects when a new lead is added to Zoho CRM.
  
• Automate invoices in Zoho Books: When a deal is closed in Zoho CRM, automatically generate an invoice in Zoho Books.
  
• Customer support automation: When a new support ticket is created in Zoho Desk, use invokeAPI to create corresponding tasks or issues in Zoho Projects or Zoho CRM.
  
• Cross-app data synchronization: Easily synchronize customer data between Zoho CRM, Zoho Books, Zoho Desk, and Zoho Projects to ensure consistency across your applications.
  

Note: These are just examples—rest assured that a wide range of actions can be performed using this task.

Documentation

We've also come up with comprehensive documentation for this task, and you can take a look at it by visiting the invokeAPI Task help doc.

We believe the all-new invokeAPI Deluge task will be a game-changer for users aiming to integrate seamlessly across multiple Zoho apps. This feature is especially beneficial for teams working with multiple Zoho applications or the Zoho One bundle.

As we wrap up, we want to let you know that we are committed to expanding the capabilities of Deluge, and we’re working hard to bring even more features your way. Stay tuned for exciting updates!

If you need any assistance, don’t hesitate to reach out to us. We’re always happy to help.

Regards,
The Zoho Creator Team

• Topic Participants

• Ashwin Vishal R

  

• Sticky Posts

• Introducing Zoho Creator's 2025 Release Projection 2

  Hello Creators! I'm Prakash, from the Creator product management team, and today I'm delighted to unveil our next set of features as part of Release Projection 2 for 2025. With thoughtful analysis and planning, we've curated powerful new capabilities

• Zoho Creator - 2023 Release Projection 1

  Hello everyone! A very Happy New Year to you and your family. Hope you're all good and having a great time using Zoho Creator to make your lives easier and your businesses prosper. 2022 was an action-packed year for us at Creator, and we hope to continue

• Zoho Creator User Group meetups in a city near you! - Oct - Nov, 2023

  Greetings from the Zoho Creator team! We're hosting a series of Zoho Creator meetups in various cities across the globe, and we'd love to meet you there! Our meetups are a great opportunity to network with industry peers, exchange ideas and best practices,

• Zoho Creator - 2023 Release Projection 2

  Hello everyone! Time truly flies when you're having an incredible journey, and today we mark the completion of an eventful and action-packed six months. It feels like just yesterday when we embarked on this adventure together with the launch of our new

• Upcoming Updates - August 2022

  Hi all, Greetings from the Zoho Creator team! Today we've got news for you on some exciting updates. And rest assured— there’s more to come! In this post, we'll be going over the upcoming features and improvements for this month as mentioned below. A

• Recent Topics

• Customize Layout

  I am using "Customize Layot" for customize Quotation template but I try to add logo into the header by "%ScaledLogoImage%" code but dont add logo into header. what is problem?

• Problem - cant add Users (i.e. Zoho one / CRM Users) to BCC or CC in email, i.e. Sales orders or Retainers

  I can go to zoho books email templates, and select any email template, and automatically include any Zoho One user, i.e. member of staff. However in the context of sending an email, it will not let us add a member of staff from the user list, instead

• UK MTD ITSA

  UK Making Tax Digital for Income Tax I have had notice this is to apply from April 2026. What is Zoho doing about this? I will need to start planning to implement this in the next months so need an update as to what I will and will not be able to do in

• Partial refunds

  I am trying to process refund for a one item invoice, however the refund is partial: i am getting this error while creating credit note, can anyone share some wisdom about this

• Zoho Books Roadshows are back in the UAE!

  Hello there, Business owners and accounting professionals of the UAE, we’re coming to your cities! FTA accredited Zoho Books is now officially one of the Digital Tax Integrators in the UAE. With the newly launched direct VAT filing capabilities, we're

• New user After moving over from QBO

  New user observations/suggestions. QBO took away a lot of features I was used to with the desktop version. Chaos ensued. Zoho Books has a lot of what I was used to and a bit more. Good deal Some things I have run into and suggest some upgrades. 1: The

• Sole Trader - Financial Advisor (Appointed Representative) - Paid via Capital Account but no Invoicing...

  Hi. I'm about to venture into a new business after 12 months of intensive learning/exams. A little chuffed if I may say so especially at 52! I really like the look of ZoHo Books for my modest enterprise but I'm in need of some guidance, please. My services

• Multi-Unit Inventory with Flexible Unit Selection (Purchase in One Unit, Sell in Another)

  We need multi-unit inventory management in Zoho Books with the flexibility to choose units (e.g., Box or Piece) at the time of purchase or sale. For example, if 1 Box = 10 Pieces, we should be able to record purchases in Boxes but sell either in Boxes

• Disputed Purchase Invoices

  We have recently moved to Zoho Books from Sage. In Sage we were able to post a purchase/vendor invoice but mark it as on dispute. This would usually be a pricing query or if something was damaged. It would show in their ledger, so we could agree their

• No TDS Deduction

  In some of our case, where we are reselling items at the same rate we purchased. In this scenario, Indian IT Law has a provision to request customer not to deduct TDS if the transaction value is same. TDS is paid by us (intermediary reseller) before we

• CBSA - GST CHARGES on imports

  Hi there, We have a questions about landed cost categorization. We received a shipment from overseas. CBSA invoiced us for the GST on the items. Now we entered the CBSA-GST as a separate bill and attached it as landed cost to the main invoice based on

• Zoho Books

  How do I manually insert opening balance?

• Sales order & purchase order item links for item details

  This is fantastic for checking lots of things, I use it a lot. It would be great to see it extended to invoices & bills On another note, may as well throw in my favourite whinge ..... Wish you guys would get the PO receive differences sorted urgently,

• Bank charges are applied. Please select a bank account.

  Hello, I'm trying to add bank charges to a customer payment, but I get the error message "Bank charges are applied. Please select a bank account." I found this old thread, where it says that I need to "select a Bank account for the 'Deposit To' dropdown

• How to add receipts

  How to add receipts

• Support for auto-upgrade in TrueSync (for Windows)

  WorkDrive TrueSync app now supports auto-upgrading to the latest version for Windows OS. You must manually download and install the TrueSync app version 3.4.0 to avail this feature. Download the latest TrueSync app for Windows (version 3.4.0) Supported

• WorkDrive API Documentation

  WorkDrive provides users and developers an extensive set of APIs to help integrate functionalities of Zoho WorkDrive with other Zoho applications and third-party tools. We have published the official WorkDrive API Documentation page for all external users.

• March 15, 2023: Zoho Docs is discontinued

  As of today (March 15, 2023) Zoho Docs is discontinued for all users. We would like to thank our customers for trusting us for so many years! Going forward, we're confident you'll enjoy using Zoho WorkDrive for all your advanced file management and collaboration

• Introducing WorkDrive 4.0: Enhanced productivity. Advanced data administration. (Phase 1)

  Hello All, We're excited to share the release of WorkDrive 4.0, which includes important new features and enhancements focused primarily on productivity, secure collaboration, data administration, integrations, and user experience. Read the official announcement

• Ask the Experts: Five-hour live Q&A session with Zoho WorkDrive product experts

  Have questions about WorkDrive 5.0? Let’s talk! We recently launched Zoho WorkDrive 5.0, packed with powerful updates to help your team work smarter, stay secure, and get more value from your business content. From content-centric workflows and AI-powered

• External download link limit

  Can You please help us to understand this For Zoho WorkDrive external users, the download limit is a maximum of 5 GB total download size and a maximum of 50 first-level files and folders What is the meaning of first level? We are using these files in

• Dynamically catching new file creations

  I have a team folder with many subfolders, and in those folders we add new documents all the time. I'd like to have a workflow or script to notify me (and then take other actions) when a file is added anywhere in that structure that ends in "summary.txt".

• Rotate an Image in Workdrive Image Editor

  I don't know if I'm just missing something, but my team needs a way to rotate images in Workdrive and save them at that new orientation. For example one of our ground crew members will take photos of job sites vertically (9:16) on his phone and upload

• Workflow workdrive rollout

  Hi! When will workflow be rolled out to all users? Thanks.

• Creating and managing a Team Folder using WorkDrive TrueSync

  Hello everyone, Are you tired of constantly switching between your Desktop TrueSync app and the WorkDrive web app to create and manage Team Folders? We’ve made things easier for you. You can now create and manage Team Folders directly within the TrueSync

• Edit images seamlessly with WorkDrive's built-in Image Editor

  Are you tired of switching between multiple tools just to make simple edits to your images? We understand the hassle, which is why Zoho WorkDrive now comes with a built-in image editing tool, powered by Zoho Annotator. This tool allows you to edit images

• Supercharge your email workflow with WorkDrive's add-in for Microsoft Outlook

  Consider this: You’re handling a critical project, and your inbox is packed with important attachments, email threads, and client communications. The back-and-forth routine of downloading files to your computer, uploading them to WorkDrive, and manually

• Secure and promote your content with Custom Watermarking

  Imagine this: You’re a professional photographer who regularly shares your work online with potential clients and collaborators. Recently, you notice that some of your images have been reposted without any credit or permission. This not only impacts your

• Join us in Singapore for the Zoho WorkDrive User Group meetup!

  Hello, everyone! Exciting news! We'll be hosting an upcoming Zoho WorkDrive user group meetup in the beautiful city of Singapore this November. At this Zoho User Group meetup, we'll guide you through ways to use WorkDrive as a platform and build custom

• WorkDrive TrueSync now supports ARM64-based Windows devices!

  We’re excited to announce that the Zoho WorkDrive TrueSync app now fully supports Windows devices with ARM64 architecture! Whether you're working on an ARM-based device or an x64 processor, you can now enjoy the same seamless file synchronization experience

• Option to Disable Download for Documents Shared via Permalink

  Dear Zoho Writer Team, Currently, when sharing a Writer document using the regular permalink (Collaborators with external users), there is no option to restrict the ability to download the document. While the external share link allows such restrictions,

• How to Download a File from Zoho WorkDrive Using a Public Link

  How to Download a File from Zoho WorkDrive Using a Public Link If you're working with Zoho WorkDrive and want to download a file using a public link, here's a simple method to do so using API or a basic script. This approach helps developers or teams

• domain not verified error

  Hi when i try to upload a video from zoho creator widget to zoho work drive iam getting domain not verified error.I don't know what to do .In zoho api console this is my home page url https://creatorapp.zoho.com/ and this is my redirect url:www.google.com.Iam

• Live Webinar: Getting Started with Zoho WorkDrive - A Complete Overview

  Hello everyone, We’re excited to invite you to our upcoming live webinar! Discover how to set up your team, bring in your data, and make the most of WorkDrive’s collaboration, organization, AI, and security capabilities. This session is perfect for anyone

• Calendly One-way sync- Beta Access

  Hello Community, Many of our Zoho Calendar users have expressed their interests in Zoho Calendar and Calendly integration. We've been tightly working on with Calendly team to provide a two-way sync between Calendly and Zoho Calendar. However, there have

• The year that was at Zoho Calendar 2023- Part 2

  In continuation with our previous post on all the exciting updates and improvements that have shaped Zoho Calendar over the past 12 months, Lets delve into more: Bring your calendars together- Introducing Zoho Calendar and Outlook calendar synchronisation

• Tip of the week #18: Change the event organizer in Zoho Calendar.

  We cannot always be available to conduct an event when we organise one. In these circumstances, you can use Zoho Calendar to change the event organizer at any moment before the event begins. This way, you can avoid cancelling the event while still taking

• Tip of the week #20: Create and manage multiple personal calendars.

  Zoho Calendar provides users with the facility to create and manage as many calendars as required. All these calendars can be managed and edited as per user requirements. You can alter the calendar view, make changes to the calendar theme, share the calendar

• Tip of the week #24: Subscribe to the calendars of a Zoho Calendar user.

  Calendars that are created by Zoho Calendar users can also be added to your Zoho calendar. All public calendars listed by the users will be available when you enter the email address. You can choose the calendar you need to subscribe to. Once the email

• Tip of the week #26: Import/ Export calendars in Zoho Calendar.

  Any calendar on the web or calendars that you create in any other calendar application can be imported in to Zoho Calendar. This will help you to add the events from the calendars that you import to your Zoho Calendar. You also have the option to export

• Next Page