Introducing an easy way to access resources defined in the resources.json file

Introducing an easy way to access resources defined in the resources.json file

Dear Zoho Desk extension developers, 

We heard you; it is next to impossible to access the Zoho Desk resources created by an extension without knowing their unique values. For example, to access the fields created by an extension, you must know the ID or apiName of the field in the Zoho Desk organization. Without knowing either, it becomes challenging to access the information required. But worry not. We have now made it easy for you to retrieve resource details. 

We take pleasure in introducing a new capability intended to make extensions a bit more powerful and context-filled. This is the ability to include Zoho Desk resources, such as fields and webhooks, within your extensions. You can also access those resources through their unique identifiers, using Zoho Desk's module-specific REST APIs. 

(For detailed information on how to include Zoho Desk resources in an extension, refer to the Developer Guide.)

To support this functionality, we are introducing a new key called resourceName, which uniquely identifies resources created by extensions. Each resource you want to include in your extension must be specified in the resources.json file, and each resource must have a unique resourceName. 

The two resources that are currently supported in extensions are custom fields and webhooks. So, if you include these resources in your extension, make sure to specify a unique resourceName for each field/webhook you add. Just like all other resources, the resourceName key is also validated while packing the extension.  

Any new extension that you develop must contain the resourceName key if you choose to include Zoho Desk fields and webhook resources. As for older extensions, we have ensured backward compatibility to support the inclusion of resources. This backward compatibility will be supported only for 3 months, which is until January 9, 2020. Therefore, we request you to tweak the code of your extensions accordingly, before this date.

Here's a detailed overview of the resourceName key. 

How resourceName works
When you define a resourceName in the resources.json file, the ID and apiName (if available) of the resource are also mapped to it automatically. After this, you can use the ID and/or apiName (if available) in APIs related to the resource, as required.

You can also use the resourceName key to retrieve the ID or apiName of a resource.

Retrieving the ID and apiName of a resource
Using the resourceName value, you can retrieve the ID and apiName of a resource in one of the following ways:
  1. Through a merge field in the invoke API, or
  2. Using the client SDK

1. Through a merge field in the invoke API
In this method, you must specify the resourceName value in Zoho Desk's invoke API in the following format.
  1. {{resourceType.resourceName.id}} or {{resourceType.resourceName.apiName}}
Merge Field Details
  • resourceType should be fields or webhook, based on your use case.
  • id returns the fieldId or webhookId, based on the value in resourceType.
  • apiName returns the apiName of the resource. This key is applicable only to fields.
To get a clearer idea, refer to this example:
  1. var reqObj = {
  2. url: 'https://desk.zoho.com/api/v1/tickets/1000000017201',
  3. headers: {
  4. "Authorization": "Zoho-oauthtoken 1000.41a9b31ac5adaa187ba160e250a88551.15bd423103f52f4853c1bc7243b2085d",
  5.  "orgId": "15167075"
  6.  },
  7.  postBody: {
  8.   "cf": {
  9.   "{{fields.field1.apiName}}": "Testing"
  10.   }
  11.  },
  12.  data: {},
  13.  type: 'PATCH'
  14. }
The apiName of the resource is replaced when the invoke API call is made.

2. Using the client SDK
In this method, you must use the following syntax for retrieving resource details.
  1. ZOHODESK.get('extension.resource', {resourceName: "resourceName", resourceType: "resourceType"}).then(console.log).catch(console.log);
Sample Request
  1. ZOHODESK.get('extension.resource', {resourceName: "field1", resourceType: "fields"}).then(console.log).catch(console.log);
Sample Response
  1. {
  2.     "status": "success",
  3.     "extension.resource": {
  4.         "resourceName": "field1",
  5.         "id": "4000000020060",
  6.         "resourceType": "fields",
  7.         "apiName": "cf_counter"
  8.     }
  9. }
For instance, the following code snippet returns the list of fields in the ticket currently being accessed by the user.
  1. ZOHODESK.get('ticket.cf').then(console.log).catch(console.log);

