Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
NEW
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Client Script Events

The events trigger the Client Scripts, enabling them to execute.

1. What is an Event ?

Events are user actions that occur in the Zoho CRM client. You can create Client Scripts which will get executed in response to these events. Client Script provides you a set of page and field events for the various pages in Zoho CRM. In addition to this, Client Script enables you to configure events for the custom buttons, text, icons, etc., on the canvas page. You can configure events for tags,mandatory fields form and blueprints on the canvas and standard detail page. You can define your own actions for the configured events.

The pages where the Client Scripts can be configured are Create page, Clone page, Edit page, List Page (Standard), Detail Page (Standard), Detail Page (Canvas), Create Page (Wizard) and Edit Page (Wizard)Based on the page, events can be configured for the Client Script in Zoho CRM.

2. Create/Clone/Edit Page Events

The events for the create/clone/edit page can be either page event or field event.

1. Page Event - These are the events that occur on the create/clone/edit page of the selected module in Zoho CRM. A page event can be one of the below three types.

  • onLoad - This event occurs when the create/clone/edit page gets loaded.
  • onChange - This event occurs when you give or update values for any of the fields in the create/clone/edit page. For example, consider a Client Script configured for create page of Accounts module with onChange page event. The script runs whenever you enter values for any of the fields in Accounts(Account Owner, Account Name, Phone, etc) module.
  • onSave - This event occurs when you save a record from create/clone/edit page using the Save or Save and New button.

Note:

  • A single Client Script with page onChange event can be used when Client Scripts are required for multiple fields on the same page.
  • Add the "return false" statement at the end of onSave event type script, to prevent the record from getting saved.

2. Field Event 

  • onChange - This event occurs when you enter or update value for a particular field and move to another field or click outside the field on the create/clone/edit page of the selected module. For example, consider a Client Script configured for create page of Accounts module with onChange field event on the field Phone. The script runs only when the user enters value for the field Phone and moves to the another field in create page.
     
  • onType - This event occurs when you type any value in a particular field on the create/clone/edit page of the selected module. For example, consider a Client Script configured for create page of Contact module with onType field event for the field email. The script runs once the user types in a value for the field email in create page.​​

onChange vs onType:

When you use onType event, the script will be triggered as soon as you type value in a field. Whereas if you use onChange event , the script will be triggered only when you click outside that field or move to the another field.

Supported Field Types

  • Single Line
  • Multi-Line
  • Email
  • Phone
  • Pick List
  • Date
  • Number
  • Currency
  • Decimal
  • Percent
  • Long Integer
  • Checkbox
  • URL
  • Lookup
  • Owner Lookup

Unsupported Fields

  • Salutation
  • Adjustment
  • Discount

Note:

If you want the Client Script to run for a particular layout in a module, select that layout while specifying the event details.

3. Detail Page (Canvas) Events

Below are the types of events available for Detail Page (Canvas).

1. Page Event 

  • onLoad - This event occurs when the canvas page gets loaded.

2. Field Event 

  • onBeforeUpdate - This event occurs on the click of the tick icon after you edit or update a particular field. Add the "return false" statement at the end of the script, to prevent the value from getting saved.

Supported Field Types

  • Single Line
  • Multi-Line
  • Email
  • Phone
  • Pick List
  • Date
  • Number
  • Currency
  • Decimal
  • Percent
  • Long Integer
  • Checkbox
  • URL
  • Lookup
  • Owner Lookup

Unsupported Fields

  • Reporting To
  • Currency
  • Probability
  • Pricing Model
  • Wizard
  • Territory Updated Time

 

3. Mandatory Fields Form Event 

  • onBeforeMandatoryFormSave - This event occurs on the click of save button of the mandatory fields form before saving the values.
  • onMandatoryFormLoad - This event occurs when the mandatory fields form pop-up appears on the screen.

Note:

You can set mandatory fields based on a condition using Layout Rules. When there is an inline edit on the canvas page which satisfies the layout rule, a form will pop-up to get the values for the mandatory fields. This form is called as the Mandatory fields form.

4. Blueprint Event 

  • beforeTransition - This event occurs before the transition states of a Blueprint, as per the process flow designed in the blueprint.  Add the "return false" statement at the end of the script, to prevent the blueprint transition.

5. Tag Event 

  • onTagChanged - This event occurs on the click of save button of  Add tags.

6. Canvas Button Event 

  • onClick - This event occurs on the click of canvas button.

7. Icon Event 

  • onClick - This event occurs on the click of canvas icon.

8. Text Event 

  • onClick - This event occurs on the click of canvas text.

4. Create Page (Wizard) / Edit Page (Wizard) Events

Below are the types of events available for Create Page (Wizard) and Edit Page (Wizard).

