Kaizen #132 - Manipulating Subforms from third-party Application using Functions
Hey folks! Welcome to a fresh week of Kaizen.
In this post, we will see how to work with subforms and external fields in a module through CRM functions.
Consider a scenario where a High School utilizes Zoho CRM to manage student records, academic performance, and offered courses. Additionally, the school employs an Exam portal for students to take examinations. After the examination, the portal sends the mark information back to Zoho CRM along with it's own course id, student id, marks & other details.
Problem Statement
When the exam portal initiates a webhook call to CRM, the high school management wants to capture that data and update the CRM subform records accordingly. This subform should act as a semester progress report for each student.
Solution Overview
To address this requirement, a custom function must be implemented. The webhook URL will be the API REST URL of the custom function in Zoho CRM. Upon receiving the notification, the function is triggered, and the details from the notification are used to manipulate the subform.
Let us walk through this process of triggering functions using a webhook to manipulate subforms.
Let us walk through this process of triggering functions using a webhook to manipulate subforms.
Prerequisites
From the Third-Party Application
- We assume that a webhook will be triggered from the third-party application when the exam is over and evaluated by the teacher. The webhook will carry the following information:
Field | Data Type | Description |
Exam Name | String | Name of the examination that the student attends. |
Student ID | Long String | Unique ID of the student within the Portal App. |
Course ID | Long String | Unique ID of the course within the Portal App. |
Marks | Integer | Total marks of the student in the particular course. |
Total Time | Integer | Time taken by the student to complete the exam. |
- The webhook URL should correspond to the API REST URL of the custom function in Zoho CRM.
From Zoho CRM
Here is a data model image of the CRM modules involved in this scenario for your ease of understanding.
The Courses, Students and Student Exams modules are assumed to be pre-loaded with records. Following are the module wise fields that are expected to be already configured in the school's CRM org.
Courses and Students Modules
External fields named Student Code in the Students module and Course Code in the Courses module are used to match the IDs deployed in the third-party application.
Note
External fields can be updated only using the Update Records API.
Student Exams Module
Following are the custom fields that we assume to be already available in the Student Exams module.
Field Name | Data Type | Description |
Student | Lookup | The field looks up to the Students module. |
Total Marks | Integer (Formula) | A subform aggregate field that sums up the values of the Marks field in the Student Performance subform. |
GPA | Integer (Formula) | Calculates the GPA of a student in that particular examination. |
Exam Name | String (Picklist) | List downs the examinations that are planned to be conducted for the academic year. |
Student Performance Subform
A subform named Student Performance within the Student Exams module, comprising the following fields.
Field Name | Data Type | Description |
Course | Lookup | Represents the course name and it looks up to one of the courses from the Courses module. |
Total Time | Integer | Time taken by the student to complete the exam. |
Marks | Integer | Marks of the student in the particular course. |
Grade | String (Formula) | Grading system is infused as formula and it works depending on the value in the Marks field. |
The subform is assumed to be empty and will be updated only on receiving a webhook notification from the Portal App.
Note
Make a Modules Metadata API call to get the API names of the modules and the subform. Next, fire the GET Fields API call to get the API names of the fields. We will need them in crafting the custom function.
Creating the Custom Function
Step 1: Navigate to the Setup > Developer Hub > Functions and click the New Function button.
Now, create a Standalone function by filling in the details.
Flow of the Function
Argument Setup
Define function arguments to receive details from the function as shown here:
Data Retrieval
Invoke the COQL API within the function to retrieve the necessary records from the Student Exams and Courses module.
student_examMap = Map(); student_examMap.put("select_query","select id from Student_Exams where Student.Student_Code =" + student_id + " and Exam_Name=" + exam_name + " limit 1"); exam_response = invokeurl [ type :POST parameters:student_examMap.toString() connection:"crm_oauth_connection" ]; exam_id = exam_response.getJSON("data").get(0).get("id"); |
Here, the query is structured to retrieve the ID of the Student Exam record where the Student lookup field corresponds to the record with the Student Code matching the student_id in the notification, and the Exam Name picklist field matches the value of exam_name from the notification.
Note: You can use only =, !=, in and not in operators for querying External fields in Zoho CRM.
courseMap = Map(); courseMap.put("select_query","select id from Courses where Course_Code =" + course_id + " limit 1"); course_response = invokeurl [ type :POST parameters:courseMap.toString() connection:"crm_oauth_connection" ]; course_id = course_response.getJSON("data").get(0).get("id"); |
In this COQL call, the query fetches the ID of the record from the Courses module whose Course Code field matches the course_id received in the notification.
Subform Update Handling
The custom function should address the following three cases inorder to effectively manipulate the subform data from the third-party application.
- Every webhook call from the Exam portal should be added as a new entry to the subform.
- If entries already exist in the subform, the function should perform PATCH operation.
- Before executing the PATCH operation, it is crucial to check whether the webhook call is for a new course or an update to the existing course. In such cases, the function should refrain from adding the course; instead, it should update the corresponding entry.
To append new entries to the subform, you can use the UPDATE Records API. Refer to this kaizen to learn more about manipulating subforms using Zoho CRM APIs.
Student Performance is a module created for the subform configured in the Student Exams module. In order to perform the PATCH operation with an Update API, make a COQL API call to the Student Performance module and fetch the existing data, if any.
subform_examMap = Map(); subform_examMap.put("select_query","select Course, Total_Time, Marks from Student_Performance where Parent_Id.id =" + exam_id); subform_response = invokeurl [ type :POST parameters:subform_examMap.toString() connection:"crm_oauth_connection" ]; |
This query retrieves the exam records of the student for that particular exam in Student Exams module, from the Student Performance subform. The subform should correspond to the parent record that matches the notification data. Since we already have the ID of that parent record from one of the previous COQL call, we have directly used the response in this query.
Now that we have the existing subform data, the function has to verify whether the data from webhook call matches any of the Course in the subform data. If it matches, the new entry replaces the existing one; otherwise, the new entry is added to the existing entries and forms a request payload called examinfo. This payload will be used in the later part of the functions to update the record in Student Exams module.
Following is how you should achieve this using for-each loop.
final_subform = List(); flag = true; if(!isBlank(subform_response)) { subform_data = subform_response.getJSON("data").toList(); if(subform_data.len() > 0) { for each data in subform_data { if(data.get("Course").get("id") == course_id) { final_subform.add({"Course":{"id":course_id},"Total_Time":time_taken,"Marks":marks}); flag = false; } else { final_subform.add(data); } } } } if(flag || isBlank(subform_response)) { final_subform.add({"Course":{"id":course_id},"Total_Time":time_taken,"Marks":marks}); } examinfo = {"Student_Performance":final_subform}; |
Next, let us update the Student Performance subform in the Student Exams module using the pre-defined integration task called Update Record in Zoho CRM functions. This task makes an Update Records API call to replace all entries within the subform. It updates the entries with the same course_id provided in the notification, inserts new entries and removes old entries accordingly.
response = zoho.crm.updateRecord("Student_Exams",exam_id,examinfo); return "nothing"; |
Save the function and click the more icon of the function you have created and choose REST API.
Enable the OAuth2 and API Key for the function.
Next copy the API key and provide it in the webhook URL of the Portal App.
On receiving notifications to this URL the function will be triggered and the records will be updated.
We believe you found this post both beneficial and informative!
Your thoughts and perspectives matter to us. If there is a topic you would like us to delve into or if you have any questions, please feel free to drop a comment below or send us an email at support@zohocrm.com.
Stay tuned until we circle back to you on next Friday!
--------------------------------------------------------------------------------------------------------
Recommended Reads
- External IDs - An Overview
- Formula Fields - An Overview
- Subforms - Overview and guide to build a subform, Kaizen #31, Kaizen #124
- Metadata APIs - GET Modules, GET Fields
- REST APIs - Update Records API
- Query API - An Overview, Records through COQL Query, Kaizen #80 , Kaizen #81 , Limitations
- Functions - An Overview
- Deluge - An Introduction
---------------------------------------------------------------------------------------------------------
Previous Post : Kaizen #131 - Bulk Write for parent-child records using Scala SDK | Kaizen Collection: Home
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Kiruthiga G
Sticky Posts
Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox 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
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Email Authentication is Failing
I'm trying to setup gitlab with email authentication. I used the following configs picked up from: https://docs.gitlab.com/omnibus/settings/smtp/ gitlab_rails['smtp_enable'] = true gitlab_rails['smtp_address'] = "smtp.zoho.com" gitlab_rails['smtp_port']DMARC reports for mail I didn't send: how to deal with?
I know the enthusiastic amateur's bare minimum about e-mail; am able to set up a Thunderbird account and know the basic acronyms. I have a Zoho Mail account connected to my domain, and have set up SPF, DMARC and DKIM successfully according to Zoho's instructionms
Email set up for communicationFix the speed
It takes ages to load on every step even though my dataset is quite small.Image field in custom module
Hi guy, Is there any hope of adding a custom image field in the custom module? We created a custom module to keep track of assets, and it would be helpful if we could attach an image to the record. Thanks RudyDeluge Function to Update Custom Field
I'm trying to get a Deluge function (which will run as part of a Schedule in Desk) that retrieves all tickets with the status "Recurring" and updates the custom field checkbox "cf_recurring" to "true". Here's what I have, which doesn't work: searchValue"View ticket" link is broken
The "View ticket" link in our Zoho ticketing system confirmation emails is broken (please see attached). Impacts ability to update/review details, and, refresh recollection at a later date. Any help would be much appreciated.Can't Figure out Books and level 2 payment data
Hello, I am having trouble figuring out how to collect level 2 payment data as required by my payment gateway. Last month it cost us almost $5000 in fees because of this. We are invoicing our clients with books and they pay through the link in that emailimport data from Apollo.ai into zoho crm via zoho flow
I might be asking this question in the wrong forum. We use Apollo.ai to find potential new leads for our business, there are around 10000 leads that we have initially found. We have an Apollo.ai account but just to do searches, we dont use it as a crm.Woocommerce Line Item Information
I'd like to add each line item from a Woocommerce order to a zoho creator form record. The line items are found within the line items array, but I'm not sure how to get each item out of the array? Any help would be much appreciated.How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.
How do I fix this? Unable to send message; Reason:554 5.1.8 Email Outgoing Blocked.Disable Smart Filters By Default
The smart filters "feature" is causing confusion for Zoho Mail users. New emails should be delivered to the inbox unless they have specifically opted to redirect them somewhere else. People don't understand that new emails might be waiting in a randomME SALE ESTE ERROR: No fue posible enviar el mensaje;Motivo:554 5.1.8 Email Outgoing Blocked
Ayuda!! Me sale este error al intentar enviar mensajes desde mi correo electronico de Zoho! Tampoco recibo correos pues cuando me envia rebotan. Ayuda, Me urge enviar unos correo importantes!! Quedo atenta MAGDA HERNANDEZ +5731120888408Zoho Mail not working
Zoho Mail not workingSpreadsheet View click & focus issue in Arabic (RTL) localization
Hello Zoho Support Team, I am facing an issue in Zoho Creator Spreadsheet View when using Arabic localization (RTL). Scenario: My app supports English (LTR) and Arabic (RTL). I created a Spreadsheet View for a form. In English, everything works correctly.Ghost email notification on a form
Hello, We have recently encountered an error where I can not see a email notification set up for a form which I am currently the owner, although neither the form nor the notification were created by me. However, neither can the Super Admin access thebulk edit records and run internal logic
hi there is few logics in manner "it this than that" logics work well when i edit entry openning it one by one (via workflow "on add/edit - on success" , for custom field "on update/on user input") but when i try bulk edit records - logic does not work. how can i turn on logic to work as programmed - for mass editing records via bulk edit?Limitations on editing a message in Cliq
Hi I've checked the documentations and there's no mention of how many times a message can be edited. When trying with code, I get various numbers such as ~1000 edits or so. Please mention if there's a limit on how many times one can change a message viaemail address autocomplete
Is there a way to eliminate certain addresses from showing up in auto complete when entering an address? Many old and unused addresses currently show up, many of which I would like to get rid of. ThanksHow to use MAIL without Dashboard?
Whenever I open Mail, it opens Dashboard. This makes Mail area very small and also I cannot manage Folders (like delete/rename) etc. I want to know if there is any way to open only Mail apps and not the Dashboard.How can i download and secure all my mails from the archive folders?
Hi, i would like to download all my mails from my archive folders and secure it on my external HDD. Is this possible? Thx. amirHow to open filtered report in popup using Zoho Creator Deluge?
First report: There is so many records in Report, If I click one record, pop up is occur. Second report (Pop up): there is also so many record data, and this pop up is also Report, not Form. First report: It has got "Sales Order" field. when I click anyCan you default reports/charts to report the current week?
Our data table maintains two years of data. Management wants certain report to automatically filter the report to the latest calendar week. I know I can do this manually with filters but I want the report to automatically default to the latest calendarRendering PDF to view on page
My company upload lots of PDF files onto Zoho. But every time we open it, it downloads the file instead of viewing it on the web page. Does Zoho allow uploaded PDF files to be rendered to view on web page yet? I've been trying to use <embed> or <object> but it cannot be loaded. (similar thread: https://help.zoho.com/portal/community/topic/how-to-open-a-pdf-file-of-a-view-in-preview-mode)Overlapping Reports in Dashboards
It's rare, but occasionally it would be a good feature if I were able to overlap reports, either fully or partially in the Dashboards. Also, then having the ability to move objects to the front or rear, or make them transparent/translucent would be goodFeature request - pin or flag note
Hi, It would be great if you could either pin or flag one or more notes so that they remain visible when there are a bunch of notes and some get hidden in the list. Sometimes you are looking for a particular name that gets lost in a bunch of less importantAdmin guide: Handling Mailbox Settings for better user management
Managing day-to-day email scenarios, such as supporting users with multiple email addresses, ensuring uninterrupted email access during employee absences, enabling secure mailbox sharing, and enforcing organizational security and compliance, can be challengingCisco Webex Calling Intergration
Hi Guys, Our organisation is looking at a move from Salesforce to Zoho. We have found there is no support for Cisco Webex Calling however? Is there a way to enable this or are there any apps which can provide this? Thanks!Designing a practical Zoho setup for a small business: lessons from a real implementation
I recently finished setting up a Zoho-based operating system for a small but growing consumer beauty business (GlowAtHomeBeauty), and I wanted to share a practical takeaway for other founders and implementers. The business wasn’t failing because of lackDKIM (Marketing emails) UNVERIFIED (Zoho One)
I'm having a problem with Zoho One verifying my Marketing Email DKIM Record for MYFINISHERPHOTOS.COM. I have removed and re-entered the ownership, DKIM (Transactional emails), SPF and Marketing DKIM and all of them come back verified except the DKIM (MarketingZoho Recruit Community Meet-up - India
Namaste, India. 🙏🏼 The Zoho Recruit team is hitting the road—and we 're absolutely excited behind the scenes. Join us for the Zoho Recruit India Meet-up 2026, a morning designed to make your recruiting life easier (and a lot more effective). Date CityGenerate a Zoho Sign link
From time to time I get a response "I never received your you e-document for electronic signature" is there a way to generate a Zoho Sign link to share.Is it possible to create a word cloud chart in ZoHo Analystics?
Hi there, I have a volume of transaction text that I would like to analyse using word cloud (or other approcah to detect and present word frequency in a dataset). For example, I have 50,000 records describing menu items in restaurants. I want to be ableHow to Fix the Corrupted Outlook 2019 .pst file on Windows safely?
There are multiple reasons to get corrupted PST files (due to a power failure, system crash, or forced shutdown) and several other reasons. If You are using this ScanePST.EXE Microsoft inbuilt recovery tool, it only supports the minor corruption issue[Webinar] A recap of Zoho Writer in 2025
Hi Zoho Writer users, We're excited to announce Zoho Writer's webinar for January 2026: A recap of Zoho Writer in 2025. This webinar will provide a recap of the features and enhancements we added in 2025 to enhance your productivity. Choose your preferredHow to drag row(s) or column(s)?
Hi. Selecting a row or column and then dragging it to a new position does not seem to work. Am i missing something or this is just not possible in Zoho Sheet? Cheers, JayBuilding Toppings #5 - Creating and configuring custom service connections in Bigin Toppings
Hello Biginners, Integrating Bigin with external applications extends its capabilities and enables customized functionalities. In our last post, we saw how to create a default service connection. Today, we'll see how to create a custom service connectionOptimising CRM-Projects workflows to manage requests, using Forms as an intermediary
Is it possible to create a workflow between three apps with traceability between them all? We send information from Zoho CRM Deals over to Zoho Projects for project management and execution. We have used a lookup of sorts to create tasks in the past,Conditional fields when converting a Lead and creating a Deal
Hi, On my Deal page I have a field which has a rule against it. Depending on the value entered, depends on which further fields are displayed. When I convert a Lead and select for a Deal to be created as well, all fields are shown, regardless of the valueATE Session on Payment Gateways: Our experts are live now. Post your questions now!
Hello everyone, Our experts are all excited to answer all your questions related to payment workflows. Please feel free to join this session and learn more about this topic. If you have a query at anytime, please post them here.Next Page