Kaizen #14 - Notification API
Hello everyone!
Welcome back to another week in the Kaizen series!
This week, we will discuss the Notification API in detail.
What is a Notification API?
Notification API allows you to get instant notifications whenever an action is performed on the records of a module. The system notifies you of the event on the URL you provide. You can also enable notifications based on a specific operation like create, update, or delete.
Channels for notification
You can create individual channels to 'watch' set of activities performed on certain CRM modules like Leads/Contacts/Accounts etc.
Let us assume that you have an application with two code modules—Code module 1 processes data from the Sales Force Automation modules, and code module 2 processes data from the inventory modules. Therefore, it makes sense to create one channel for each code module and notify the user about a change in that code module from the respective channel.
Through the Notification APIs, you can also set the expiry time for instant notifications for every channel, and disable notifications, anytime.
Notification APIs allow you to
Enable Notifications (POST)
Get Notification Details (GET)
Disable Notifications (DELETE)
Disable Specific Notification (PATCH)
Enable Notifications
This API allows you to enable instant notifications for a channel.
Request URL: {{api-domain}}/crm/v2/actions/watch
Request Method: POST
Scope: ZohoCRM.notifications.ALL/CREATE
Here is a sample request that sends out notifications to the notify URL when a contact or a deal is created, or when an account is updated.
{ "watch": [ { "channel_id": "10000007828", "events": [ "Contacts.create", "Accounts.edit", "Deals.create" ], "channel_expiry": "2020-02-02T10:30:00+05:30", "token": "contacts_and_deals7828", "notify_url": "https://webhook.site/71d9de50-244f-473e-beb6-1acd161c3ac6" } ] } |
While enabling instant notifications, you can specify the following in the input:
Key and Data type | Description |
notify_url (mandatory) String | A valid URL that accepts data from the Notification API. Whenever any action gets triggered, the notification will be sent to this notify URL. |
channel_id (mandatory) String | The unique identification of that particular channel. The given value is sent back in the notification when an action happens in that channel. |
events (mandatory) JSON array | A JSON array of the module API name and the operation type (action on the records) that you want to be notified upon. |
token String, max of 50 characters | The given value is sent back in the notification URL body to ensure that the notification is sent from Zoho CRM. By using this value, users can validate the notifications. |
channel_expiry DateTime | The expiry time of the channel in the ISO8601 format. After this time, notifications for the channel are not sent. The expiry can be a maximum of one day after the notifications were enabled for that channel. If you do not specify this value or set an expiry time beyond one day, the system considers the default expiration time of one hour. |
Note
You can create a maximum of 100 channels (100 JSON objects, one for each channel) per API call.
Here is the response to the above POST request.
{ "watch": [ { "code": "SUCCESS", "details": { "events": [ { "channel_expiry": "2020-01-10T19:20:23+05:30", "resource_uri": "{{api-domain}}/crm/v2/Contacts", "resource_id": "3652397000000002179", "resource_name": "Contacts", "channel_id": "10000007828" }, { "channel_expiry": "2020-01-10T19:20:23+05:30", "resource_uri": "{{api-domain}}/crm/v2/Deals", "resource_id": "3652397000000002181", "resource_name": "Deals", "channel_id": "10000007828" }, { "channel_expiry": "2020-01-10T19:20:23+05:30", "resource_uri": "{{api-domain}}/crm/v2/Accounts", "resource_id": "3652397000000002177", "resource_name": "Accounts", "channel_id": "10000007828" } ] }, "message": "Successfully subscribed for actions-watch of the given module", "status": "success" } ] } |
Where,
resource_uri is the request URL to access the module.
resource_id is the ID of the module (obtained from "{api-domain}/crm/v2/settings/module_api_name").
Here is the sample request body of the notification that Zoho CRM sends to the notify URL.
{ "query_params": {}, "module": "Contacts", "resource_uri": "{{api-domain}}/crm/v2/Contacts", "ids": [ "3652397000001565035" ], "operation": "insert", "channel_id": "10000007828", "token": "contacts_deals_accounts_7828" } |
Get Notification Details
Use this API to get the list of all notifications a user has enabled.
You can also specify the channel_id to get the details of the notifications for that particular channel.
Request URL: {{api-domain}}/crm/v2/actions/watch
Request Method: GET
Scope: ZohoCRM.notifications.ALL/READ
Note
You can fetch a maximum of 200 channels per API call using this method.
Key and Data Type | Description |
per_page Integer | The number of channels you want to fetch per API call. The maximum is 200. |
page Integer | To get the list of records from the respective pages. The default value is 1. |
module String | The API name of the module to fetch notifications enabled for that module. |
channel_id String | The unique ID of the notification channel. |
Example:
{{api-domain}}/crm/v2/actions/watch?module=Leads&page=1&per_page=150&channel_id=10000007828
Update Notification Details
This API allows you to update the details of an existing notification like the token, the event which triggers the notification.
Request URL: {{api-domain}}/crm/v2/actions/watch
Request Method: PUT
Scope: ZohoCRM.notifications.ALL/WRITE/UPDATE
Mandatory parameter: channel_id
Below is an example of an input to update the details of the notification we enabled in the previous example.
{ "watch": [ { "channel_id": "10000007828", "events": [ "Contacts.create", "Contacts.edit", "Deals.create" ], "channel_expiry": "2020-01-12T15:35:05+05:30", "token": "contacts_deals_7828", } ] } |
As you can see, we have updated the event in which a notification is triggered, and the token.
Note
- Only the details you specify in the input will be updated. All other details you specified while enabling the notification will be removed. In this case, the notification for "Accounts.edit" will be disabled.
- You can update a maximum of 100 channels per API call.
Update Specific Information of a Notification
Use this API when you want to update specific information of a notification by retaining the existing details.
Request URL: {{api-domain}}/crm/v2/actions/watch
Request Method: PATCH
Scope: ZohoCRM.notifications.ALL/WRITE/UPDATE
Mandatory parameter: channel_id
All other information like the input structure, limits are similar to the previous example.
Disable Notifications
Use this API to disable all (DELETE) or specific details (PATCH) of the notifications that you have enabled for a channel.
Request URL: {{api-domain}}/crm/v2/actions/watch
Request Method: DELETE/PATCH
Scope: ZohoCRM.notifications.ALL/WRITE/DELETE
Mandatory parameter: channel_ids (comma-separated channel IDs)
Example:
{{api-domain}}/crm/v2/actions/watch?channel_ids=10000007828,10000007000
Here is a sample input to disable specific notifications in a channel (PATCH).
{ "watch": [ { "events": [ "Contacts.create" ], "_delete_events": true } ] } |
The following table gives you the details of every key in the input.
Key and Data Type | Description |
channel_id (mandatory) Integer | The unique ID of the channel that you want to update or delete. |
events (mandatory) JSON array | The module API name (from the module metadata API) and the operation type (all, create, edit, and delete) that you want to disable notifications for. |
_delete_events (mandatory for PATCH) Boolean | Indicates whether you want to delete the events mentioned in the input. true deletes all the notifications for the events; false or not specifying this key in the input does not disable notifications. |
Note
- The DELETE request deletes the channel and the notifications enabled for that channel.
- The PATCH request deletes only the events you specify in the events array, provided you have set the value for the _delete_events key as true.
We hope you found this post useful. Let us know your thoughts in the comment section or write to us at support@zohocrm.com.
Cheers!
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
Shylaja S
Ricardo
Jaya Suriya J
David
Phuong
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
Public Forms for an all-inclusive feedback system
The more we seek information from the customers, the more we solve their needs and gain their trust. However, reaching out to every customer to seek requirements, solve their issues, and gather feedback can be tasking. Circulating a public form helpsHow to embed event list page from Backstage onto my site
I'd like to embed the events list page from Zoho Backstage ( https://biz2bizlinksevents.zohobackstage.com/events) into my site, but when I use an iframe it says the page refused to connect. My other iframes with microsites from Zoho recruit and formsFunction #40: Notify users when invoices exceed the credit limit
Hello everyone, and welcome back to our series! Businesses tend to offer goods or services on credit to customers, which can, in overtime, lead to the accumulation of significant overdue balances. To address this, Zoho Books allows you to define a CreditZoho CRM - Kiosk Studio: Build Once, Execute Multiple Times with Loops
Hello Everyone, Introducing Loop Functionality in Kiosk Studio. If you've ever built a Kiosk that needed to perform the same action multiple times like updating a list of contacts, scheduling calls for a batch of leads, or processing multiple productsThe 3.1 biggest problems with Kiosk right now
I can see a lot of promise in Kiosk, but it currently has limited functionality that makes it a bit of an ugly duckling. It's great at some things, but woeful at others, meaning people must rely on multiple tools within CRM for their business processes.Manual Journal not affecting the YE Trial Balance
I have done a manual journal moving an expense from prior year to current year. However, it is not affecting the prior year figures at all, when I go to the expense the journal isn't even reflecting at all. I have made sure dates are correct and bothTip #82 – Let Zia Answer Bot Handle the Questions So You Can Focus on the Fix – 'Insider Insights'
Hello Zoho Assist Community! Imagine you're in the middle of a critical remote session. The customer is waiting. You need a quick answer about a known issue or a standard fix documented somewhere in your knowledge base, but hunting through articles mid-sessionCaso de Éxito: Namencis Education crece un 117% con Zoho One
"Hemos estado creciendo en torno a un 117% al año, que es una barbaridad. Tuvimos una rentabilidad del 33%, que antes no teníamos ni por asomo. Escalamos en tres años lo que no habíamos escalado en los anteriores siete." Borja Domínguez, CTO de NamencisIntroducing Workqueue: your all-in-one view to manage daily work
Hello all, We’re excited to introduce a major productivity boost to your CRM experience: Workqueue, a dynamic, all-in-one workspace that brings every important sales activity, approval, and follow-up right to your fingertips. What is Workqueue? Sales[IDEA] Bring Layout - Conditional Rules and Client Scripts to Zoho Books
The problem We run Zoho Books with two e-invoicing integrations: myData (Greek tax authority, AADE) and PEPPOL (EU e-invoicing). Between the two, our Invoice form carries a large number of custom fields — document type codes, VAT exemption categories,Introducing the Revamped Zoho Projects Chrome Extension
Zoho Projects Chrome Extension brings your project management capabilities directly to your browser. Users can access all their portals, create tasks, file issues, log time, and stay updated on project activities without navigating to the main application.Bigin Android app update: Alerts while creating tasks outside of working days, conflicting events and calls.
Hello everyone! In the most recent version of the Bigin Android app, we have brought in support to display an alert if task is being scheduled outside of the working days. Also, when scheduling an event or call in the Activities module, a conflict alertCreate modules using natural language prompts
Hello all, We’ve introduced a new enhancement to Zia that allows you to create custom and team modules in Zoho CRM using plain language prompts. Why this enhancement? Creating a custom module traditionally involves multiple steps—choosing field types,Assign account to a ticket created with WebToCase
We use Zoho Desk. Our large client uses WebToCase form to submit tickets. I have two workflow rules: When a contact is created and its email ends with example.com, it runs a custom function, which assigns the new contact the right account Example withCollapsible Sections & Section Navigation Needed
The flexibility of Zoho CRM has expanded greatly in the last few years, to the point that a leads module is now permissible to contain up to 350 fields. We don't use that many, but we are using 168 fields which are broken apart into 18 different sections.Can the SEO Keyword field be increased from 100 characters to the industry standard 160 characters
Hello, Currently Commerce restricts the SEO meta-keywords to 100 characters, which I'd always found to be a bit constraining, often times not enough space to suit my needs. I recently discovered however that search engines will accept up to 160 charactersCookies Consent Management in Webforms
Hello Everyone! We are excited to introduce Cookie Consent Management for webforms. Read on to learn more. Webforms are online forms embedded on websites that allow users to submit data and create records in Zoho CRM. These forms utilize cookies to trackTrigger workflows from SLA escalations in Zoho Desk?
Hey everyone, I’m currently working with SLA escalation rules in Zoho Desk and ran into a limitation that I’m hoping someone here has solved more elegantly. As far as I can tell, SLA escalations only support fairly limited actions (like changing the ticketComo exportar la base a excel sin perder datos
Estimados quisiera saber como exportar o descargar la base de tickets para hacer estadisticas sin perder datos al copiarShow my cost or profit while creating estimate
Hi, While creating estimate it becomes very important to know exact profit or purchased price of the products at one side just for our reference so we can decide whether we can offer better disc or not .Mise à jour de Zoho Books – France
Chers clients, Merci pour votre patience et votre soutien continu. Avec les évolutions réglementaires à venir en France nous introduisons de nouvelles fonctionnalités dans Zoho Books pour les clients français. Ces mises à jour ont été conçues pour répondreIs 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? ThanksConnect ZOHO social with Google Data Studio and download data from ZOHO social
Dear ZOHO team, I am writing this message to enquire about how to connect ZOHO social with Google data studio since our company would like to use Google data studio to generate reports. Is it a way to download data from ZOHO social? Best regards, ChrisZoho People Whats New - Q2 2026
Hello Users! We're excited to share the latest updates introduced in Zoho People during Q2 2026. This release brings a range of new features and enhancements designed to simplify HR operations, automate routine processes, and deliver a smarter, more connectedManage booking pages from your Android phone
Hello everyone! We are happy to announce that users can now add and manage booking pages from their Bigin Android app. It is a multi-step form that users can create for purposes like booking appointments, scheduling calls or meetings, conducting webinars,Zoho Team Inbox - roadmap
Hi, would be good to understand the Teaminbox roadmap, in particular: 1. API / Zoho Deluge connections. We have a process where the each email needs to be either tagged or assigned daily. It would be great if we could automate a 5pm alert for any exemptionsZoho CRM Community Digest - July 2026 | Part 1
Hello everyone, July is here! The first two weeks brought six CRM updates ranging from privacy-ready webforms to a significantly more powerful Layout Rules engine, two community wins worth a look (a dashboard workaround for spotting leads with no activities,How do I migrate from Office 365 to Zoho Mail?
Check out Advik Email Migration Wizard, this software is specially developed to move mailboxes from Office 365 to Zoho Webmail. In addition you can migrate from Gmail, Yahoo, Rediffmail and 80+ webmail servers to ZOHO MAIL. Isn't it amazing? This is an all in one email migration solution. Steps to export emails from Office 365 to Zoho Webmail are as follows; Run Advik Email Migration Tool in your system. Select Office 365 as source and enter its login credentials. Select mailbox folders and chooseTopics not loading in individual contact records in Zoho Marketing Automation
When working correctly, an individual contact record in ZMA shows a "Topics" section in the "Subscription" tab of the individual record. However, in 2+ different Zoho accounts and different browsers, the "Topics" section doesn't load and instead it spinsHelp: Capture full page URL in hidden field when same Zoho Form is embedded on multiple pages (iframe)
Hi all, Goal Use one Zoho Form across multiple pages and record the exact page URL (incl. subdomain + path + hash) where the user submitted it. Example pages: https://www.example.com/cargo/ https://www.example.com/cargo/containers/#contact https://cargo.example.com/auto/how to get transcripts with speaker and time marks?
Hello, I downloaded the transcript of a recent meeting and noticed that the TXT file does not bring the speaker name and the time mark. Is there any way to make it happen using ootb resources from Zoho Meeting? bestSalesIQ'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 conversationCannot deploy digital employee-
I followed the guide here https://help.zoho.com/portal/en/kb/salesiq-2-0/for-administrators/operators/articles/zia-agents-in-zoho-salesiq#Supported_SalesIQ_Tools but no matter how many times I try I cannot for the love of god make it work I get this errorDisplaying only unread tickets in ticket view
Hello, I was wondering if someone might be able to help me with this one. We use filters to display our ticket list, typically using a saved filter which displays the tickets which are overdue or due today. What I'd really like is another filter that【受付開始】Zoholics Japan 2026 開催のご案内
Zoho が年に一度開催するユーザー向けイベント「Zoholics」。 今年は 「AI-Powered DX with Zoho」 をテーマに、2026年9月25日（金）に 東京駅直結の会場とオンラインのハイブリッド形式で開催します。 今すぐ申し込む AIの活用が加速する今、業務効率化やDX推進に取り組む企業にとって、 「どのようにAIを業務へ取り入れ、成果につなげるか」が重要なテーマとなっています。 Zoholicsでは、Zohoの最新AI機能や製品アップデートに加え、実際の活用事例や業務改善のヒントをご紹介します。Print checks for owner's draw
Hi. Can I use Zoho check printing for draws to Owner's Equity? This may be a specific case of the missing Pay expenses via Check feature. If it's not available, are there plans to add this feature?Reconciliation: don't auto-select transactions outside the entered Period
When initiating a reconciliation for a defined Period (say April 1 to April 30), Zoho Books auto-checks transactions whose Statement Detail dates fall after the period end date. With "Show based on grouped bank statements" enabled (the default), the screenHow can be requests for new job managed in Zoho recruit?
If we use both Zoho people and recruit, can our managers (heads of department) use Zoho products to create requests for new job to HR department? The current workflow is following: a head of department needs some extra HR, he creates a request describing the job and send it to HR director, HR director approves a request and forward to a HR manager. I see only one way to partly solve the problem - grant the heads of departments recruit administrator permissions, so they could create new jobs. It isCan't view nor download attachments
Me and a number of people I know suddenly stopped being able to either view nor download attachments that arrive in new emails we receive since this morning. Older emails work just fine and we can download/view them. Zoho Mail states the it wasn't ableLinking the Overview window between reports on a dashboard
Is there a way to link the Overview window for two or more charts on a dashboard? We have several dashboards where users often want to set the window for 3 or 4 reports to the same time period. Doing it manually is time-consuming and cumbersome, but INext Page