Kaizen #182 - Queries in Canvas List View

Hello everyone!

Welcome to another week of Kaizen!

​

We're back with another post in this series on Queries in Canvas List View.

Queries in Zoho CRM allow you to dynamically retrieve data from CRM as well as third-party services directly within the CRM platform.

You can construct a query of one of the following types:

1. CRM Module type query to retrieve data from CRM modules.
   
2. COQL type query to construct a query using the COQL API.
   
3. REST API type query to fetch data from an external service and use it in Zoho CRM.
   

You can associate a query with the 'Decision' component of Kiosk, Canvas Detail View, or Canvas List View.

In this post, we will take up a use case and see how you can associate a query with Canvas List View.

Use case

Sales and support teams often need quick access to Zoho Desk tickets related to a contact in Zoho CRM. To avoid switching between apps to check ticket statuses, we can use the Queries feature to fetch the latest Zoho Desk ticket's details of a contact dynamically and display them on the Canvas List View page of the Contacts module.

This ensures that CRM users can instantly view the most recent ticket linked to a contact without leaving Zoho CRM.

Follow along to see how you can achieve this!

Step 1 - Add a Source

1. Go to Setup > Developer Hub > Queries > Sources > Add Source.
   
2. Under Information,
   
1. Give a name for the source and its Base URL. Queries will make API calls to this URL to fetch data. Ensure to add this to Trusted Domain.
   
2. Specify any default parameters and headers for this base URL.
   
3. Under Connection, choose the connection you have created with Zoho Desk with the necessary scopes. If you haven't, create one.
   
4. Click Save.
   
   

Note

Queries will make API calls to the URL you add in the Source and consume credits that are applicable in that service. Ensure you monitor your API usage in your source provider.

Step 2 - Create a REST API Query

1. Go to Setup > Developer Hub > Queries > Add Query.
   
2. Under Source, choose the source you created in step 1.
   
3. Under Information,
   
1. Enter the Name, API Name, and the Endpoint of the query.
   
2. Specify the parameter email that takes the dynamic variable {{Contact_Email}} as its value. This is to fetch the latest ticket from Zoho Desk for a contact with the email in this variable during runtime. Refer to our Kaizen post on Handling Query Variables in Zoho CRM for additional details.
   
3. Specify Headers, if any.
   
4. You can serialize the output to fit your needs using JavaScript in the Serializer.
   
   
5. Click Next.
   
6. Enter an email address in the box to test the query.
   
   
7. Click Save. You can see the response of the query and the serialized response if you had serialized the output.
   
   
8. Click Next.
   
9. You can see the Schema of the query. The Schema acts as a bridge/mapping layer between external API responses and Zoho CRM's internal data structure. For example, the response of the Desk API returns result[].assignee.firstName, which is mapped to CRM as Assignee > FirstName. Schema ensures that the CRM UI knows how to display the field correctly.
   With the right mapping in the schema, you can avoid manual data entry or syncing, and use the API data in workflows, reports, and dashboards.
   You can change the CRM Field Type and Label to suit your needs. Refer to our Kaizen post on Serialization and Schema Management for more details.
10. Click Save to save the query.
    

Now that our query and fetching data from Zoho Desk is sorted, let's move on to the Canvas.

The Custom List view in Canvas enables you to stack records horizontally, one above the other.

Follow the steps in the How to Work with Canvas? guide to create a Custom List View Canvas for the Contacts module.

1. On the Canvas, click the database icon for the Queries component.
   
2. Click Associate Query.
   
3. Give an Association Name and select the Source(added in step 1) for the query.
   
4. Under Query, select the query you created.
   
5. The Variables section will contain the variables in the query. The drop-down displays all fields in the Contacts module. Select the Email field.
   
6. Under Result Mapping, choose Email as the Source Record Field and Contact > Email as the Query Response Path. The Query Response Path is populated from the schema of the query.
   
7. Click Done to associate the query with the canvas.
   
   
8. You can see all the fields of the query on the left. Drag and drop the required fields on the canvas.
   
   
9. Save the canvas.
   
   

Time for the big reveal!

The following GIF shows how the ticket details from Zoho Desk are populated on the Canvas List View of the Contacts module.

Note that every time you reload the canvas, the query underneath makes an API call to the source provider to fetch data for the contacts in Zoho CRM. Ensure your API calls are monitored to avoid exhasuting your credits.

We hope you liked this post.

​

Let us know your thoughts in the comments or write to us at support@zohocrm.com.

Topic suggestions are welcome! See you all next week!

Cheers!

----------------------------------------------------------------------------------------------------------------------------------------

See Also

