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 past few weeks. One of the feedbacks asked us to cover "more on ZDK CLI". In this post, we will discuss building an Event Management System in Zoho CRM Using ZDK CLI.

Consider the case of Zenith, a Zoho CRM partner who is also partner for Zoho's competing products. Zenith is hosting a conference in which their representatives are inviting speakers from Zoho and also other competing products. The attendees of the conference will be either external attendees or leads or contacts of Zenith. For this purpose existing meetings module of Zoho CRM (previously called Events) can not be used as it is not a good fit for this case. Custom modules and fields are required for this. In this post, we’ll discuss how to create a Event Management System that is complimentary to Zoho CRM using ZDK CLI. 

Why Use ZDK CLI?

ZDK CLI allows developers to:

1. Create and edit CRM metadata (modules, fields, roles, profiles, and widgets)
2. Define relationships between modules (lookups, multi-select lookups)
3. Push and sync metadata changes to sandbox.
4. Resolve conflicts when multiple users work on the same metadata.

This makes it ideal for building reusable CRM systems such as event management.

Initial Setup

As the initial setup, initialize the ZDK CLI project directory using zdk init command and create a new ZDK Project folder "Zenith". 

zdk init

Then, login to the sandbox environment for Zenith using zdk auth:login command. 

zdk auth:login

When you execute zdk auth:login, you can either select any org that is already signed in or select NEW LOGIN to visit the login page and select the sandbox org you will be working on.

After logging in to Zoho select the sandbox environment and give required permissions.

For the current beta release, ZDK CLI is exclusively available for Sandbox environment and is not operational in Production environments. 

You will be redirected to the terminal after successful login and you can start working on ZDK CLI.

Change the api_version to 8 in zdk-project.json file.

Step 1: Define the Modules

For an event management use case, we will need the following custom modules:

1. Conference – Stores details of each event.
2. Attendees – Tracks participants, whether leads, contacts, or external.
3. ConferenceAttendees (Linking Module, not created) – Connects conferences and attendees with registration status.
4. Venues – Captures details of event locations.
5. Speakers – Stores details of invited speakers.

This has been visualized in the data model below.

To create a module, use the command

zdk meta:create modules

This creates the json file for module metadata : Conference.modules-meta.json  in the path Zenith/crm/meta/modules/Conference 

Conference.modules-meta.json content

{     "singular_label": "Conference",     "plural_label": "Conferences",     "api_name": "Conference",     "profiles": [         {             "api_name": "Administrator"         }     ],     "display_field": {         "api_name": "Conferences"     },     "show_as_tab": true }

Similarly create modules Attendees , Venues, and Speakers modules

Step 2: Customize Fields

To create a field, use the command

zdk meta:create fields

Conference module:

Conference modules's fields are:

1. Attendees (multiselectlookup to Attendee module) 
2. Speakers (multiselectlookup to Speakers module) 
3. Venue (lookup to Venue module) 
4. Date (datetime) 
5. Duration(double) 
6. Description (textarea) 
7. Status (picklist: Planned, Ongoing, Completed)

Attendees field

Let us check how to create the field attendees of type multi-select lookup (to Attendee module)

The json file Attendees.fields-meta.json created in the path Zenith/crm/meta/modules/Conference/fields will look like this

To provide dependent details for the multi select lookup, add the multiselectlookup json object to the Attendees.fields-meta.json file as below:

{     "field_label": "Attendees",     "display_name": "Attendees",     "api_name": "Attendees",     "type": "used",     "data_type": "multiselectlookup",     "multiselectlookup": {         "connected_details": {             "module": {                 "api_name": "Attendee"             },             "field": {                 "field_label": "AttendingConference"             }         },         "linking_details": {             "module": {                 "plural_label": "Conferences_X_attendees"             }         }  } }

Speakers (multi-select lookup to Speakers module)

Similar to Attendees field, create Speakers field and modify the json file Speaker.fields-meta.json created in the path Zenith/crm/meta/modules/Conference/fields:

{     "field_label": "Speaker",     "display_name": "Speakers",     "api_name": "Speakers",     "type": "used",     "data_type": "multiselectlookup",     "multiselectlookup": {         "connected_details": {             "module": {                 "api_name": "Speaker"             },             "field": {                 "field_label": "AttendingConference"             }         },         "linking_details": {             "module": {                 "plural_label": "Speakers_X_attendees"             }         }  } }

Venue (lookup field to Venue module)

Similarly, create the Venue field with type as "lookup" The json file Venue.fields-meta.json created in the path Zenith/crm/meta/modules/Conference/fields will look like this

