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

  

• 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

• Department Customization Copy/Paste

  Hello! I love the new customization of the layouts, rules and templates! However, we have several "departments" that operate similar and as I'm updating either ticket layout or workflow rules, I'm finding that I have to do it in each department. I would

• How do you import mail from Thunderbird into ZOHO mail

  Hi, We have Thunderbird on our Apple Macs and want to transfer the emails from this to our shiny new Zoho mail account. I know using Outlook on a PC you can zip the .eml files up and upload them into specific folders on your ZOHO mail account using this form: mail.zoho.com/mail/jsp/importFolder.jsp However as Thunderbird use mbox files I'm not sure how to do it. Can anyone let me know if they have migrated mail from Thunderbird to Zoho mail and how they did it. I have many folders and emails to transfer

• How to Open .mbox file in Gmail with Attachments?

  Gmail offer users to backup INBOX folder in .mbox file format via Google Takeout Feature. Howver there is no such option to Restore Gmail MBOX. Thus I would like to suggest you to choose an alternate approach i.e. MBOX to Gmail Wizard. This utility will open .mbox file in Gmail with attachments.  Steps to open MBOX file in Gmail are; Run MBOX to Gmail Wizard Click Add File and add .mbox file. Enter your Gmail login credentials. Click Convert button. Finished! This is how you can open MBOX file in

• Poor Zoho Support

  Been trying to reach support via telephone and email. The support has always been slow to respond but now its been two weeks without a return call. I have even sent them screen shots of the problem I've having with no results. Is anyone had the same problem.

• Desk Contact Name > split to First and Last name

  I am new to Zoho and while setting up the Desk and Help Center, I saw that new tickets created or submitted from the Help Center used the Contact Name field. This would create a new Contact but put the person's name in the Last Name field only. The First

• SalesIQ operators will not receive any messages if customers do not answer the Pre-Chat questions in Flow Controls.

  Hi Zoho SalesIQ Team, I am reaching out to report a issue regarding the Brands > Flow Controls SalesIQ operators will not receive any messages if customers do not answer the Pre-Chat questions in Flow Controls and continue sending messages without completing

• SalesIQ's Summer '26 Release: For The Moments That Matter

  Every customer journey is made up of moments. The moment someone discovers your business. The moment they need help. The moment you decide to reach out. The moment a simple chat turns into something more. And the moments that continue long after the conversation

• Add Comprehensive Accessibility Features to Zoho Writer

  Hello Zoho Writer Team, We hope you are doing well. We would like to submit a feature request to enhance Zoho Writer with a full set of accessibility tools, similar to the accessibility options already available in the Zoho Desk agent interface. 🚧 Current

• Copying a Document with its Citations

  When I copy a document that contains citations using File>Make a Copy from the document's menu the text copies but the citations do not (according to Google they should). Is this the correct way to make a complete copy of a document with its citations

• Bing ads integration and tracking

  Hi, Is there any way to track Bing ads in the same way that we are able to track google adwords?  It is important for us to be able to determine the conversion rate of our Bing ads.  If this is not possible now, will this feature be added in the future?

• #20 Your Business Shouldn't Stop Just Because You Do

  Imagine you are on a well-deserved vacation. Your clients are expecting invoices at the beginning of the month, recurring customers are due for billing, and payments are still coming in. Do you carry your laptop everywhere, hoping you don't miss a billing

• Marketing Tip #26: Optimize product images for SEO

  Product images can do more than make your store look good. They can also help customers discover your products through search. Since search engines can’t "see" images, they rely on text signals to understand what an image is about. Two small actions make

• Automation Series: Mandatory Time Logging Before Task Closure

  In a project, when users work on multiple tasks simultaneously, they track time in different ways, either by starting a timer or by adding a time log. Sometimes users may forget to add time, which can lead to discrepancies in the timesheet. When timesheets

• Is there a way to show contact emails in the Account?

  I know I can see the emails I have sent and received on a Contact detail view, but I want to be able to see all the emails that have been sent and received between all an Accounts Contacts on the Account Detail view. That way when I see the Account detail