• Queries in Zoho CRM
• Kaizen #166 - Handling Query Variables in Zoho CRM
• Kaizen #169 - Serialization and Schema Management in Queries
• Kaizen #172 - Leveraging the 'crmAPIResponse' object in Queries
• Kaizen Directory
• Previous Kaizen - Mandating Subform Data for Blueprint Transitions using Widget
  

• Topic Participants

• Shylaja S

  

• Sticky Posts

• Kaizen #217 - Actions APIs : Tasks

  Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.

• Kaizen #216 - Actions APIs : Email Notifications

  Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are

• Kaizen #152 - Client Script Support for the new Canvas Record Forms

  Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved

• Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

  Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.

• 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

• Recent Topics

• Zoho Live chat doesnt chat on CRM Contact page????

  We have used Salesforce Live Agent for the last 8 years and the chat comes in on the Contact record which is logical and intuitive as the chat agent can see the customers sales history and open opportunities...etc... We just migrated to Zoho CRM and I

• Image Quality Issue on Zoho Assist

  Hello, For the past two days, I've been experiencing a significant image quality issue on Zoho Assist when connecting to one of my computers. I’ve tried reinstalling the application, but the issue persists across multiple devices. The internet connection

• New views to manage activities within a record

  Dear customers, We hope you're well! Today, we're here with a useful update to the Activities related list. As you might be aware, parent records display related information from other modules as related lists. This helps you get a 360-degree view of

• Sent Mail not in "Sent" IMAP folder

  I have configured ZOHO to use IMAP. When I send an email from within Zoho, the email does not show up in my "Sent" IMAP folder. Every email client I have ever used, stores sent mails in the "Sent" folder. This is a serious flaw!  Please fix this ASAP! Oliver

• Admin Control for Subscribing Users to Bots in Zoho Cliq

  Hello, I would like to request an enhancement to Zoho Cliq, specifically related to subscribing users to bots. Current Issue: When using the Zoho Desk integration with Cliq, notifications such as Mentions, Happiness Ratings, and Pending Blueprint Transitions

• Eighth Insight - Oversee module relationships with Lookups

  The Wheels of Ticketing - Desk Stories Oversee module relationships with Lookups ‌Learning about lookups A lookup field provides a powerful way to display and utilize data from another module directly within a field of your current module. This functionality

• New capabilities for custom buttons: Elevate UX and CX with just a click!

  -------------------------------------------------Post moderated on 24th May-------------------------------------------------------------- Dear all, The feature is now available for all users in all DCs. Dear Customers, We hope you're well! We're happy

• Client Side Scripts for Meetings Module

  Will zoho please add client side scripting support to the meetings module? Our workflow requires most meeting details have a specific format to work with other software we have. So we rely on a custom function to auto fill certain things. We currently

• CRM APP

  So the crm can now have image uploads. Great for us doing site surveys and linking them to customers. Unfortunatley the crm app does not show the image fields.  Any ideas of must we create a form and then link that?

• Zia Summary for Account - What is its reach

  Hello! I've been working with the Zia summary feature and it's very useful. However, it seems to pull in notes and things directly "on" the Account. If I have a meeting or phone call and provided detailed summaries with the event associated to the account,

• Search a custom module record based on a date range

  Hi , I hope you can share some guidance. I need to look up a record from a custom module based on the Closing Date of a Deal (in the Deals module). Here’s the context: 1. I have a custom module that stores quarterly values (e.g., rates or thresholds).

• How do I associate an expense to multiple projects?

  How do I associate itemized expenses to multiple projects, like assigning each line to the respective project

• So what's the limit?

  Recently our team encountered an error popping out when sending a service report. Although the report was sent successfully to zoho desk but the site asset record isn't updated. We notice this error occur only when line items [subform record] exceeds

• Charge to add client users to a ZOHO Project?

  Is there a charge to add client users to access a zoho project portal?  An additional license charge or any other additional costs?  Thank You

