Simplify Zoho API integration with Deluge’s invokeAPI task

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:
Quote
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). 
Quote
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 Deluge Team

    • Sticky Posts

    • Function #41: Sync Associated Subforms!

      Welcome back everyone! The last custom function showed how to update a Contact with Product details from it's Related list in Deals. This week, let's look at a function that lets you update subform records in two modules simultaneously when one of them is updated. Business scenario Let's look at how subform helps in an education institution that has deployed Zoho CRM. National Public School, Austin (made up, of course!) has set up Zoho CRM and it follows the same relationship pattern of "Students",

    • Recent Topics

    • Tracking Non-Inventory Items

      We have several business locations and currently use zoho inventory to track retail items (sales and purchase orders). We were hoping to use zoho inventory to track our non-inventory items as well (toilet paper, paper towels, etc). I understand that we

    • Price Managment

      I have been in discussions with Zoho for some time and not getting what I need. Maybe someone can help explain the logic behind this for me as I fail to understand. When creating an item, you input a sales rate and purchase rate. These rates are just

    • Set Warehouse based on Vendor

      Greetings. I would like to set automaticaly the Warehouse based on the Vendor. Context: I am working on an adaptation of a Purchase Order to be used as a Quotation. I have defined that when a user has to raise a quote the Vendor will be "PROCUREMENT" I would like to set the Warehouse to a predefined value when "PROCUREMENT" is set as Vendor. I have tried to do with the Automation feature using the Field Update option, but Warehouse does not is listed as a field. Can you help? Thanks in advance.

    • How to add interviews through API

      I'm trying to add an interview without much luck. The documentation gives examples of adding just about everything except an interview. However, the issue might be the way I'm formatting it, because the documentation is unclear to me. It seems as if the xml should be passed in the url, which seems unusual. I've tried the data as both plain and character escaped, but nothing seems to work, nor do I even get an error response. https://recruit.zoho.com/recruit/private/xml/Interviews/addRecords?authtoken=***&scope=recruitapi&version=2&xmlData=<Interviews> <row

    • Deprecation of the Zoho OAuth connector

      Hello everyone, At Zoho, we continuously evaluate our integrations to ensure they meet the highest standards of security, reliability, and compliance. As part of these ongoing efforts, we've made the decision to deprecate the Zoho OAuth default connector

    • Auto tagging

      Some of the articles I enter into Notebook get there when I enter them in Raindrop.io and IFTTT copies the articles in Notebook. When this happens the notes are tagged but instead of useful one word tags with topic the tag pertains to the specific article

    • Work Order wont mark as Completed

      I have a couple of work orders that won't mark as completed even when I've marked the Service Appointments as completed fully.

    • Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

      Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the

    • How do I save audio files to my PC that I record into Zoho Notebook from my phone?

      I was thinking of using Zoho Notebook as a way to store composition ideas, as well as for other things if it can handle this. For this to be useful for me though, I need to be able to have an easy way to download those audio files to my PC, either individually

    • Introducing Radio Buttons and Numeric Range Sliders in Zoho CRM

      Release update: Currently out for CN, JP, AU and CA DCs (Free and standard editions). For other DCs, this will be released by mid-March. Hello everyone, We are pleased to share with you that Zoho CRM's Layout Editor now includes two new field formats—

    • How to filter subform report based upon main form report in dashboard

      Hi Team, I am creating a dashboard in Zoho Analytics. I want to have a main form report and below I want to show subform report of main form. If I filter the main form with date then I want to show subform records based upon main form. how can I achieve

    • Search mails in shared mailbox

      Hi everyone, is there a way to search mails in shared mailbox's? Search in streams or mail doesn't return anything from mails in shared mailboxes. Thanks! Rafal

    • Zoho CRM for Everyone's NextGen UI Gets an Upgrade

      Hello Everyone We've made improvements to Zoho CRM for Everyone's Nextgen UI. These changes are the result of valuable feedback from you where we’ve focused on improving usability, providing wider screen space, and making navigation smoother so everything

    • Kaizen #186 : Client Script Support for Subforms

      Hello everyone! Welcome back to another exciting Kaizen post on Client Script! In this edition, we’re taking a closer look at Client Script Support for Subforms with the help of the following scenario. " Zylker, a manufacturing company, uses the "Orders"

    • Change eMail Template for Event-Invitations

      Hello ZOHO-CRM Team How I can change the eMail Template for Event-Invitations? I work with the German Version of the Free Version. I know how I can modify eMail alerts or Signature Templates, but where I can other eMails modify you send out? Thank you for your answer. Regards, Juerg

    • Changes to the send mail Deluge task in Zoho CRM

      Hello everyone, At Zoho, we continuously enhance our security measures to ensure a safer experience for all users. As part of our ongoing security enhancements, we're making an important update on using the send mail Deluge task in Zoho CRM. What's changing?

    • Fail to send Email by deluge

      Hi， today I gonna update some email include details in deluge, while this msg pops up and restrict me to save but my rules has run for one year. can you tell me how to use one of our admin account or super admin account to send the email? I tried to update

    • Writing SQL Queries - After Comma Auto Suggesting Column

      When writing SQL Queries, does anyone else get super annoyed that after you type a comma and try to return to a new line it is automatically suggest a new column, so hitting return just inputs this suggested column instead of going to a new line? Anyone

    • Introducing Multiple Sandbox Types and Support for Module's Data Population

      Register here for the upcoming Focus Group webinar on Multiple Sandbox | Help documentation to learn more about the new enhancements Hello everyone,  Sandbox in CRM is a testing environment for users to create and test new configurations like workflow

    • Is It Possible to Convert a Custom Module to a Quote?

      I recently created a custom module in our CRM environment for RFQs so that our sales team can submit quote requests directly in Zoho rather than by email/phone. This allows for a cleaner overall process, minimizing potential errors and potentially encouraging

    • Convert invoice from zoho to xml with all details

      How to convert an Invoice to XML format with all details

    • Importing into the 'file upload' field

      Can you import attachments into the file upload field. I would expect it to work the same way as attachments do, But can't seem to get it to work.

    • Sync your Products Module for better context.

      In customer support, context is everything. The integration between Zoho Desk and Zoho CRM helps your sales and support teams function as one, delivering better customer experiences. With the latest update to this integration, you can now sync the Product module in your Zoho CRM with your Zoho Desk portal. This feature enables products from Zoho CRM to reflect in the "product" field in Zoho Desk. This can save your support team valuable time and effort.    Some things to note when syncing the two:

    • Where is the desktop app for Zoho Projects???

      As a project manager, I need a desktop app for the projects I manage. Yes, there's the web app, which is AWESOME for cross browser and platform compatibility... but I need a real desktop app for Projects that allow me to enter offline information where

    • Automating CRM backup storage?

      Hi there, We've recently set up automatic backups for our Zoho CRM account. We were hoping that the backup functionality would not require any manual work on our end, but it seems that we are always required to download the backups ourselves, store them,

    • CRM verify details pop-up

      Was there a UI change recently that involves the Verify Details pop-up when changing the Stage of a Deal to certain things? I can't for the life of me find a workflow or function, blueprint, validation rule, layout rule ect that would randomly make it

    • Does Zoho Writer have Dropdowns

      I want to add a drop down field in Zoho writer. Is this possible?

    • Custom Button to convert a Deal to a Custom Module?

      Hello Community I am in process of building out a custom CRM for my team and part of this is looking at building out a Custom Button or function of some sort where when a Deal is marked Closed Won the system will allow for a "Convert to Job" option to

    • How can Data Enrichment be automatically triggered when a new Lead is created in Zoho CRM?

      Hi, I have a pipeline where a Lead is created automatically through the Zoho API and I've been trying to look for a way to automatically apply Data Enrichment on this created lead. 1) I did not find any way to do this through the Zoho API; it seems like

    • Transitions do not update fields until the record moves to next stage

      We have a blueprint where a couple of stages have multiple transitions. If only some of the transitions are completed, but not all, Zoho does not update any of the fields impacted by the completed transitions. Is there any way Zoho can udate the fields

    • Blueprint enhancements - Parallel and multiple transitions, and more

      Last modified on Sep 4, 2023: All Zoho CRM users can now access these enhancements. Initially, these features were available only on an early access basis and by request. However, as of August 2, 2023, they have been made available to all users in all

    • Optimum CRM setup for new B2B business

      Can some advise the most common way to setup Zoho CRM to handle sales for a B2B company? Specifically in how to handle inbound/outbound emails. I have spent hours researching online and can't seem to find an accepted approach, or even a tutorial. I have

    • using the Client script on the load of the form if service no is empty means then i want to make issue relate to is Service

      using the Client script on the load of the form if service no is empty means then i want to make issue relate to field is Service if Purchae no is empty means then i want to make issue relate to is Purchase

    • Multiple header in the quote table???

      Hello, Is it possible in Zoho CRM to add multiple headers or sections within the Quote product table, so that when the quote is printed it shows separate sections (for example “Products” and “Services”)? To clarify, I’m asking because: This does not appear

    • using the Client script I want to Hide Show the Fields

      if Related to service means some of the field like service no want to shoe and hide Amc no , purchase no how i achive this let issu = ZDK.Page.getField('Issue_Related_To').getValue(); if (issu == 'Service') { var field_obj = ZDK.Page.getField('Warranty_Cases');

    • openUrl in blueprints

      My customer wants to open a URL at the end of a blueprint transition. Seems this isn't possible right now but it would be very useful. In this thread, https://help.zoho.com/portal/en/community/topic/openurl-not-working the Zoho agent said that it's logically

    • Dropshipping Address - Does Not Show on Invoice Correctly

      When a dropshipping address is used for a customer, the correct ship-to address does not seem to show on the Invoice. It shows correctly on the Sales Order, Shipment Order, and Package, just not the Invoice. This is a problem, because the company being

    • Prepayment of a sales order

      How does everyone handle this common (at least it is common for us!) situation? We require all our orders to be fully prepaid before shipment since we manufacture made to order, custom products. Since ZOHO does not allow a sales order to be prepaid, we are forced to create an invoice at the time an order is placed to allow the customer to pay it. Our sales category is therefore skewed, since the sale was actually booked at the time an order was placed, rather then at the time it is shipped, which

    • Access to Specific Zoho Desk layout for external parties

      Hi, We have a partner who handles for us sales requests from specific markets. He is not a Zoho Desk user. But we want him to b part of a specific Zoho Desk layout to handle inquiries.  How to achieve it in the easiest way possible?

    • Deposit on a Sales Order

      Good day, 100% of my business is preorders, no inventory. I am trying to run away from QB for one of my businesses, but I require two options that I don't seem to find with Zoho Books. 1 - If there is a way to apply a deposit on a sales order, as with

    • Next Page