Sample Response
  1. {
  2.     "status": "success",
  3.     "ticket.cf": {
  4.         "cf_counter": "12",
  5.         "cf_deal_id": "2288589490093"
  6.     }
  7. }


    Access your files securely from anywhere

        All-in-one knowledge management and training platform for your employees and customers.








                              Zoho Developer Community



                                  Bootcamp
                                  Community
                                  Pricing
                                  Webinars
                                  What's New
                                  Integrations
                                  Contact Support
                                  Contact Sales
                                    Zoho Survey Resources
                                      Features
                                      Survey Templates
                                      Integrations
                                      Community
                                      iOS Mobile Surveys
                                      Pricing
                                      Android Mobile Surveys
                                      Insurvey Blogs
                                      Insight Blogs
                                      Tips & Tricks





                                                  Latest Feature Updates

                                                    • Desk Community Learning Series


                                                    • Digest


                                                    • Functions


                                                    • Meetups


                                                    • Kbase


                                                    • Resources


                                                    • Glossary


                                                    • Desk Marketplace


                                                    • MVP Corner


                                                    • Word of the Day


                                                    • Ask the Experts




                                                        Zoho SalesIQ Resources


                                                              Manage your brands on social media
                                                              Access Zoho Social

                                                                Zoho Pagesense Resources


                                                                    Zoho TeamInbox Resources

                                                                      Zoho DataPrep Resources


                                                                        Zoho CRM Plus Resources

                                                                          Zoho Books Resources


                                                                            Zoho Subscriptions Resources

                                                                              Zoho Projects Resources


                                                                                Zoho Sprints Resources


                                                                                  Qntrl Resources


                                                                                    Zoho Creator Resources



                                                                                        Zoho CRM Resources

                                                                                        • CRM Community Learning Series

                                                                                          CRM Community Learning Series


                                                                                        • Kaizen

                                                                                          Kaizen

                                                                                        • Functions

                                                                                          Functions

                                                                                        • Meetups

                                                                                          Meetups

                                                                                        • Kbase

                                                                                          Kbase

                                                                                        • Resources

                                                                                          Resources

                                                                                        • Digest

                                                                                          Digest

                                                                                        • CRM Marketplace

                                                                                          CRM Marketplace

                                                                                        • MVP Corner

                                                                                          MVP Corner









                                                                                            Design. Discuss. Deliver.

                                                                                            Create visually engaging stories with Zoho Show.

                                                                                            Get Started Now


                                                                                              Zoho Show Resources

                                                                                                Zoho Writer

                                                                                                Get Started. Write Away!

                                                                                                Writer is a powerful online word processor, designed for collaborative work.

                                                                                                  Zoho CRM コンテンツ



                                                                                                    Nederlandse Hulpbronnen


                                                                                                        ご検討中の方




                                                                                                                • Recent Topics

                                                                                                                • Can a project be cloned?

                                                                                                                  Good afternoon, greetings. I would like to ask if it's possible to clone a project in Microsoft Project. I found a way to do it using templates, but I'm not sure if there's a direct way to clone a project. Thank you in advance for your attention, and

                                                                                                                • Timesheet Tasks in Zoho Books: associate to service item

                                                                                                                  How do we associate a service item to timesheet tasks in Zoho Books? For example: Joe spent 5 hours on project:task1 which is Service Item#1 (Income:Service1). When the invoice is issued thru the Project Invoice section, this is not available. When the

                                                                                                                • Task/Activity indicator in SalesPipeline overview has disappeared

                                                                                                                  I Just logged in my ZOHO CRM first 2026 checking my salespipeline overview , Every record card used to show an indication that there was an open task (Yellow if the expiry date was close, red if the expiry date was today and grey when it had expired).

                                                                                                                • Tip #56- Accessibility Controls in Zoho Assist: Hearing- 'Insider Insights'

                                                                                                                  As we begin the new year, it’s a great time to focus on making our tools more inclusive and accessible for everyone. Remote support often involves long hours in front of screens, varying lighting conditions, and users with diverse accessibility needs.

                                                                                                                • Zoho Desk Android app update: Table view for All Departments view, custom button

                                                                                                                  Hello everyone! In the latest version(v2.9.25) of the Zoho Desk Android app update, we have introduced Table view for the 'All Departments' view in the ticket module. We also have supported an option that allows tickets in the Table view to be sorted

                                                                                                                • What's New - December 2025 | Zoho Backstage

                                                                                                                  In December, Backstage introduced a focused set of updates that improve how you manage registrations, communicate with attendees, and track participation. These enhancements are designed to give organizers greater flexibility and clearer control across

                                                                                                                • Add multiple users to a task

                                                                                                                  When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesman

                                                                                                                • A Roundup of Zoho Sprints 2025

                                                                                                                • Sorting Custom Date in API isn't working w pagination limit

                                                                                                                  How can we sort a custom field with DATE using pagination? Starting at page=1 then moving to page=2 with a limit of 10 each, its all messed up and even shows some of the same records as page 1? https://www.zohoapis.com/crm/v2/INVOICE_MODULE/search?criteria=(FM_Contact_ID:equals:1234)&sort_by=Invoice_Date&sort_order=desc&per_page=10&page='

                                                                                                                • SAP Business One(B1) integration is now live in Zoho Flow

                                                                                                                  We’re excited to share that SAP Business One (B1) is now available in Zoho Flow! This means you can now build workflows that connect SAP B1 with other apps and automate routine processes without relying on custom code. Note: SAP Business One integration

                                                                                                                • Enhancement in Role and Profile mapping of agents in Sandbox

                                                                                                                  Hello everyone! We have brought in a modification in the way users are mapped to a particular role and profile in Sandbox. What has changed? When agents are copied from production to Sandbox: If a user's current role and profile is available in Sandbox,

                                                                                                                • The reason I switched away from Zoho Notebook

                                                                                                                  My main reason for switching to Zoho was driven by three core principles: moving away from US-based products, keeping my data within India as much as possible, and supporting Indian companies. With that intent, I’ve been actively de-Googling my digital

                                                                                                                • Decimal places settings for exchange rates

                                                                                                                  Hello, We are facing issues while matching vendor payments with banking feeds. As we often import products/services exchange rate comes into play. Currently, ZOHO allows only six digits for decimal places. We feel that conversions like JPY to INR require

                                                                                                                • Zoho removed ability to see all Scheduled Reports!

                                                                                                                  If you are not the owner of a scheduled report, Zoho recently removed the capability to see each scheduled report. As an admin who relies on seeing all scheduled reports being sent, this is a terrible update. Now I cannot see ANY scheduled reports...even the ones I am being sent!!  This should be a setting for admins to control.  This is a bad update.

                                                                                                                • Automate Backups

                                                                                                                  This is a feature request. Consider adding an auto backup feature. Where when you turn it on, it will auto backup on the 15-day schedule. For additional consideration, allow for the export of module data via API calls. Thank you for your consideration.

                                                                                                                • GCLID and Zoho Bookings

                                                                                                                  Is there anyway to embed a Zoho Bookings signup on a landing page and pass the GCLID information? More specifically, can this be done using auto-tagging and not manual tagging the GCLID? I know Zappier has an integration to do this but is there a better

                                                                                                                • Merge Items

                                                                                                                  Is there a work around for merging items? We currently have three names for one item, all have had a transaction associated so there is no deleting (just deactivating, which doesn't really help. It still appears so people are continuing to use it). I also can't assign inventory tracking to items used in past transactions, which I don't understand, this is an important feature moving forward.. It would be nice to merge into one item and be able to track inventory. Let me know if this is possible.

                                                                                                                • Create PO from an invoice

                                                                                                                  We are a hardware and software sales company which receives orders over the internet. We drop ship most of our products from a warehouse outside of our company. Our orders get sync'd into Zoho from our store via onesaas as invoices. It would be great

                                                                                                                • Blueprint or Validation Rules for Invoices in Zoho Books

                                                                                                                  Can I implement Blueprint or Validation Rules for Invoices in Zoho Books? Example, use case could be, Agent confirms from client that payment is done, but bank only syncs transactions tomorrow. in this case, Agent can update invoice status to done, and

                                                                                                                • Resetting auto-number on new year

                                                                                                                  Hi everyone! We have an auto-number with prefix "D{YYYY}-", it generates numbers like D2025-1, D2025-2, etc... How can we have it auto-reset at the beginning of the next year, so that it goes to D2026-1? Thanks!

                                                                                                                • The Social Wall: December 2025

                                                                                                                  Hello everyone! As we wrap up the final edition of the Social Wall for 2025, it’s the perfect time to look at what went live during December. QR code generator From paying for coffee to scanning metro tickets, QR codes are everywhere and have made everyday

                                                                                                                • Custom AI solutions with QuickML for Zoho CRM

                                                                                                                  Hello everyone, Earlier, we introduced Custom AI Solutions in CRM that let you access QuickML for your custom AI needs. Building on that foundation, we’ve now enabled a deeper integration: QuickML models can be seamlessly integrated into CRM, and surface

                                                                                                                • Helper Functions and DRY principle

                                                                                                                  Hello everyone, I believe Deluge should be able to use 'Helper functions' inside the main function. I know I can create different standalones, but this is not helpful and confusing. I don't want 10000 different standalones, and I dont want to have to

                                                                                                                • Introducing workflow automation for the Products module

                                                                                                                  Greetings, I hope all of you are doing well. We're happy to announce a few recent enhancements we've made to Bigin's Products module. The Products module in Bigin now supports Workflows, enabling you to automate routine actions. Along with this update,

                                                                                                                • Zia Formula Expression Generator for Formula fields

                                                                                                                  Hello everyone! Formula fields are super useful when you want your CRM to calculate things for you but writing the expression is where most people slow down. You know what you want, but you’re not fully sure which function to use, how the syntax should

                                                                                                                • Issue with Zoho Creator Form Full-Screen View in CRM Related List Integration

                                                                                                                  Hi Team, We have created a custom application in Zoho Creator and integrated it into Zoho CRM as a related list under the Vendor module, which we have renamed as Consignors. Within the Creator application, there is a form named “Pickup Request.” Inside

                                                                                                                • Wrapping up 2025 on a high note: CRM Release Highlights of the year

                                                                                                                  Dear Customers, 2025 was an eventful year for us at Zoho CRM. We’ve had releases of all sizes and impact, and we are excited to look back, break it down, and rediscover them with you! Before we rewind—we’d like to take a minute and sincerely thank you

                                                                                                                • Customer Parent Account or Sub-Customer Account

                                                                                                                  Some of clients as they have 50 to 300 branches, they required separate account statement with outlet name and number; which means we have to open new account for each branch individually. However, the main issue is that, when they make a payment, they

                                                                                                                • Restrict Users access to login into CRM?

                                                                                                                  I’m wanting my employees to be able to utilize the Zoho CRM Lookup field within Zoho Forms. For them to use lookup field in Zoho Forms it is my understanding that they need to be licensed for Forms and the CRM. However, I don’t want them to be able to

                                                                                                                • Unknown table or alias 'A1'

                                                                                                                  I would like to create a subquery but i am getting the following error: Unknown table or alias 'A1' used in select query. This is the sql statement:  SELECT A1.active_paying_customers, A1.active_trial_customers, A1.new_paying_signup, date(A1.date_active_customers), 

                                                                                                                • in the Zoho creator i have address field based the customer lookup im selecting the addresss , some times the customer address getting as null i want to show as blank

                                                                                                                  in the Zoho creator i have address field based the customer lookup im selecting the addresss , some times the customer address getting as null ,i want to show as blank instead of showing null. input.Billing_Address.address_line_1 = ifNUll(input.Customers_Name.Address.address_line_1,"");

                                                                                                                • Question about upgrade and storage space Zoho Notebook

                                                                                                                  After upgarding my Zoho Notebook plan, I am running into the following issue. I just upgraded from a free Zoho Notebook subscription to Pro Lite after I got a notification in my Window Zoho Notebook desktop app saying that I had run out of space. However,

                                                                                                                • Printing to a brother label maker

                                                                                                                  I see allot of really old unanswered posts asking how to print to a label maker from a zoho creator app. Has their been any progress on providing the capability to create a customized height & width page or print template or whatever to print labels?

                                                                                                                • Sync desktop folders instantly with WorkDrive TrueSync (Beta)

                                                                                                                  Keeping your important files backed up and accessible has never been easier! With WorkDrive desktop app (TrueSync), you can now automatically sync specific desktop folders to WorkDrive Web, ensuring seamless, real-time updates across devices. Important:

                                                                                                                • Track online, in-office, and client location meetings separately with the new meeting venue option

                                                                                                                  Hello everyone! We’re excited to announce meeting enhancements in Zoho CRM that bring more clarity and structure to how meetings are categorized. You can now specify the meeting venue to clearly indicate whether a meeting is being held online, at the

                                                                                                                • Announcing new features in Trident for Mac (1.32.0)

                                                                                                                  Hello everyone! We’re excited to introduce the latest updates to Trident, which are designed to reinforce email security and protect your inbox from evolving threats. Let’s take a quick look at what’s new. Deliver quarantined emails. Organization admins

                                                                                                                • Marketing Tip #5: Improve store speed with optimized images

                                                                                                                  Slow-loading websites can turn visitors away. One of the biggest culprits? Large, uncompressed images. By optimizing your images, your store loads faster and creates a smoother shopping experience leading to higher sales. It also indirectly improves SEO.

                                                                                                                • SMS to customers from within Bigin

                                                                                                                  Hi All, Is there anyone else crying out for Bigin SMS capability to send an SMS to customers directly from the Bigin interface? We have inbuilt telephony already with call recordings which works well. What's lacking is the ability to send and receive

                                                                                                                • Admins cannot see each others' Scheduled Reports?!

                                                                                                                  Very frustrating that as an admin I cannot see what my reports my fellow admins have created and scheduled.  After asking about this on the help chat, I was told the issue is trust and security.  By giving someone Admin status, it means we trust them with those responsibilities. Please change this, it is not a good process to have to bother other users to change a report or change users within a report.

                                                                                                                • Writer update results in BitDefender blocking it as malware

                                                                                                                  After updating Writer to latest update, Bitdefender blocked the app and writer no longer runs.

                                                                                                                • Next Page