• Zoho CRM Notifications API - Channel Expiry

  Has anyone built a reliable integration with CRM Notification API (https://www.zoho.com/crm/developer/docs/api/v8/notifications/overview.html)? Need to sync CRM data with my external system and prefer not to use CRM workflows which ist a nice low code

• Create Tasks in arbitrary Zoho Project triggered from CRM [Zoho CRM]

  Community, hello What I'm trying to do is to create a Zoho Project when a Deal is created in CRM and then to be able to add tasks to this Project also from Zoho CRM with the trigger (Blueprint/ Workflow). I succeeded in creating Project using Zoho Flow,

• job opening status is locked and and I cannot change it

  Dear Support I am using standard plan. The job opening status is locked and and I cannot change it.

• IDN domain

  Why I can't use my domain www.blažek.com I do not want use unfolded shape www.xn--blaek-wib.com in my mail. Can you help me please?

• Gmail - Error 553 Relaying Disallowed

  Hey Zoho, I have just set up my mail server and added a couple of email accounts. I've verified my domain and added the mx records with my registrar (namecheap.com) What I'm trying to do is to be able to send email from my domain through Gmail.  In Google

• Candidate status change

  I am trying to change candidate status from "interview scheduled" to "hired". Where do I do this at?

• How can I set up my contacts so that all users can have them on hand when they sign in?

  Hi.  For my business I would like to set up the Contacts so they are available for any user. 

• Sharing Knowledge Base articles across multiple departments

  It would be useful to share some Knowledge Base articles across multiple departments where they are applicable, rather than having to go into other departments to find the article you're looking for. For example. Our reception uses the 'Admin' desk whereas our IT guys use the 'Support' desk, however both divisions would find KB articles about our company intranet useful. Reception does not have access to the support desk, so cannot see articles created in the Support KB. Perhaps you could install

• Where do we manage tags?

  Where is the page where we can view all tags and manage them (like change a tag name to something else or merge tickets under a particular tag with another)?

• Custom Return Path - Host Name

  Hi there, I've successfully set up SPF/ DKIM for Marketing Automation, but struggling to complete the Custom Return Path. I'm settting up on Wix. What should the host name be for the CNAME record? In Zoho Help it just says: "type your host name (sub-domain

• How to send Messages to Leads/customers

  I’d like to inquire about the process for sending messages or follow-up communications to customers directly from Zoho CRM. Could you please guide me on the best way to do this—whether via email, SMS, or any integrated messaging feature? Additionally,

• Daily-rate for projects

  I am billing my client through daily billing rates; for Zoho Books projects, only hourly rates can be set up. Please enhance this. Thanks.

• Admin Console Email

  I can't remember the admin console email or password. How do I find that out?

• help me! the button "remove zoho ad" is not responding

  help me! the button "remove zoho ad" is not responding, kindly advice. please to check the follows : https://sitepreview-643549202.zohositescontent.com/previewsite https://sitebuilder-643549202.zohositescontent.com/builder thanks,best  regards

• Zoho Forms API

  Is there any way to get all form entry list using API? Looking forward to hear from you

• Free tier

  Does a completely free tier Zoho email still exists? If so why am I receiving email reminders that my account would expire in 2 days

• Disable "skip to content" in Help Center

  Our users used to be able to press the tab button to skip between fields when submitting a new ticket in the help center. Now it pulls up the "skip to content" button in the top left corner. I know this is an accessibility feature, but is there any way

• Mail Data Migration

  Hello Team, I have an issue with my organization mail data migration from Google to Zoho. We used Google Workspace before now but decided to change to Zoho to enjoy your service. I have successfully created an account and 1. Complete Domain verification

• Prompting email addresses when sending an email

  Hi, I was just wondering if it was possible to disable the prompt / suggestion of email addresses when you begin typing an email address into the TO or CC box? Some of the email addresses that are being suggested are people that no longer require the

• This is a HTML email and your email client software does not support HTML email!

  I have a small business, recently the email notification is coming like this to me, can anyone please help me? I am not so IT savvy -----=_NextPart_b4583c76c623900f59ad5b420c6da260 Content-Type: multipart/alternative; boundary="----=_NextPart_b4583c76c623900f59ad5b420c6da260_alt"

• How to insert a ZohoUser in a subform field?

  I am building an new external web app that uses the ZohoCRM REST API (v8) to push data to Zoho. How do I use the ZohoCRM REST API to insert ZohoUsers into a subform field? I've tried several approaches and none of them have worked - inserting the ID as

• Unable to receive emails

  Hello - I set up an email account for my domain. I can send emails but cannot receive them. I believe the issue might be with incorrect IMAP configuration (?) - but im not sure and cant find where this is on the platform. Im using Zoho hosting for the

• Zoho Account delete function

  Hello Zoho support team The issue is as follows: Step1: Created an account community@bisonenergy.net Step2: Deleted this account. Step3: Created the new group mail using the same mail address, but the data already exists. So I have to change the name

• help, 554 5.1.8 blocked

  got this blockade, i don't know why?

• Not Receiving Emails from Gmail, but Other Providers Work Fine

  Hello, I'm experiencing an issue where my Zoho Mail account does not receive any emails sent from Gmail addresses. However, I can successfully receive emails from other providers such as Hotmail and Yahoo. There are no problems with sending emails—I'm

• Basic String Search Not Possible in CRM Deluge – Feature Request or Workaround?

  Hi all, I’m trying to solve what should be a very basic automation task in Zoho CRM Deluge: Find the first 11-digit number anywhere in a string (specifically an email subject). In almost any programming language—even 1980s BASIC!—this is a trivial loop:

• Next Page