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






                    Zoho Campaigns Resources




                          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

                                                                                                            • How can I calculate the physical stock available for sale?

                                                                                                              Hey Zoho Team,  I've tried to calculate the physical stock on hand in various ways - but always receive a mismatch between what's displayed in Zoho Inventory & analytics.  Can you please let me know how the physical stock available for sale is calculated?

                                                                                                            • Set Custom Icon for Custom Modules in new Zoho CRM UI

                                                                                                            • Marketing Tip #4: Build your email list early

                                                                                                              Email marketing has one of the highest returns on investment. Don’t wait until later; start collecting subscribers now. When you've got their attention, you can send them emails about offers, new product launches, seasonal greetings, and more. Try this

                                                                                                            • Is anyone else having trouble saving a custom image in their email signature, or is it just me?

                                                                                                              When I try to save the image I get an error that says "Operation Failed" I opened a support ticket two weeks ago and received a response that it would be debugged, but it still isn’t working

                                                                                                            • Unify Overlapping Functionalities Across Zoho Products

                                                                                                              Hi Zoho One Team, We would like to raise a concern about the current overlap of core functionalities across various Zoho applications. While Zoho offers a rich suite of tools, many applications include similar or identical features—such as shift management,

                                                                                                            • Zoho Desk Domain mapping / Cloudflare CNAME not recognized

                                                                                                              Hello, my website is behind Cloudflare and SSL. From the Cloudflare control panel I added a CNAME record such as support.mydomain.com pointing to desk.cs.zohohost.com but I'm stuck with the message "Make sure you've mapped the CNAME entry..."

                                                                                                            • Create an Eye-Catching Announcement Widget for Your Help Center

                                                                                                              Hello Everyone! In this week’s edition, let’s explore how to keep your customers updated with exciting news in the Help Center. See how ZylkerMobile wowed their customers by bringing updates right to their portal. ZylkerMobile, the renowned brand for

                                                                                                            • I want to add my other zoho account in same pc

                                                                                                              why does zoho restrict me doing many things as i also want to add my second mail account bit its not allowing me to do that

                                                                                                            • Search in Zoho Community Not Working

                                                                                                              I realize this is a bit of a meta topic, but the search for the various Zoho Communities appears to not be working. I'm under the impression that they run on some version of the Zoho Desk platform, so I'm posting this here.

                                                                                                            • Capture Stripe’s Customer ID

                                                                                                              Does anyone know of a way to capture Stripe’s customer ID that is created when the form/payment is processed? I would like to have the customer ID stored in our CRM so we could utilize in some custom functions down the road.

                                                                                                            • Custom Modules - Where are Comments??

                                                                                                              In the standard ticket module and in the tasks module, we have an interactive comment box that we can post important details/notes and can tag others if needed. Where is this functionality for Custom Modules? Ideally, custom modules would have very similar,

                                                                                                            • Recover accidentally deleted mail account

                                                                                                              Email account was accidentally deleted from admin console. 

                                                                                                            • Zoho Mail will not set up in Thunderbird

                                                                                                              I am using Thunderbird 13.0.1 in Linux Mint 13 64-bit.  I cannot set up my Zoho IMAP email in this client.  This is evidently a common problem as evidenced by these postings in the Thunderbird forum: thunderbird can't seem to "find the settings" I cannot configure it for my zoho.com email account I can not get ZOHO to configure. Any suggestions? The best T-bird seems to be able to do is to refer these users to the Zoho forum. I believe the instructions in the Zoho help wiki are correct, although

                                                                                                            • Zoho ShowTime: Certificates of Completion - Award your learners with a sense of achievement

                                                                                                              In our increasingly competitive market, professional trainers need to differentiate themselves if they are to survive. One way to do this is to focus on innovation and deliver an ideal learning experience. By developing a renowned certificate program that provides learners with a specialized skill set for a particular industry, both trainees and future prospects will recognize the trainer's leadership in that field. This can help with long-term growth, revenue generation, and even marketing and branding.

                                                                                                            • IMAP Migration from Gmail

                                                                                                              I have been trying to import my email from a Gmail server and keep receiving the following error. I have reduced the security, activated imap and no improvement. The link to the Google support item has not helped. Unable to connect to your account. Please

                                                                                                            • Your Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts Click here to get unblocked.

                                                                                                              When entering my account, this error is thrown at me, and I deleted a good part of my deleted messages, but I still can not unblock it, I would appreciate your help. reservas@lineasperutravel.com

                                                                                                            • Request for Creating Multiple Email Accounts on One Mobile Number

                                                                                                              Dear Zoho Team, I am planning to shift all my work-related communication to Zoho Mail because of its reliability and features. For my work, I need to create 3–4 separate email accounts for different purposes. Could you please confirm if it is possible

                                                                                                            • Signature issue

                                                                                                              Problem: The signature does not appear when replying or forwarding an email. solve issue: settintgs/Signature Check option place a signature above the content with quotation marks

                                                                                                            • mail admin not loading

                                                                                                              i am trying to login to mailadmin ... gears keeps rotating forever... its not a password issue whats so ever ... not cookies issues whatsoever from android app i can login but there so few things to do from there .. i changed ip address the same... i

                                                                                                            • Unify All Zoho Video Meeting Experiences into One Standardized Platform

                                                                                                              Hi Zoho Team, We would like to share an important user experience concern regarding the current state of video meeting functionality across the Zoho ecosystem. The Problem Within Zoho, there are multiple ways to initiate or schedule a video meeting: Zoho

                                                                                                            • Changing Account in Quote form does not update address information.

                                                                                                              I am trying to update the address information in a quote I've created. I corrected the address in the "Account" but that did not change in the quote. If I re-enter the Account Name in the Quote form, nothing updates. How do I fix this?

                                                                                                            • Zoho One Backup of entire account

                                                                                                              Hello, When using Zoho one is there a way to backup your entire account of all apps that you are using \ activively using in a single step or do you have to backup each applications data individually? Thanks,

                                                                                                            • Issue with “CC” and “Subject Details” of the initial mail when reply / replied all / forward using Zoho Mail Client (Desktop / Web Mail / Mobile App)

                                                                                                              It is observed that when I reply / reply all / forward a mail using Zoho Mail Client (Desktop / Web Mail / Mobile App), the “CC” and “Subject Details” are omitted from the mail which was replied/forwarded. However this is not the case with outlook mail

                                                                                                            • Unable to send Emails - 452 4.3.1 Temporary System Error

                                                                                                              Whene ever i request smtp server to send the email (without attachment). i recieve error "452 4.3.1 Temporary System Error"

                                                                                                            • I can't receive email

                                                                                                              I cannot receive any email sent to my Zoho email after the free upgrade plan trial is finished.

                                                                                                            • Help for the alisa adding

                                                                                                              Sorry, I would like to add a paypal alias on my domain email address. However, the system blocked it. How can I do it?

                                                                                                            • Lite plan attachment said 250mb but actually 25mb ?

                                                                                                              Lite plan attachment said 250mb but actually 25mb ? I can't attach over 25mb files, and can't receive mails has attached files over 25mb too

                                                                                                            • Option to Customize Career Site URL Without “/jobs/Careers”

                                                                                                              Dear Zoho Recruit Team, I hope you are doing well. We would like to request an enhancement to the Career Site URL structure in Zoho Recruit. In the old version of the career site, our URL was simply: 👉 https://jobs.domain.com However, after moving to

                                                                                                            • Any update on much requested feature, to delete attachments without deleting the e-mail body?

                                                                                                              People have been requesting the ability to delete e-mail attachments without deleting the e-mail for more than ten years now. The latest I see is marked "Working On It" and a year ago it was supposedly being added, see here: https://help.zoho.com/portal/en/community/topic/is-there-a-way-to-delete-mail-attachments-without-deleting-the-text

                                                                                                            • Old vs New Value for Deleted Lookup Values

                                                                                                              Suppose the following scenario, where a value in a lookup is deleted: 1. User has countries form 2. Form A has a lookup to countries form 3. User selects Italy in Form A and saves it with the Italy ID 4. Form A report shows Italy 5. Italy is inadvertently

                                                                                                            • Zoho email using a python or html template

                                                                                                              # main.py import smtplib import csv from email.mime.text import MIMEText from email.mime.multipart import MIMEMultipart from config import SENDER_EMAIL, APP_PASSWORD, SMTP_SERVER, SMTP_PORT # email Subject email_subject = "🎉 Python + Zoho Mail HTML Email

                                                                                                            • Desktop app doesn't support notecards created on Android

                                                                                                              Hi, Does anybody have same problem? Some of last notecards created on Android app (v. 6.6) doesn't show in desktop app (v. 3.5.5). I see these note cards but whith they appear with exclamation mark in yellow triangle (see screenshot) and when I try to

                                                                                                            • customize payment page

                                                                                                              Is there a way to customize, other than the theme colour, the payment page that customers are taken to from invoices? I can't seem to find a way. I just don't like the formatting of the current page and would like to make it look better. I've looked at

                                                                                                            • Solution: How to send email using a python follow up this

                                                                                                              # Step One Setup Your App Password For this url {https://accounts.zoho.in/home#security/app_password} #How to genarate App password {https://help.zoho.com/portal/en/kb/bigin/channels/email/articles/generate-an-app-specific-password#To_generate_app_specific_password_for_Zoho_Mail}

                                                                                                            • Are Environments Worth It?

                                                                                                              In concept, Environments in ZC is a great idea. I think the flow is pretty smart when you compare it to GitHub, especially for a low code audience. However, in practice, I've found it to be unpredictable, and I've only used it a few times. Aside from

                                                                                                            • Enhanced duplicate check for Leads in CRM

                                                                                                              Hello Everyone, We are excited to announce that you can now check for duplicate entries in leads by comparing them with similar records in the Contacts Module. Previously, when you added a lead, only the converted leads were checked for duplicates. This

                                                                                                            • Pause(1);

                                                                                                              I'm using scheduler to invoke an interaction via http post with an external service. The schedule code uses a for-each loop that runs so fast my external application's log files get messed-up (they are named by date-time stamp). What I'm suggesting is

                                                                                                            • Integration Request: Elementor

                                                                                                              Integrating Zoho CRM forms with Elementor, the most popular page builder on Wordpress, would be great. I use it for our site, goenergylink.com, and I have had to use Zapier webhooks to be able to connect it with Elementor. The one issue I have run into

                                                                                                            • Ability to Change Visibility of Published YouTube Videos

                                                                                                              Hi Zoho Social Team, How are you? We would like to request an enhancement in Zoho Social regarding the management of already published youtube videos. Currently, after publishing a youtube video through Zoho Social, there is no option to change its visibility

                                                                                                            • Adding anchor links in Zoho CRM email templates

                                                                                                              I know you can add anchor link in Campaigns, but I dont see the option to that in the CRM email template. Am I missing something?

                                                                                                            • Next Page