1. Wizard Event 

  • onLoad - This event occurs whenever the Client Script configured wizard is loaded.
  • onChange - This event occurs whenever any field's value is changed in the Client Script configured wizard.
  • onBeforeSave - This event occurs whenever you click the save button in the Client Script configured wizard. You can prevent the save action by returning false in the script.
  • onTransition - This event will be triggered whenever the transition happens i.e when you move from one screen to another in the Client Script configured wizard.
  • onBeforeTransition - This event will be triggered before you make a transition in the Client Script configured wizard. You can prevent the transition by returning false in the script.

2. Field Event 

  • onChange - This event occurs when you change a particular field's value in the Client Script configured wizard.
  • onType - This event occurs when you type any value in a particular field. For example, consider a Client Script configured for Create Page (Wizard) of Contacts module with onType field event for the field email. The script runs once the user types in a value for the field email.

5. List Page (Standard) Events

Below are the types of events available for List Page(Standard).

1. Page Event 

  • onCustomViewLoad - This event occurs when custom view of the List Page(Standard) is loaded. For example, consider that you have created a custom view for all Accounts of Account type vendor. The script will run whenever this custom view loads.

  • onBeforeCustomViewChange - This event occurs before you make any change in custom view of the List Page(Standard). For example, consider that you have created a custom view for all Accounts of Account type vendor. The script will run whenever you try to do any change to this custom view.

6. Detail Page (Standard) Events

Below are the types of events available for Detail Page (Standard).

1. Page Event 

  • onLoad - This event occurs when the detail page gets loaded.

2. Field Event 

  • onBeforeUpdate - This event occurs on the click of the tick icon after you edit or update a particular field. Add the "return false" statement at the end of the script, to prevent the value from getting saved.

Supported Field Types

  • Single Line
  • Multi-Line
  • Email
  • Phone
  • Pick List
  • Date
  • Number
  • Currency
  • Decimal
  • Percent
  • Long Integer
  • Checkbox
  • URL
  • Lookup
  • Owner Lookup

Unsupported Fields

  • Reporting To
  • Currency
  • Probability
  • Pricing Model
  • Wizard
  • Territory Updated Time

3. Mandatory Fields Form Event 

  • onBeforeMandatoryFormSave - This event occurs on the click of save button of the mandatory fields form before saving the values.
  • onMandatoryFormLoad - This event occurs when the mandatory fields form pop-up appears on the screen.

Note:

You can set mandatory fields based on a condition using Layout Rules. When there is an inline edit on the detail page which satisfies the layout rule, a form will pop-up to get the values for the mandatory fields. This form is called as the Mandatory fields form.

4. Blueprint Event 

  • beforeTransition - This event occurs before the transition states of a Blueprint, as per the process flow designed in the blueprint.  Add the "return false" statement at the end of the script, to prevent the blueprint transition.

5. Tag Event 

  • onTagChanged - This event occurs on the click of save button of  Add tags.

4. Create Page (Wizard) / Edit Page (Wizard) Events

Below are the types of events available for Create Page (Wizard) and Edit Page (Wizard).

1. Wizard Event 

  • onLoad - This event occurs whenever the Client Script configured wizard is loaded.
  • onChange - This event occurs whenever any field's value is changed in the Client Script configured wizard.
  • onBeforeSave - This event occurs whenever you click the save button in the Client Script configured wizard. You can prevent the save action by returning false in the script.
  • onTransition - This event will be triggered whenever the transition happens i.e when you move from one screen to another in the Client Script configured wizard.
  • onBeforeTransition - This event will be triggered before you make a transition in the Client Script configured wizard. You can prevent the transition by returning false in the script.

2. Field Event 

  • onChange - This event occurs when you change a particular field's value in the Client Script configured wizard.

7. Create/Clone/Edit Page (Canvas) Events

Below are the types of events available for Canvas Record Forms. These events are applicable for Create Page (Canvas), Clone Page (Canvas) and Edit Page(Canvas).

1. Page Event 

  • onLoad - This event occurs when the page gets loaded.
  • onChange - This event occurs when you add or update values for any of the fields. For example, consider a Client Script configured for Create Page(Canvas) of Accounts module with onChange page event. The script runs whenever you enter values for any of the fields in Accounts(Account Owner, Account Name, Phone, etc) module.

  • onSave - This event occurs when you save the record using the Save or Save and New button.

2. Field Event 

  • onChange - This event occurs when you add or update value for a particular field and move to another field or click outside the field on the page of the selected module. For example, consider a Client Script configured for Create Page (Canvas) of Accounts module with onChange field event on the field Phone. The script runs only when the user enters value for the field Phone and moves to the another field in that page.
  • onType - This event occurs when you type any value in a particular field. For example, consider a Client Script configured for Create Page (Canvas) of Contact module with onType field event for the field email. The script runs once the user types in a value for the field email in create page.​

3. Mandatory Fields Form Event 

  • onMandatoryFormLoad - This event occurs when the mandatory fields form pop-up appears on the screen.

4. Canvas Button Event 

  • onClick - This event occurs on the click of canvas button.

5. Icon Event 

  • onClick - This event occurs on the click of canvas icon.

6. Text Event 

  • onClick - This event occurs on the click of canvas text.