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

    • Experience with Zoho Vertical Studio

      I'm considering Zoho Vertical and would love to hear from some devs who've been using it. The Zoho ecosystem is pretty solid, so I assume the experience has been pretty good, but sometimes Zoho has its quirks. Overall, has your experience been positive?

    • Rich text Merge field - Not using font specified in HTML

      I have a rich text merge field in a writer template which is creating a table. I have chosen to use this method instead of a repeat region because I need to specify specific cell background colours which change every time the document is created. The

    • Change text in help desk

      Hi, Please let me know how can i change the this text, see screenshot.

    • Advance PDF creation from CRM data

      I'm trying to create a PDF export of data in the CRM. My problem is I want a pretty complicated format for the data. I'm trying to export multiple modules worth of data, with nested one-to-many relationships between the modules. Along with that, I want

    • Setting default From address when replying to request

      At the moment, if I want to reply to a request, the From field has three options, company@zohosupport.com, support@company.zohosupport.com, and support@company.com.  The first two are really internal address that should never be seen by the customer and

    • Where does this report come from in the Zoho One ecosystems?

      Is this directly from MA, Analytics or ??? ???

    • Cliq iOS can't see shared screen

      Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards

    • Creating Restaurant Inventory Management on Zoho

      Hi,  We run a small cloud kitchen and are interested to use Zoho for Inventory and Composite Item tracking for our food served and supplied procured to make food items.  Our model is basically like subway where the customer can choose breads, veggies,

    • Sub-Form Padding in CSV Export

      Hi, When you use the Sub-Form, and for example you have a Date Field on the Main Page, then Option 1 and Option 2 fields on the Subform, when you export this to CSV the Date column will only have the Date in 1 row, the first row, it would be nice to pad

    • More Formula Functions

      Hi, I would ike for example to be able to have a Date Field and Formula Fields, and then in the Formula Fields I would like to grab just the Month of the above Date Field or the Week Number of the above Date Field. So more "Functions" than the current

    • Composite Services and Account Tracking

      I am looking to garner support/request the ability to make composite services. A quick search in the forums brings up multiple requests for this feature. I fail to see why an item is mandatory while services are optional. I also would like to see the

    • All operation codes getting Not applied in WO-TT22J1025WOR0471, SR-TT22J1025PRE0423,FOR VIN-W1K6G2AB2SL005130.

      Dear Support Team, Please refer attached screenshot. All operation codes getting not applied in work order. Request you to please check and update ASAP.

    • Transitioning to API Credits in Zoho Desk

      At Zoho Desk, we’re always looking for ways to help keep your business operations running smoothly. This includes empowering teams that rely on APIs for essential integrations, functions and extensions. We’ve reimagined how API usage is measured to give

    • Power of Automation::Streamline log hours to work hours upon task completion.

      Hello Everyone, A Custom Function is a user-written set of code to achieve a specific requirement. Set the required conditions needed as to when to trigger using the Workflow rules (be it Tasks / Project) and associate the custom function to it. Requirement:-

    • Customer Grouping

      Hi, how can I group multiple customers into single group. So that I can have idea of accounts receivables of all the customers in single group. Like if there are multiple subsidiaries of same company we have having a business with, and want to view the

    • Bank Receipt Catagorization

      Hi, how can I match a bank deposit to multiple customer's invoices ? For e.g. A single person paid to us on behalf of different five customers. I need to keep the separated invoices for each customer

    • "Performed changes in the query is not allowed due to following reason" when adding columns or reordering data

      I'm trying to make changes to a query but every time i try to save it i get this error message.  I'm not touching the data it's flagging.  All I've tried to do is reorder a couple of fields and add a new one.  Why won't it let me do this?  It's a core

    • Zoho Forms to Zoho CRM : First/Last Name to just Name ?

      When integrating a Zoho Form into the Accounts menu of the CRM I'm having trouble with how names are formatted ; In Forms the data is available as First Name or Last Name In the CRM there is only one field called Name How can I ensure that "John" "Smith"

    • multiple contacts for one account

      We currently use Zoho CRM where each Account represents a club or organization, and each Contact represents a manager or owner. However, some of our managers own or manage multiple clubs, and Zoho only allows a contact to be linked to one account at a

    • Exclude Segment from Campaign Recipients

      I've created two Segments in order to separate Non-Marketing Contacts from Marketing Contacts. I'd like to send an Eblast to all Marketing contacts in my lists, but when I go to select Recipients, I have two options: 1. To Choose Lists to Send to; 2.

    • Reschedule Multiple/Mass Calls at Once

      When we go into a Call record, we have the option to "Reschedule Call." How can we select multiple Calls at once from the Activities tab and Reschedule them? The big use case for us: We have many leads that our reps are supposed to call on a daily basis.

    • Option to Empty Entire Mailbox or Folder in Zoho Mail

      Hello Zoho Mail Team, How are you? We would like to request an enhancement to Zoho Mail that would allow administrators and users to quickly clear out entire folders or mailboxes, including shared mailboxes. Current Limitation: At present, Zoho Mail only

    • I want to Make the due date of the project appears automatically

      hello everyone I want to know if the zoho projects app can add automatically the END DATE of the project I added the duration, start after dates of each tasks in the project template & the starting date of the project itself and the end date of it doesn't

    • Drag 'n' Drop Fields to a Sub-Form and "Move Field To" Option

      Hi, I would like to be able to move fields from the Main Page to a Sub-Form or from a Sub-Form to either the Main Page or another Sub-Form. Today if you change the design you have to delete and recreate every field, not just move them. Would be nice to

    • Get Zoho Mail API working (including DRE Connector, Oauth Token, ZUID, ZOID & ACCOUNT_ID)

      Disclaimer: I’m not a professional coder! Do you need to use Zoho Mail API? Me too. It lets you do all sorts of things — like reading the complete header of an email, or forwarding an email with its attachments — which is what I wanted to do. But setting

    • Kaizen #129 : Client Script Support for Blueprints

      Hello everyone! Welcome to another week of Kaizen. Today, let us discuss about how you can use Client Script during a Blueprint transtion to meet your requirements. This Kaizen post will provide solution for the post - Need non-mandatory fields in blueprint

    • Deluge Tips & Tricks: Mastering dates and times

      Hello everyone! We're bringing back our Deluge Tips & Tricks series, where we show you how to make the most of Deluge for achieving a wide range of use cases. Working with dates and times is a fundamental part of almost any business application. Whether

    • Adding a Button in a Form in Zoho Creator App

      Hi I want to know how can I add a Button in Zoho Creator form. I have options that I select from a multiselect options and I want the button to add those selected options in a Subform. I do not want to add on a Page Builder I want it inside a specific

    • Internal Exception for Creator function

      I have been running a script successfully for several days using the scheduler in my application. Now today it suddenly creates and Internal Exception error. Nothing has changed about the script. The data is still retrievable from the web service it is using. Why would this suddenly be happening for no apparent reason? Also noticed that my usage logs are not up to date. Is something changing behind the scenes?

    • How to Set Up a Custom Domain and Customize Homepage

      Hello, I am experimenting with Zoho Creator to build applications for my own use case and have encountered a couple of issues: 1. Custom Domain Access: Is it possible to access my Zoho Creator application through a domain that I own? If so, how does the

    • Announcing new features in Trident for Mac (1.26.0)

      Hello everyone! Trident for macOS (v1.26.0) is here with new updates to securely manage your passwords, locally save your emails, and protect against emails with suspicious URLs. Let's take a quick look at them. Manage passwords with Zoho Vault eWidget.

    • Sub-Form Fields as Filters for Reports

      Hi, I would like to use the Sub-Form Fields as Filters in Reports just like we do for Main Page Fields. Thanks Dan

    • Cadence reports as front-end reports

      Hello everyone, We have built a cadence which is connected to the Leads module. There are 11 steps in total, 7 are automatic emails and 4 are tasks for the Lead owners. As admins, we have access to this (very nicely made) 'View Reports' tab where we can

    • Default Value on a Number

      Hi, I would be nice to also be able to set the Default Value for a Number Field, not just the Initial Value shown, so if not on the screen so not enetred it can have a value of 0 for example. Thanks Dan

    • Having trouble fetching contents of Zoho Connect Feeds using the API, requesting alternative API documentation.

      I'm trying to retrieve feed/post data from Zoho Connect using the API but facing challenges with the current documentation. What I've tried: OAuth authentication is working correctly (getting 200 OK responses) Tested multiple endpoints: /pulse/nativeapi/v2/feeds,

    • Tip#44: Custom Tags and Cluster Tags

      Tagging your work items helps categorize and label work items within your Zoho Sprints workspace. Now, this feature is expanded across multiple modules, along with the introduction of cluster tags that offer an advanced tagging mechanism. Manage Tags

    • CRM : Function to add user name to text field

      I have a lookup field in a module that is linked to the CRM users so we can assign a Project Lead to the customer. Sadly Zoho Marketing Automation doesn't sync Lookup fields so I need to extract information from the lookup to text fields: Lookup field

    • Extensions 101 webinar series: Build, integrate, and monetize with extensions

      Attention developers! Are you ready to take your extension development skills to the next level? We're excited to bring back the Extensions 101 webinar series with an expanded lineup of Zoho products and an introduction to more platform features. Last

    • When using "locations" in zoho books, can you keep the two locations totally separate from each other?

      I am looking to add a location but I don't want to intermingle the banking or other accounts. I want that to be like two separate independent branches that use different banking accounts, accounts payable, and accounts receivable. The people who are in

    • All new Address Field in Zoho CRM: maintain structured and accurate address inputs

      The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Managing addresses

    • Next Page