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
What's New in Zoho Billing | January 2026
Excited about the latest enhancements in Zoho Billing? Our January updates bring an intelligent AI assistant, smarter subscription management, and improved tax compliance, saving you time and reducing manual work. Dive into the details below to see howZoho Books Sandbox environment
Hello. Is there a free sandbox environment for the developers using Zoho Books API? I am working on the Zoho Books add-on and currently not ready to buy a premium service - maybe later when my add-on will start to bring money. Right now I just need aMulti-currency and Products
One of the main reasons I have gone down the Zoho route is because I need multi-currency support. However, I find that products can only be priced in the home currency, We sell to the US and UK. However, we maintain different price lists for each. ThereCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsCOQL API in JS Widget only pulling 200 records
Hello! We've been building a custom homepage widget using the Zoho JS SDK, and it seems that this https://help.zwidgets.com/help/latest/ZOHO.CRM.API.html#.coql only allows 200 records. I thought the limit was 2000 for COQL queries, but am I mistaken?Passing the CRM
Hi, I am hoping someone can help. I have a zoho form that has a CRM lookup field. I was hoping to send this to my publicly to clients via a text message and the form then attaches the signed form back to the custom module. This work absolutely fine whenPaid Support Plans with Automated Billing
We (like many others, I'm sure) are designing or have paid support plans. Our design involves a given number of support hours in each plan. Here are my questions: 1) Are there any plans to add time-based plans in the Zoho Desk Support Plans feature? TheDo buttons and vba msgbox work on mobile, specifially the iPhone zoho sheets app?
In Zoho sheets on the web, I inserted a button and assigned a VBA macro to it. It pops up a msgbox with some text. When I go onto the iPhone mobile zoho sheets app, the button is there. When I click on that button, the spinning asterisk appears for aDifferent form submission results for submitter and internal users
I'm looking for suggestions on how to show an external submitter a few results while sending internal users all the results from the answers provided by the external user. The final page of our form has a section with detailed results and a section withColumn letter from number
Hello, I am trying to select a cell and i have the column number. How do i do this or is there a way of getting the letter from the number? Thank youHelp Desk Services Solution
I am here looking for Help Desk services solution for organization. I also searched this on many different website and found many solutions. We are bit confused to which one to choose. One of my friend suggest me this platform, and i am hoping i willFacing Issues with Sites Mobile font sizes
my page renediaz.com is facing issues mobile view, when i try to lower font sizes in home page, instead of changing the size, it changes the line spaceZOHO Payroll Canada
Any plans on the roadmap for Canada?Remove 'This is an automated mail from Zoho Sign' in footer
Hi there, Is it possible to remove or change the text under the e-mail templates? I can't figure out how to do that: Would love to hear from you. Kind regards, TristanFormatting and slow
Creating campaigns are difficult. I'm fairly computer literate but some of the way Zoho Campaigns formatting works is painful. Images fail to upload or are very slow. To top it off, syncing the contacts is a pain as well as temperamental links to create Segments. At this rate I'm afraid we might need to migrate back to Mailchimp.Default Ticket View - Table?
Guys, We mostly use the table view to queue tickets. Maybe I am missing it - but how can I set that view as 'default" for all our agents? Thanks JVBoost your Zoho Desk's performance by archiving tickets!
The longer your help desk operations are, the more likely it is to accumulate tickets that are no longer relevant. For example, ticket records from a year ago are typically less relevant than currently open tickets. Such old tickets may eventually leadPaste emails to create segment
We are moving over from Mailchimp to ZOHO. However Mailchimp allows me to create a segment by pasting in emails from excel (or importing a .csv) can I do the same in Mailchimp?Getting the Record ID of a form once it is submitted - so that form can be edited later
In Zoho Forms, where can I access the record ID of a form once the form is submitted? - Record ID is not available in webhook payloads - It is not available to form fields, including in formulas - It is not available as a parameter in a thankyou pageAuto-Generate Line Numbers in Item Table Using HTML & CSS Counters (Zoho Books & Zoho Inventory Custom Templates)
<div> <style> /* Start counter from 0 inside tbody */ tbody#lineitem { counter-reset: rowNumber; } /* Increment counter for each row */ tbody#lineitem tr { counter-increment: rowNumber; } /* Show counter value in first column */ tbody#lineitem tr td:first-child::beforePossible to define default font and size in Zoho Campaigns?
Is it possible to define a default font (font, size and colour) for the text, H1 and H2 in Zoho Campaigns? For example: In a campaign, I add a text block, and the text is automatically century gothic, size 11, grey (6f6f6e) by default? Thank you!Zoho Sites - General Feedback
Hi Everyone-- Quick question for discussion: is it me or is working with Zoho Sites like entering the Twilight Zone? I've built many sites over the years, but this platform seems impossible. I've spent an entire day and a half trying to get a simple one-colorFile Upload field not showing in workflow
Hi, I have added a field on Zoho CRM. I want to use it in a workflow where that particular field is updated based on another field, however it is not showing up in the field list to select it in the workflow. Why is this please?You cannot send this email campaign as it doesn't have any eligible contacts in the selected mailing list. You can try adding contacts or choose other mailing lists.
please helpStrengthening the capabilities of CommandCenter in Zoho CRM Plus
When you look at the prospect-to-customer journey in most businesses 10 to 15 years ago, it was relatively straightforward. Many of us remember walking into a store, sharing our requirements with a sales associate, reviewing a few options, and makingWorld date & time format
Hello, Is there a timeline to get the worldwide used date and time format ? I mean not the american one... I mean day month year, and 24 hours clock. RegardsHow can Data Enrichment be automatically triggered when a new Lead is created in Zoho CRM?
Hi, I have a pipeline where a Lead is created automatically through the Zoho API and I've been trying to look for a way to automatically apply Data Enrichment on this created lead. 1) I did not find any way to do this through the Zoho API; it seems likeAnnouncing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.
Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,Any recommendations for Australian Telephony Integration providers?
HI, I am looking for some advice on phone providers as we are looking to upgrade our phone system, does anybody have experience with any of the Australian providers that integrate with CRM Telephony? So far we are looking at RingCentral and Amazon Connect, and would love to hear feedback on any of the other providers you might have tried. Thank youCRM Cadences recognise auto-responses
I have leads in a Cadence. I get an auto-responder reply "I'm out of the office..." Normally Cadences seems to know that isn't a real reply and keeps the lead enrolled in the cadence. However, today, Cadences has UNENROLLED a Lead who sent an auto-reponseZoho Campaigns Workspaces
Hi, I’m currently working on a Zoho CRM + Zoho Campaigns setup for a franchisee-based organization, where each franchise must only see and use its own contacts. At the moment, franchisees cannot properly access their contact lists in Zoho Campaigns unlessLimited System because of Limited Number of Fields for Car Dealership
Dear Zoho Support, we want to have all the information about a car inside of a car record. We want to have Zoho CRM as our single source of truth for our data, but the limited number of fields are not allowing that. The data consist of: technical dataAutomatically Update Form Attachment Service with Newly added Fields
Hi, When I have a Form Setup and connected to a 3rd Party Service such as OneDrive for Form Attachments, when I later add a new Upload Field I have to remove and redo the entire 3rd Party Setup from scratch. This needs to be improved, such as when newZoho CRM for Everyone's NextGen UI Gets an Upgrade
Hello Everyone We've made improvements to Zoho CRM for Everyone's Nextgen UI. These changes are the result of valuable feedback from you where we’ve focused on improving usability, providing wider screen space, and making navigation smoother so everythingNewsletter in multiple languages
Hi We are planning on starting to use Zoho Campaigns for our newsletters. Since we send our newsletters in three languages, I would need the "unsubscribe page" and other pages related to the NL (Thank you page and so on) to be available in different languagesFixed assets in Zoho One?
Hi, We use Zoho Books and have the fixed asset option in it. I started a trial for Zoho One and I do not see that as an option. Is the books that is part of zoho one equivalent to Zoho Books Elite subscription or is it a lesser version? Thanks, MattSet Default Status of Assembly to "Assembled" When Entered in UI
I've just discovered the new "confirmed" status of Assemblies within Inventory. While I understand the intent of this (allowing for manufacturing planning and raw material stock allocation), it was initially confusing to me when manually entering someI need to Record Vatable amount and non vatable amount separately in zoho books in a single line
I need to Record Vatable amount and non vatable amount separately in zoho books in a single line give me the customisation option and in invoice copy to customer the total amount should be inclusive 5%vat and no need to show the vatable and non vatableSort Legend & stacked bar chart by value
I'd love to see an option added to sort the legend of graphs by the value that is being represented. This way the items with the largest value in the graph are displayed top down in the legend. For example, let's say I have a large sales team and I createScanned Doc - selecting Item overwrites Rate
I have a Vendor Invoice which was uploaded to Documents. I select Add To > New Bill. The OCR is actually quite good, but it is reading an Item Description instead of an Item Number. I remove the description and select the correct Item Number... and itNext Page