To provide dependent details for the lookup, add the lookup json object to the json as below.

{     "field_label": "Venue",     "display_name": "Venue",     "api_name": "Venue",     "type": "used",     "data_type": "lookup"     "lookup": {         "display_label": "Venue",         "api_name": "Venue",         "module": {           "api_name": "Venue"         }       } }

Description (textarea)

After create a textarea field Description using zdk meta:create fields command, add textarea json object to the field meta json file as below :

{         "field_label": "Description",                 "display_name": "Description",                 "api_name": "Description",                 "type": "used",                 "data_type": "textarea",                 "textarea": {                         "type": "rich_text"                 } }

The possible values for text area are small, large and rich_text.

Status (picklist)
After create a picklist field Status using zdk meta:create fields command, add pick_list_values json array to the field meta json file as below:

{     "field_label": "Status",     "display_name": "Status",     "api_name": "Status",     "type": "used",     "data_type": "picklist",   "pick_list_values": [     {       "display_value": "Planned",       "actual_value": "Planned"     },     {       "display_value": "Ongoing",       "actual_value": "Ongoing"     },     {       "display_value": "Completed",       "actual_value": "Completed"     }   ] }

Date and duration fields of type datetime and double does not require any edits to the created meta.json file.

Attendees Module

Similarly, add fields for attendees modules