• Zoho CRM gets a new email compose and lot more

  Dear Customers,  [UPDATE October 21, 2021: We have started opening these features to some of the customers already. And, it will be available to all the customers before November 2nd Week, 2021. Sorry for the delay caused]  [UPDATE February 21, 2022:

• CRM gets location smart with the all new Map View: visualize records, locate records within any radius, and more

  Hello all, We've introduced a new way to work with location data in Zoho CRM: the Map View. Instead of scrolling through endless lists, your records now appear as pins on a map. Built on top of the all-new address field and powered by Mappls (MapMyIndia),

• Introducing document visibility in Zoho Sign

  Hello! Complex document workflows often involve multiple stakeholders with different roles. Sending a separate envelope to every person is time consuming and can lead to administrative bottlenecks. With Zoho Sign's document visibility feature, you can

• Sent email stuck on processing

  My sent emails are stuck on processing, whats going on?

• [Webinar] What's new in Zoho Analytics: Q2 2026

  Hey data lovers! Our What's New webinar series is bringing you another lineup of exciting features and product enhancements from the past quarter, all designed to help you get more out of your analytics. Get an inside look at new data connectors, Zoho

• Alterar número de telefone para receber o código OTP

  Boa tarde! Como posso alterar o número de telefone da minha conta para aceder ao meu email corporativo? Estou tentando logar, mas não consigo, pois está sendo enviado o código OTP para o número antigo, preciso aceder urgente meu email, porque e de trabalho.

• CRM x WorkDrive: We're rolling out the WorkDrive-powered file storage experience for existing users

  Release plan: Gradual rollout to customers without file storage add-ons, in this order: 1. Standalone CRM 2. CRM Plus and Zoho One DCs: All | Editions: All Available now for: - Standalone CRM accounts in Free and Standard editions without file storage

• Request to Increase URL Field Character Limit

  Hi Arthi, Hope you are doing well. I'm trying to save a URL in the Work Order (WO) module using the URL field, but I receive the following error message: "Please enter a valid Repair File. Maximum 450 characters are allowed." The issue is that the URL

• How to change column headings in pivot table?

  Hi, Is there a way to rename the column headers of a pivot table? Now some the columns are named with value labels: 'SUM of .....'. We would like to rename those headers. As of now we couldn't find any direct solution to adjust the headers, besides copying and reformat. We want to avoid these extra steps. Best, Tiemen

• Undelivered Mail

  I suspect that there are recipient's servers that blocks my emails. I receive the following email from mailer-daemon@mail.zoho.eu : A message that you sent could not be delivered to one or more of its recipients. This is a permanent error. pantelis.sarantos@unipakhellas.gr,

• Email not loading on PC

  Hello, my email opens on but it doesn’t load on PC. I don’t have other issues with the email, all the configurations are ok and I face with following issue in the photo. It says “ mail.zoho.com refused to connect” I will be very thankful if anyone can

• Why are bounce/error emails being sent to info@ instead of contact@?

  I have my Zoho Mail and WordPress site configured so that normal website emails should go to contact@hybridbatteryservice.com. However, I keep receiving technical bounce/error emails and delivery failure notifications at info@hybridbatteryservice.com

• Do Not Disturb status not respected when Cliq bar is enabled across Zoho apps

  Hi Zoho Cliq team, I want to report what appears to be a bug with how the Do Not Disturb status interacts with the embedded Cliq bar in other Zoho apps. **Issue:** When my Cliq status is set to Do Not Disturb, I continue to receive notification tones

• Zoho Webinar Summer Broadcast 2026

  What if your webinar platform could connect directly with your business tools, automate routine tasks, trigger actions across your workflows, and support every stage of your webinar lifecycle? That’s the question we’ve been answering so far this year.

• Zoho CRM Layout Rules: Nine New Actions, Profile-Based Execution, and Interactive Preview

  Hello everyone, Availability: This feature is now available for customers in the JP and SA DCs. It is planned to be released for other customers in soon. We’re excited to announce powerful new enhancements to Layout Rules in Zoho CRM - a feature built

• Invalid request when trying to access Mail

  When I click on the red button to access Zoho Mail at https://mail.zoho.com/zm/, I get a big yellow warning triangle with "invlid request, The input passed is invalid or the URL is invoked without valid parameters. Please check your input and try ag

• Whats the average response time for ticket submitted?

  I submitted a request to unblock my mail accounts. They seem to be blocked for outgoing mail, and I have been waiting for days to have this fixed with no reply. I have submitted 2 tickets and an email. My work has to completely stop. I pay for the service

• All new Address Field in Zoho CRM: maintain structured and accurate address inputs

  Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. 24

• Is there any way to have Dataprep ingest RSS?

  As stated by the title. Does the Zoho environment offer tools that I can use to, directly or using workarounds, have Dataprep ingest an RSS feed? Thanks

• Introducing Color Coding of Picklist Values

  Dear Everyone, Greetings!! Zoho CRM is uplifting the user experience. Recently, we had some notable aesthetic improvements in CRM like Kanban View UI enhancement, New List view UI enhancement, color coding of tags, and color coding of picklists in meetings.

• Important updates to your Widget JS APIs

  Hello everyone, Greetings from Zoho Creator! This is an urgent notice for developers and Partners who use widgets in their Zoho Creator applications. We previously announced an update to the CDN URLs used for loading the Widget JS API, with a deadline

• Deluge sendmail in Zoho Desk schedule can't send email from a verified email address

  I am trying to add a scheduled action with ZDesk using a Deluge function that sends a weekly email to specific ticket client contacts I've already verified the email address for use in ZDesk, but sendmail won't allow it in its "from:" clause. I've attached

• Mailbox delegation “Send As” error

  I believe there may be an issue with mailbox delegation. When I create a delegation from the Admin Console, it works correctly if I select Read permissions. However, if I select Send As permission for the delegated user, I immediately receive the following

• Restrict Zoho Cliq Webinars and Announcements to Admins Only

  Hi Zoho Team, We hope you're doing well. We would like to raise a feature request regarding in-app announcements in Zoho Cliq, such as the recent webinar popup about the Cliq Developer Platform: While these announcements are useful, they are not always

• how do i get mail.mydomain.com to point to zoho mail web-mail?

  I have started using zohomail, and am loving it. With my previous provider, I used to go to mail.mydomain.com, and it would take me to my webmail. I am not able to find the mapping for zoho's webmail to map to it. It is difficult to go to webmail with

• Number of decimal places

  Hi Latha, I have added the following three fields to the Company module. Currently, these fields only allow a maximum of 2 decimal places. However, for some of our requirements, we need to enter values with up to 10 decimal places. Could you please help

• Next Page