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
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 #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | 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 theKaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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 #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.
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
Kaizen #213 - Workflow APIs - Part 1
Welcome to another week of Kaizen! If you have ever managed complex business processes, you know that Workflows are the quiet backbone of any well-run business process. They keep things moving; assigning owners, sending alerts, keeping deals on track,Browser and address bar hide
Hi, How i can do hide the address bar with browser headline when i am working on the sheet, because i am using (freeze panes) which i want visible for full work. For your reference here i am attached the screen shot and marked yellow lines which reallyCells Border
Hi I am using Zoho Sheet on S Tab , is there any option to make all border of any cell at once. I think this is very basic which we are missing. This is available in mobile but not in tab or suggest if i am missing this function. And for Tab can you giveCredit Management: #2 Configuring Right Payment Terms for Credit Control
Think about the last time you ordered something online and saw that little note at the checkout, "Pay on Delivery" or "Pay later". It's simple, but it actually sets the tone. As a business owner, you know exactly when payment is expected. Now, imagineZobot and Sales IQ
What will happen to the Zoho Sales IQ being integrated to the website after creating the Zobot on the website tooWorkflow workdrive rollout
Hi! When will workflow be rolled out to all users? Thanks.Help Center and SEO: Any Benefit to My Domain-Mapped Website Ranking?
First of, I love the Help Center which I've just decided to integrate into my website to replace its old-fashioned FAQs. So much more to achieve there now! Lots of new benefits to the site visitors and to me in terms of organizing and delivering all theBlueprint status change
I want to change the Blueprint status of a workflow. The status is completed automatically when I added the record through API call. But I want to make it active, I don't see any options for this. Even if I draw transition from any stage , it is not visibleSupport french language options
Greetings, I want to use Zoho with the french language portal, however the supplied translation is not very good (google translate). There are many basic mistakes on the main most important sections (my requests, submit a request). Is there a way forAutomation #7 - Auto-update Email Content to a Ticket
This is a monthly series where we pick some common use cases that have been either discussed or most asked about in our community and explain how they can be achieved using one of the automation capabilities in Zoho Desk. Email is one of the most commonlyfilter broke my data
I uploaded a file recently from Sheets and it has top 2 rows frozen, with table headers in second row and each one is filterable. somehow my first 2 columns became unfiltered and no matter what I do I cannot reapply the filter?? also didn't realize theyIntroducing the Workflow and Actions APIs for Zoho CRM
We are absolutely thrilled to announce the release of Workflow APIs and Actions APIs in Zoho CRM’s v8 API suite! This powerful new set of endpoints gives developers unprecedented programmatic control over business automation. For years, Workflow RulesZoho CRM Analytics - Allow To Reorder Dashboards
I would like to suggest that you add the ability to reorder dashboards in the Analytics Module. I can see that this has been requested some time ago, the latest 9 years ago. I am not sure if this is a big or small endeavor, but such a small fix can goZoho Form URL displays incorrect name
Hi, I have a form I created called "Design Request form". It displays this way everywhere I look. However, in the URL, it shows up as "DesignJobRequestFormFINAL011325PROOFV1B" and I'm not sure why. I can't find where to fix this. Does anyone have anyConsumers are talking about your business. Are you listening?👂
A loyal customer might be praising your product in a forum. A frustrated user could be posting a harsh review on a public site. An excited partner may have left a comment on your campaign. A domain expert might be deconstructing your product. A prospectWhat counts as a Temp for Billing Purposes in Workerly
I'm considering trying this product but am not sure how the temp count is used for billing purposes. For example, if we keep a large data base of 500 potential workers.....are we billed for that or only if they are assigned to a client at a given pointForm name incorrectly displayed in URL
Hi, I have a form I created called "Design Request form". It displays this way everywhere I look. However, in the URL, it shows up as "DesignJobRequestFormFINAL011325PROOFV1B" and I'm not sure why. I can't find where to fix this. Does anyone have anyI can't receive mail
Hello, I can't receive e-mail. I no longer receive e-mails to the e-mail I received for my site. I also edited the DNS settings, but it doesn't work at all.1‑to‑1 invite missing post-setup (needs re-invite) vs channel invite auto-joins without business prompt
1. Zoho Cliq 1‑to‑1 external invite The inviter sent a 1‑to‑1 invite to an invitee who didn’t have a Cliq account. After the invitee completed account setup and created a business/organization, the website redirected them to Cliq, where they opened Cliq【開催報告】東京 ユーザー交流会 Vol.3 2025/10/17 Zoho サービスの活用促進を外部ツールとの連携で実現！
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 10月17日(金)に新橋で「東京 ユーザー交流会 Vol.3」を開催しました。ご参加くださったユーザーの皆さま、ありがとうございました！ この投稿では、当日のセッションの様子や使用した資料を紹介しています。残念ながら当日お越しいただけなかった方も、ぜひチェックしてみてください😊 ユーザー活用事例セッション：Zoho Flowと決済システムの連携 あみろくの岡島さんに、Zoho サービスの活用事例として、Zoho Flow を活用した外部サービスとの連携事例をご共有いただきました。received email opens in a new tab every time I log in
as per the title: since about when I first made my email account, every single time Ive logged in to view my inbox, a new tab opens for an email I viewed once as if restoring a closed session. I thought I just didnt understand the "starting up" settingsEngage with your customers at scale using WhatsApp Marketing Template messages
Hi everyone, To make it easier for organizations to communicate with customers, Desk now allows you to send individual, mass, and bulk WhatsApp template messages from both the Ticket and Contact modules. How is this going to benefit your business? WhatsAppImportation Tickets error
Hi, I'm newbie here 🤓 So, i'm importing data from csv, but when I try advance to mapping fields the importer tool show this message: Previously I try import, other data, and not show errors in this step. Some ideas? Best Regards,Showing description in timesheet and timelogs.
I am wondering if it’s possible in version 5 of Zoho People to have the description show by default or with a manipulation on the user’s part. Let me show you what I mean. As you can see this is the view for the users. Now if they want to see the fullDirect “Add to Google Calendar” Option in Zoho Meeting
Hello Zoho Meeting Team, Hope you are doing well. We would like to request an enhancement related to the “Add to Calendar” functionality in Zoho Meeting. Currently, when we open Zoho Meeting and view our meetings under My Calendar, there is an Add toAdd Flexible Recurrence Options for Meeting Scheduling in Zoho Cliq (e.g., Every 2 Weeks)
Hello Zoho Cliq Team, We hope you are doing well. Currently, when scheduling a meeting inside Zoho Cliq, the recurrence options are limited to Daily, Weekly, Monthly, and Yearly. There is no ability to set a meeting to occur every X weeks — for example,Workaround: openURL in Blueprints - An alternate approach
There is a roundabout way to open a URL in blueprints after a save event. By using the 'onBeforeMandatoryFormSave' in Client Script, you can open an external URL. Now, the problem is, this is designed to be run BEFORE the blueprint is saved, not after,MTD SA in the UK
Hello ID 20106048857 The Inland Revenue have confirmed that this tax account is registered as Cash Basis In Settings>Profile I have set ‘Report Basis’ as “Cash" However, I see on Zoho on Settings>Taxes>Income Tax that the ‘Tax Basis’ is marked ‘Accrual'Migrate file from Single File Upload to Multi File Upload
Dears, I have created a new field Multi File Upload to replace the old Single File Upload field. I'd like to ask you guys what is the best way to migrate the files to the new field?Open "Live Chat" from a hyperlink?
Hi, I often write paragraphs and text on our company website, and usually say you can get in touch with us via live chat. Can the chat window be triggered to pop open without clicking the chat graphic in the bottom window, and use it in a hyperlink? ie:Zoho Sites search box
Is there a Search box that can be added to a Zoho site? It would be for searching within the site only.What stops me from packaging and shipping an order when the inventory is negative?
It seems if the inventory value is negative, that Zoho Inventory should not allow me to create a Package and Ship it. But, there seems to be nothing to stop me from doing that other than when I go to physically package the item and realize that there is no stock. There also seems to be nothing on the screen that even indicates to me that I should not package and ship. To me this is the fundamental point of an inventory system. Am I doing something wrong?Conditional formatting based on another field
Hi I have two fields on my form stage 1 complete and stage 1 deadline. I am trying to setup conditional formatting so that if stage 1 complete is after stage 1 deadline the record is highlighted in red. I need both stage 1 complete and stage 1 deadlineIs there API Doc for Zoho Survey?
Hi everyone, Is there API doc for Zoho Survey? Currently evaluating a solution - use case to automate survey administration especially for internal use. But after a brief search, I couldn't find API doc for this. So I thought I should ask here. ThanUsing IMAP configuration for shared email inboxes
Our customer service team utilizes shared email boxes to allow multiple people to view and handle incoming customer requests. For example, the customer sends an email to info@xxxx.com and multiple people can view it and handle the request. How can I configureThe sending IP (136.143.188.15) is listed on spamrl.com as a source of spam.
Hi, it just two day when i am using zoho mail for my business domain, today i was sending email and found that message "The sending IP (136.143.188.15) is listed on https://spamrl.com as a source of spam" I hope to know how this will affect the deliveryChanging a Single-Line Text field into a Multi-line Field without losing data
Is it possible to change a Single-Line Text field into a Multi-line Field without losing data. I have a module with data for which I would like to change a single-line field into a multi-line field but I'm worried it might delete the pre-existing daWebhook - Google Sheets
I have 2 forms that are both integrated with Google Sheets. I've set up a webhook to pull form 1 data from Google Sheets to prefill data in Form 2. The issue I have is that the forms name fields are First Name & Last Name but the Google sheets integrationVerified Mark Certificate
Hello Dears, Can anyone help and check my mail or direct me to the desired person who can add the verification tag to my mail https://www.zoho.com/blog/mail/email-authentication-with-bimi.htmlAppointment booking is temporarily unavailable
Embeded Zoho booking page in my WordPress website. When someone starts a booking, after choosing time and date, an error appears before payment - "Appointment booking is temporarily unavailable due to restricted settings." Used the embeded code givenNext Page