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

• Cloning Item With Images Or The Option With Images

  Hello, when I clone an item, I expect the images to carry over to the cloned item, however this is not the case in Inventory. Please make it possible for the images to get cloned or at least can we get a pop up asking if we want to clone the images as

• ZOHO BOOKS - RECEIVING MORE ITEMS THAN ORDERED

  Hello, When trying to enter a vendor's bill that contains items with bigger quantity than ordered in the PO (it happens quite often) - The system would not let us save the bill and show this error: "Quantity recorded cannot be more than quantity ordered." 

• Stock count by bin location

  Is there a configuration to make a stock count by bin or area and not by product. these is useful to manage count by area Regards

• Server-based Appication API access for Social, Sites, Flow, Pages.

  Hello, I am trying to hook up API access for a number of apps and I have hit a wall trying to add these scopes to the API feed. We cannot find the correct way to list the scope for these Zoho apps; Social, Sites, Flow, Writer. Error on web-page comes

• Zoho Survey – Page Skip Logic Not Working

  Hi everyone, I'm experiencing an issue with the page skip logic in Zoho Survey. Last week, it was working fine, and I haven’t changed anything in the settings. However, today the skip logic is not working at all. I also tried testing it with different

• Zoho Survey: Bulk Exporting Raw Data (CSV/Excel) from 100+ Individual Survey Projects

  Hi Zoho Community, I am currently managing a 360-degree evaluation process that involves 100+ individual survey projects (one separate survey for each employee being evaluated). I need to download the raw response data (CSV or Excel) for all 100 surveys.

• Brand Studio Projects in Analytics

  Hi All, Currently pulling my hair out over trying to link together some social media posts for a reporting dashboard in Analytics, so I thought I'd see if anyone on here had a solution. Our Marketing Team created a LinkedIn campaign in Zoho Brand Studio,

• ERROR: Product type cannot be changed for Items having transactions.

  I have mistakenly added a product type as goods for an item that was a digital service. Now when HSN/SAC became mandatory, this brought my attention to this error I did. So I tried changing the product type but it displayed this error message Product

