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
mail did't send for particular email
mail did't send for particular emailGroup settings in Zoho Mail: Manage members, moderation, and spam controls for your organization's groups
When teams rely on group email addresses like team@org.com, hr@org.com, or sales@org.com, managing them without clear controls leads to unapproved senders, flooded inboxes, and no accountability over what gets delivered. Zoho Mail's Group settings inUpdate to Free plan attendee limit
Hi everyone! A quick update about Zoho Webinar's Free plan. We’ve adjusted the Free plan attendee limit from 100 to 20 attendees. Everything else in your Free plan stays the same; you'll continue to have access to all your existing features. If your webinarsPossibility to modify a standard wedget to create my own customized wedget
Below is the std wedget available for dashboard which is great to show the the overdue, current, and all tasks as well as issues for each team member. My problem is this; The list of users cannot be edited (there are admin users which are not relavantFeature Request: Include Creator-applicable Deluge updates in the Creator Release Notes
I'd like to put forward a suggestion about how Deluge updates are surfaced to Zoho Creator developers, and I'm hoping the Creator team will consider it. Zoho Creator is built on Deluge. Every workflow, custom function, validation and schedule we writeAdd home page or dashboard in CRM customer portal
is it possible to add home page or dashboard in CRM customer portal?Close task on Completion Date entry
This discussion is similar to my issue: "backdated-task-completion-date" discussion Scenario: A bunch of tasks have been completed. But, they have not been closed. Time goes by You finally get around to closing those tasks Projects assigns the date theIntroducing Color and Order Preferences for Blueprint Transitions
Blueprints exist to improve the efficiency of your company's processes and ensure compliance — but only if your users follow them promptly. More often than not, your users may find it challenging to adopt your processes and follow through on them, especiallyGroups and Moderation
Hi, I have set up a Group in my organisation but am having trouble with moderation. The members are a mix of addresses within the organisation and external emails addresses. The issue is how to set moderation to be off whenever any of the members sendsIntroducing Radio Buttons and Numeric Range Sliders in Zoho CRM
Release update: 1. 2 March 2026: Currently out for CN, JP, AU and CA DCs (Free and standard editions). For other DCs, this will be released by mid-March. 2. 26 March 2026: CA, SA, AU, JP, CN DCs - Free, Standard, Professional, Enterprise, Ultimate, CRMZoho CRM Sandbox now supports integrations
Hello everyone, We are now expanding Zoho CRM Sandbox to support integrations with other Zoho products. You can connect, configure, and validate the behavior of your integrated tools within a safe, isolated environment - testing end-to-end without touchingArchiving Contacts
How do I archive a list of contacts, or individual contacts?Introducing the New Zoho Assist Quick Support Plugin
We are thrilled to announce the new Zoho Assist Quick Support Plugin, the upgraded and enhanced version of the Zoho Assist Customer Plugin. This new plugin allows organizations and IT administrators to deploy it directly onto their customers’ devices,What's New - June 2026 | Zoho Backstage
Hello everyone! We’ve rolled out a new set of improvements across Zoho Backstage to help you manage events more efficiently and provide a better experience for your attendees. Take a look at what’s new in this month’s update. Assign attendees later andMore Zia AI capabilities are included across additional Zoho Desk editions
Hello everyone, We are expanding the availability of AI-powered features in Desk to the other paid subscriptions from 7th July 2026. Right now, the following AI-based features are available for Enterprise edition users: Intelligence: Sentiment analysis,Summer release '26 should be called Enterprise Summer Release '26
Summer release '26 should be called Enterprise Summer Release '26 because almost all updates or the more useful ones, are limited for Enterprise subscriptions. us with Basic or Premium susbcriptions are basically left in the cold.Previous conversation title on new messenger widget translation
The title of previous conversations title on the new messenger widget personalisation appears in english even when spanish is selected as default languageExport Tickets from the Help Center
Hello everyone! We are now allowing end users to export tickets directly from the help center. The ticket export allows users to: Filter tickets by Department, Priority, and Account before exporting. Download files from Export History (Setup > Data administrationAccount Duplication Control in Zoho CRM
The Goal Prevent users from creating duplicate Account records in Zoho CRM. Accounts should be sourced from ERP and synced into Zoho—no. Allow to create Accounts if they don't exist in our ERP. What I've Implemented removed Account creation permissionsError 1011 saving website personalisation — blocking all changes (corrupted "home_page.content" field)
When trying to save changes under Settings → Brands → MY COMPANY → Website → Personalisation → Messenger, I receive the following error: "Either the request parameters are invalid or absent" upon checking on the developer console of the browser I getCanvas View: Add font family selection (incl. Google Fonts / Hebrew & RTL fonts)
Hi Zoho CRM team, The Canvas design suite (List View, Tile View, Table View and Record Detail) currently allows customizing font weight, size, color, alignment and case - but there is no option to choose the font family. All text is rendered in the built-inThis user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
Hello, Just signed up to ZOHO on a friend's recommendation. Got the TXT part (verified my domain), but whenever I try to add ANY user, I get the error: This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details I have emailed as well and writing here as well because when I searched, I saw many people faced the same issue and instead of email, they got a faster response here. My domain is: raisingreaderspk . com Hope this can be resolved. Thank youIssue embedding image Zoho Books email signature
I am trying to embed my company logo to my email signature using the image url tool on the settings but I keep getting the following error: Enter a valid public image URL I am using a public link from either WorkDrive or OneDrive and I still get the sameE-Mail Distribution List
How do I create an e-mail distribution list in Zoho Mail?Tip #80- Secure Connect: Add an Extra Layer Before You Connect – 'Insider Insights'
Tip 80 – Secure Connect: Add an Extra Layer Before You Connect – 'Insider Insights' Hello Zoho Assist Community! Picture this: your support team relies on unattended access to keep the business running. Servers need overnight patches. Remote workstationsBusiness Whatsapp is not Showing
I’ve attached a screenshot from the Zoho CRM Android app when clicked the call button. It is showing Personal WhatsApp, which is not installed on the phone. Also, the installed WhatsApp Business account is not showing.How to access a unified inbox for more than one zoho accounts (using paid workplace services)
Hello, we are using zoho for a few months and also suggest your services, setting them up for our clients. Several from our clients, our company as well, use more than 1 email addresses. Using the web version, we are only able to add them as accountsModify a standard wedget to create my own customized wedget ?
Below is the std wedget available for dashboard which is great to show the the overdue, current, and all tasks as well as issues for each team member. My problem is this; The list of users cannot be edited (there are admin users which are not relavantAdvanced Formatted Resume Templates for Applications
Advanced Formatted Resume Templates can now be created and used directly from the Applications module, with support for application module fields. Until now, Advanced templates were limited to the Candidates module. That meant resumes generated from ApplicationsZoho Books | Product updates | July 2026
Hello users, We’re excited to bring you the latest updates in Zoho Books for July 2026! This month's release introduces Terminal Payments, CMP-08 filing for composition taxpayers, SEPA Credit Transfer support, the new Receipts and Payments Report forBoost your CRM communication with new font types, sizes, and default reply-to options while composing emails
Hello Everyone, We’re excited to introduce a series of impactful enhancements to the email composer settings in Zoho CRM. These updates enable you to personalize and optimize your customer interactions with greater efficiency. So what's new? Add customZoho CRM Community Digest - June 2026| Part 2
Hello Everyone! Welcome to the second half of our June Zoho CRM Community Digest! We are keeping the momentum going with powerful updates to filter out unnecessary email syncs, a revamped CRM Import tool, smarter follow-up updates in cadences, and ZiaMigrate from Zoho Mail to G Suite
I am unable to find any documentation on how one can migrate from Zoho Mail to another platform, like G Suite or Office 365. Please point me to the right documentation. Thank you.Zoho Desk Android app - Option to set an email template as default
Hello everyone! We have enhanced the Email Template section in our app by introducing the ability to set a template as default directly from the Zoho Desk Android app, making it easier to access your preferred template without repeated manual selection.Zoho Desk Android and iOS app update: Odia Language
Hello everyone! We have now brought in support to access the Zoho Desk app in Odia language. Please update the app to the latest version directly from the Play Store/ App Store or using the links below: Zoho Desk - Play Store Zoho Desk - App Store OnceHow to check Leads with no Task (open activity)
Hi everyone, I was wondering if there’s a way to view leads that don’t have any tasks assigned or open activities linked to them.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 chooseBridging the gap between incident management and project delivery
As an organization, you can have structured backup plans to handle issues that arise during project execution. Despite best efforts, even efficient processes can fall into an escalation trap where a red flag travels up the tiers but no real action follows.Update on default settings for AI features in Cliq
Hello all, We'd like to provide clarity on a recent change to AI feature defaults in Cliq. As part of our regular review of AI features conducted in April 2026, we re-evaluated how these features are enabled by default. We've decided that the AI featuresAssociate Zoho Billing Invoices with multiple Zoho FSM Work Orders
Hello Latha, We are writing a custom Deluge automation script in Zoho FSM to handle monthly consolidated billing. The script successfully compiles line items from multiple completed Work Orders, interfaces with the Zoho Billing API, and generates a singleNext Page