1. Phone (phone)
2. Company (text)
3. EventsAttended (multi-select lookup to Conference module)
4. Attendee Type (picklist with options Lead, Contact, External)
5. Leads (lookup to Lead module)
6. Contacts (lookup to Contact module
   

Venue Module

1. Location (text)
2. Capacity (integer)
3. Contact erson (text)
4. ContactNumber(phone)
5. Description(textarea)

Speakers Module

1. Phone (phone)
2. Company (text)
3. SpeakerStatus (picklist with options Confirmed, Pending, Canceled)
   

Step 3: Create a Custom Role

To create a field, use the command

zdk meta:create roles

This ensures event managers have the right access without interfering with other CRM operations.

Pushing changes to the sandbox environment

Once all changes are done execute zdk org:push and zdk org:push result --{jobId} command to deploy the changes to the sandbox environment. Once the changes are verified in your sandbox environment you can deploy it to the production environment.

You can extract this metadata zip file, that is created using zdk org:export command to your own ZDK project directory and try pushing the changes to your sandbox environment.

Building the Event Management System for "Zenith" illustrates the core strength of ZDK CLI. It brings software engineering best practices to Zoho CRM customization. By defining modules/fields/roles as json files directly or creating them using the command, the source truth of the metadata is available in local system. The same can be tracked via version control systems like GIT for better collaboration among the team.

Previous post: Kaizen# 209 - Answering Your Questions | All About Client Script | ZDK CLI documentation | Kaizen Directory

• Topic Participants

• Mable Mary M P

  

• Quint

• Ishwarya SG

  

• 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 this

• Kaizen #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 how

• 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

• Recent Topics

• Need advice for product/item search functionality when adding invoices.

  My client uses "Catalog or Vendor" name and Product code to search for his items. But Zoho only allow to search by product name and SKU when adding items to Invoices/Estimates. Clients product codes are not unique as they may overlap from different catalogs/vendors.

• How to dynamically pass IDs from one API response to a second API call in Zoho DataPrep?

  Hi Team, I am setting up a global consolidated reporting pipeline in Zoho Analytics (India) using Zoho DataPrep as the ETL engine. I am pulling data from multiple Zoho Books Data Centers (US, Singapore, India) thats why i used the URL Source (OAuth 2.0)

• Feature Request: "Send Invitation" Toggle for Events

  I am writing to request a critical "Quality of Life" update for the Activities module. Currently, adding people to the Participants field in an Event triggers an automatic email invitation/acceptance tracking with no way to opt-out. For general events

• Account Review Pending - Daily Limit 100

  Hi ZeptoMail Team, I'm writing to request a manual review of my account. I am currently stuck on the 100-email daily limit and cannot purchase credits. Status: My domain is already verified (DKIM/CNAME). Issue: The "Customer Validation" option is no longer

• Automation Series: Move Tasks to a different Task List on Status Change

  In Zoho Projects, you can automatically move a task from one task list to another when its status is updated. This keeps your tasks organised and ensures better visibility while reducing manual work. For instance, during a product launch, the marketing

• Introducing Bigin's all new integration with Microsoft Teams

  Picture this: You are on call with your team to discuss some important deals that need to be closed soon. While discussing each deal, your team has to switch back and forth between your Teams account and Bigin account to refer to details about the deal.

• Scaling the customer journey: What's new in CommandCenter

  Dear Customers, The last time we connected about CommandCenter, it was about the tool's new controls and revamped UI. Personally, the overhaul of the UI from the last update, still excites me. Today, we're here with news about its scalability and added

• Adjusting Physical Inventory

  Not getting very far with support on this one, they say they are going to fix it but nothings happened since November. Please give this a thumbs up if you would like to see this feature or comment if you have some insight. Use Case: Inventory set to be

• Dynamic Remaining Quantity in Lookup During Allocation

  Hi everyone, From what I understand in Zoho Creator, lookup fields only display the stored value from the source record and do not dynamically update while a form is being filled. Because of this, showing a real-time updated remaining quantity inside

• Is it possible to use HTML formatting in SMS messages sent from Zoho?

  Hi everyone, I have a question regarding sending SMS from Zoho When we send emails from Zoho, we can include HTML code to format the message (like adding links, styling, etc.). Is it possible to do something similar when sending SMS messages through Zoho

• Important update: Migrate to the new SalesIQ live chat widget before April 14, 2026

  The old SalesIQ live chat widget will be deprecated on April 14, 2026. This is a final reminder to migrate to the new SalesIQ live chat widget before this date. After April 14, 2026, the old widget will no longer be maintained, which can lead to slower

• If your IM chats aren’t auto-assigning, here’s what to check

  Hey everyone! We’ve been seeing quite a few questions around Instant Messaging (IM) Chat Routing in Zoho Desk, especially around how it actually behaves in real time. So I thought I’d share a practical breakdown of what’s happening behind the scenes.

• connect zoho creator with google drive

  Hello everyone, I need to connect to a folder drive. The idea, is that google drive loads a text document with some data, I must read that text document to be able to autofill a form that I have in zoho creator with that data. I also attach PDFs and place

• Uploaded files are not included when using "Include user submitted data" in Email Notification

  In Send Email notification workflow in Zoho Creator, there is an option called "Include user submitted data" which allows the email to contain all the form submission details. However, when this option is enabled, files or images uploaded through File

• Extend Zoho Canvas Customization to Zoho Creator Forms and Reports

  Currently, Zoho Canvas allows users to design and customize the UI of Zoho CRM modules with a much better visual experience. This helps organizations create cleaner layouts, improve usability, and design interfaces that match their workflows. However,

• Kanban View for Projects.

  At our organization, we describe active projects with various statuses like "In Proofing" or "Printing" or "Mailing". In the Projects view, one can set these project statuses by selecting from the appropriate drop-down. While this works, it's difficult to view and comprehend the progress of all of your projects relative to each other in a table. Creating a Kanban view for projects where I can move them from one status to another allows me to see where each project is in the order of our workflow.

• Button ''I'm Interested'' won't translate

  Since our main platform is in French, I would like to get this ''I'm Interested'' button translated to French ''Je suis intéressé''. We managed to translate the whole carreer site in French, except the button. How come ? We have a standard subscription,

• Feature request - image resizing on sales orders

  I need to be able to show the items on the sales orders, currently the item image shows really small and no way to resize it, need the ability to make the image larger to showcase the product on the pdfs

• ZOHO.CRM.UI.Record.open not working properly

  I have a Zoho CRM Widget and in it I have a block where it will open the blocks Meeting like below block.addEventListener("click", () => { ZOHO.CRM.UI.Record.open({ Entity: "Events", RecordID: meeting.id }).catch(err => { console.error("Open record failed:",

• Email Parser Not Extracting Fields Correctly with Certain Label Formats

  I’ve been testing the Email Parser functionality in Zoho CRM to automatically extract data from incoming emails and map it to CRM fields. During testing, I noticed that parsing sometimes fails when the email contains field labels formatted like this:

• Zoho CRM Community Digest - February 2026 | Part 1

  Hello Everyone! February has been off to a productive start in the Zoho CRM Community, with several thoughtful product enhancements and helpful technical discussions making their way into the forums. To help you stay up to speed, we’ve rounded up the

• Nouvelle fonctionnalité : donnez du style à vos pages avec le Branding

  Que vous prépariez un webinaire important. Vous avez investi du temps dans votre contenu, invité des intervenants de qualité, et les inscriptions commencent à affluer. Mais votre page d’inscription ? Elle ressemble à toutes les autres : générique, sans

• How to sync Zoho CRM Quotes with Zoho Books/Finance Estimates or Quotes

  Hi everyone, We’re building quotes in the Zoho CRM Quotes module because of its strong CPQ features and better communication options (multiple contacts, email customization, etc.). However, these don’t sync directly with Zoho Books/Finance for invoicing.

• Marketing Tip #24: Encourage customers to leave reviews

  Reviews are one of the strongest trust signals in ecommerce. When shoppers see real feedback from other customers, they feel more confident about buying, especially when they’re choosing a brand for the first time. Not all reviews are equal. Detailed

• Ability to Attach Record-Specific Files Automatically in Workflow Email Templates

  Currently in Zoho CRM, email templates allow attachments to be added, but these attachments are static and remain the same for every recipient. There is no straightforward option to automatically attach a file that is stored within the specific CRM record

• This version of app doesn't support this notecard type Error

  So this problem is happening for any notes created within the last week, as well as any note recently edited on Android. I can open them on my phone fine, but they don't open on the website version. They DO work on the desktop app version. It's just web

• Issue with Picklist Dropdown Not Opening on Mobile

  Hello I am experiencing an issue with picklist values on mobile. While the arrow is visible, the dropdown to scroll through the available values often does not open. This issue occurs sporadically, it has worked occasionally, but it is very rare and quite

• {Action Required} Re-authenticate your Google Accounts to Continue Data Sync

  Hello Users! To align with Google’s latest updates on how apps access files in Google Drive, we’ve enhanced our integration to comply with the updated security and privacy standards, ensuring safer and more reliable access to your data. With this update,

• Allocating inventory to specific SO's

  Is there a way that allocate inventory to a specific sales order? For example, let's say we have 90 items in stock. Customer 1 orders 100 items. This allocates all 90 items to their order, and they have a back order for the remaining 10 items which could

• Is this a SCAM email or is it really Zoho?

  L.S. I received the following message. Is this from Zoho? I have had a Zoho One account for many years and my website has been online for years. If it is a scam, I think you should know about it.

• How to close an estimate ?

  Hello, I have created estimates, and converted them to invoices to get 50% payment. Now I have 2 cases where the estimate stills shows status partially invoiced, however: 1. for one of them, project stopped half way, so the remaining part will never be

• Updating Analytical Fields Data

  Dear Zoho team, I'm having an issue with the recently added fields in both Analytical Desk and Analytical. How can I generate the data in Analytical when new fields are added? https://analytics.zoho.com/workspace/2436819000000007005/edit/24368190000

• Looking for Guidance on Building a Zoho Website

  I'm exploring the possibility of building a custom website with specific features using Zoho as an alternative platform. My goal is to create something similar to https://gtasandresapk.com , with the same kind of functionality and user experience. I'd

• My Zoho mail stopped receiving or sending emails about 3 hours ago

  Its a pop 3 account. The emails get into the actual mailbox on the server and I can send emails directly from the server, but they are no longer in Zoho, in neither of my Zoho accounts. All green ticks under Mail Accounts under Settings

• Zoho Cliq not working on airplanes

  Hi, My team and I have been having this constant issue of cliq not working when connected to an airplane's wifi. Is there a reason for this? We have tried on different Airlines and it doesn't work on any of them. We need assistance here since we are constantly

• Request to Recover Deleted Task List – Project ID: RIV-MOD-10722

  Hi Zoho Team, I hope this message finds you well. My Zoho task list associated with Project ID: RIV-MOD-10722 appears to have been deleted. When I clicked on the task link from the email notification, I received the following message: "Task has been deleted

• Email Insights included in Bigin emals are marked as SPAM everywhere

  Today I noticed that email recipients who use Office 365 never receive emails sent from Bigin. Further examination showed that all Email Insights links in email headers are marked as spam/phishing by Office 365. Example screen included. The problem is

• How do I import Connected Records for a Deal?

  Can you point me to an example of the CSV file that would add related records to an existing CRM Deal? I imported a Deal, then tried importing a connected record using a unique ID that references the Deal ID, but it doesn't attach it to the Deal rec

• File Upload Field in Zoho Forms Not Updating Existing File in Zoho CRM

  Hi everyone, I’m trying to understand the behavior of a file upload field mapped from Zoho Forms to Zoho CRM. Scenario There is a File Upload field in a Zoho CRM module. A Zoho Form also has a File Upload field, which is mapped to that CRM field. When

• Zoho Training

  Greetings! I am trainer. My focus area is Project Management and MS Project. I have used Zoho CRM to a good extent. Though, I was interested in using ZOHO projects, as there were no live projects, I could not take it up for studies. Recently a client

• Next Page