• Combine and hide invoice lines

  In quickbooks we are able to create a invoice line that combines and hides invoices lines below. eg. Brochure design         $1000 (total of lines below, the client can see this line) Graphic Design           $600 (hidden but entered to reporting and

• Introducing Built-in Telephony in Zoho Recruit

  We’re excited to introduce Built-in Telephony in Zoho Recruit, designed to make recruiter–candidate communication faster, simpler, and fully traceable. These capabilities help you reduce app switching, handle inbound calls efficiently, and keep every

• Include Notes in email templates for task

  Hi there,  I am setting up some automated email reminders via "setup-automation-workflow" to be send out when a task is being edited. I would like to include the "task notes" in the email. Is that possible? I do not find that field in the dropdown table when setting up the email template. Is it also possible to trigger the workflow rule when a new note is added to the task? In my opinion that should be quite essential, since a task update is often done by adding a new note to the task.... Also i

• Auto-publish job openings on my Zoho Recruit Careers Website

  I have developed a script using the Zoho Recruit API that successfully inserts new jobOpening records to my Zoho Recruit website, but my goal is to auto-publish to the Careers Website. The jobOpening field data shows two possible candidates to make this

• [Free webinar] Custom domains for portals in Zoho Creator - Creator Tech Connect

  Hello everyone, We’re excited to invite you to another edition of the Creator Tech Connect webinar. About Creator Tech Connect The Creator Tech Connect series is a free monthly webinar featuring in-depth technical sessions designed for developers, administrators,

• Remove my video

  Hi, How can I remove my video so that I don't have to see myself. It's weird so I always remove my own video from what I see but cannot find this feature here. Thanks!

• Marking a meeting 'done'.

  I would like to somehow mark a meeting 'done' and placed under the contact's page rather than deleting it and having no record of it. Am I missing a button that does this?

• Feature Request: Enable Custom PDF Layout Editor for All Modules (Including Package Slips)

  Hello Zoho Community and Product Team, I am writing to share a suggestion that would significantly enhance the customization capabilities within Zoho Books. We all appreciate the power of the Custom PDF Layouts (the "New" template engine) that allows

• Allocating inventory to specific SO's

  Is there a way that allocate inventory to a specific sales order? For example, let's say we have 90 items in stock. Customer 1 orders 100 items. This allocates all 90 items to their order, and they have a back order for the remaining 10 items which could

• Partial payments for retainer invoices

  When a customer does not pay the entire retainer invoice there is no way to apply a partial payment. PLEASE add this function.

• Can I export to PDF in Zoho Learn

  I have seen help pages where export to pdf options are available but I do not see that option available from the application. I see that exprt is available in my free trial version but that is only to html pages. I need to be able to export my manuals

• Service line items

  Hello Latha, Could you please let me know the maximum number of service line items that can be added to a single work order? Thanks, Chethiya.

• Sending emails via Books

  Anyone else getting similar problems recently ??..... Hi, Your message to the following recipient was not delivered. Please find the details below.  Bounce Details: Bounced Address : someone@google.com Bounce Reason : other ; Status : 5.0.0 (undefined status) ; Daignostic-Code : smtp;542 someone@google.com Rejected ; Bounced Time : Sep 05, 2017 06:37 PM BST Regards, Zoho Team The email addresses were fine only a few days ago but are now being rejected ?

• PDF Generator Upgrade

  Hi Team, What will happen if I don't make any changes for existing template. Zoho just ask us upgrade but haven't tell the benefit. Zoho Corporation

• No Need To Fix Something That Is Working

  Zoho Books is a great financial tool which helps businesses to become more efficient and productive with day-to-day operations. As such, every change, upgrade, improvement needs to be carefully thought before implemented in the software and I'm sure Zoho

• Total Cost in reports showing zero

  The image below shows my issue. The column Total Cost should show the cost to our company based on hours logged and the employee's rate. For instance, if the person working on Subtask 1 is paid 20/hr, then Total Cost should display $160 ($20x8 logged

• Zoho Books (and other finance suite apps) - Retrospective Linking of Invoice and Sales Orders to Quotes.

  In some cases, Quotes and Invoies may be created sperately instead of using the convert feature. In this feature request I am asking for the Finance Suite team to consider adding a lookup field to reference the quote on Invoices and Sales Orders, or some

• Bring real app analytics into Zoho Creator apps with Zoho Apptics

  We’re kicking off the year with a release we’ve been looking forward to for a long time. After being in the works for a while, Zoho Creator and Zoho Apptics are now officially integrated, bringing in-depth product analytics directly into the Zoho Creator

• Early Access: Check Printing in Zoho Books

  Hello Everyone,   Are you constantly writing checks to pay your vendors?   We've got a great news to share with you! You can now pay your vendors by writing and printing a check directly from Zoho Books. The feature is ready and we'll be rolling it out to our customers in phases.  It is available in the  US Edition of Zoho Books and also in the Global edition, where the country is selected as USA and the currency is USD.   Here’s a summary of what’s possible:   1. Write and print a check. 2. Make

• ZohoMail's outbound webhook sends incorrect folderId and messageId

  I used a webhook (outbound) from within ZohoMail to send message details when a new message arrives that meets specific criteria. I received this data correctly. Now I want to get the attachment from this email message. When I made an api call using folder

• Use URL field to populate Image in a Email Template

  We have two records Record 1: Appointments (with a Lookup to Doctors module) Related Record 2: Doctors (with a URL field that is an image of the doctor) We would like to populate a CRM email template with the image of the URL field for the related doctor

• Looking for Guidance on Building a Zoho Website

  I'm exploring the possibility of building a custom website with specific features using Zoho as an alternative platform. My goal is to create something similar to https://gtasandresapk.com , with the same kind of functionality and user experience. I'd

• Ability to add VAT to Retainer Invoices

  Hello, I've had a telephone conversation a month ago with Dinesh on this topic and my request to allow for the addition of VAT on Retainer Invoices.  It's currently not possible to add VAT to Retainer Invoices and it was mutually agreed that there is absolutely no reason why there shouldn't be, especially as TAX LAW makes VAT mandatory on each invoice in Europe!   So basically, what i'm saying is that if you don't allow us to add VAT to Retainer Invoices, than the whole Retainer Invoices becomes

• Zoho Bookings Forge: A hands-on workshop series

  Hello all! We’re hosting a five-part, hands-on workshop series to help you optimize Zoho Bookings for your business. In these sessions, we’ll cover key features, practical use cases, and clear steps to get started or improve your current setup. Here are

• Introducing parent-child ticketing in Zoho Desk [Early access]

  Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-child

• Introducing Workqueue: your all-in-one view to manage daily work

  Hello all, We’re excited to introduce a major productivity boost to your CRM experience: Workqueue, a dynamic, all-in-one workspace that brings every important sales activity, approval, and follow-up right to your fingertips. What is Workqueue? Sales

• Delete button

  Hi, The delete button were hide into the three dot button. Can I display outside? why Zoho make this update?

• Zoho Vault CLI for Developers and Automations

  Hi everyone, If you're managing credentials in scripts, CI/CD pipelines, or automation workflows, Zoho Vault's Command Line Interface (CLI) can help you securely access and manage secrets directly from your terminal. Zoho Vault was launched in 2013 as

• Zoho Subscriptions -- Zoho Commerce integration

  Is there integration between Zoho Subscriptions and Zoho Commerce? I would like to create subscription plans in Zoho Subscritpions and list them for on my Zoho Commerce store.

• Synching changes to Stripe when changes are made in Zoho Billing

  We have a situation where we have merged customers in Zoho BIlling and then found out later that the payment in Stripe was not updated and still associated with the old customer record. The card gets updated and billed, but that payment is still associated

• How can I link Products in a Deal Subform to the Products Module

  Hello, I have a pricing subform on our Deals page and use a lookup field to associate a product with each line. I want to be able to look at a product page within the Products module and see a list of the deals connected to that product. I have this working

• Help Center and SEO: Any Benefit to My Domain-Mapped Website Ranking?

  First of, I love the Help Center which I've just decided to integrate into my website to replace its old-fashioned FAQs. So much more to achieve there now! Lots of new benefits to the site visitors and to me in terms of organizing and delivering all the

• Next Page