Kaizen 221 - Workflow & Actions Reports APIs
But as their automated ecosystem has grown to nearly 100 workflow rules, a new challenge has emerged for the system administrators: Are these workflows actually doing what they were built to do? Are these automations actually working day-to-day?
A workflow can be perfectly configured yet have no impact if it never runs. A webhook could be sending data to a dead endpoint, or a critical email notification might go silent without anyone noticing.
While the CRM UI allows them to click into any single workflow to see its execution details or check the status of a specific webhook, this data is trapped in dozens of individual screens. To answer strategic questions like "What's the overall health of our automation?" or "Where should we focus our optimization efforts?", they would need to manually open, check, and compile data from over a hundred different places.
This is where the Reporting APIs become indispensable. They allow Zylker to aggregate all this scattered UI data into their central dashboard, which supports proactive governance at scale.
STEP 1: Find workflows with heavy or complex actions
Using Get Actions Count in Workflow Rules
During their initial audit, Zylker noticed something interesting: within the same module, some workflows had just one or two actions, while others had ten or more bundled together. While this inconsistency wasn't necessarily wrong, after years without a cleanup they wanted to review which workflows had become particularly complex and decide whether they needed updating or splitting.
To identify such rules systematically, they call:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/actions/actions_count?ids={id1, id2, id3, ..}
This API returns a detailed count of how many actions each rule contains. Using the response from API, the admins can choose to work on the Workflow Rules by complexity. In the UI, this requires inspecting workflows one by one. But using this API, up to 100 Workflows can be inspected in a single API call. The entire system can be analyzed in a matter of seconds!
Here is what the response looks like:
|
{ "workflow_rules": [ { "id": "4876876000016390024", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions_count": [ { "type": "field_updates", "value": 1 }, { "type": "add_tags", "value": 1 }, { "type": "email_notifications", "value": 1 }, { "type": "webhooks", "value": 1 } ] }, "scheduled_actions": [ { "actions_count": [ { "type": "tasks", "value": 1 } ] } ], "id": "4876876000016390025" } ] }, { "id": "4876876000011208001", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions_count": [ { "type": "assign_owner", "value": 1 } ] }, "scheduled_actions": null, "id": "4876876000011208002" }, { "sequence_number": 2, "instant_actions": { "actions_count": [ { "type": "assign_owner", "value": 1 } ] }, "scheduled_actions": null, "id": "4876876000011208004" }, { "sequence_number": 3, "instant_actions": { "actions_count": [ { "type": "assign_owner", "value": 1 } ] }, "scheduled_actions": null, "id": "4876876000011208006" } ] } // ...other workflow rules omitted for brevity ] } |
The response is a granular breakdown, not just a simple total. For each workflow rule (id), you see every condition (sequence_number). Within each condition, the actions_count array under instant_actions and scheduled_actions lists the type of each action (email_notifications, webhooks, tasks, etc.) and the count (value) of that specific action type in that section.
In simple terms, the API tells us: For every workflow, for every condition, how many actions does it perform, and what kind are they?
STEP 2: Diagnose execution health: Is it working or just configured?
Using get Workflow Rule usage report API
Identifying complex workflows is important, but Zylker’s admins also need to figure out if they are are actually working. This is a crucial part of automation governance.
A workflow might be executing regularly, but an email notification configured inside it may bounce every time. A webhook may silently fail due to a server issue. These operational issues are difficult to detect by simply knowing whether a workflow has executed.
In the CRM UI, admins can click View Usage for a workflow. But this still exposes information one rule at a time and without aggregation across rules. When you operate nearly a hundred workflows, this method does not scale.
To understand action-level outcomes inside a specific workflow, Zylker uses:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/{workflow_rule_ID}/actions/usage?executed_from={from_date}&executed_till={to_date}
This API returns rich statistics, including:
-
how many times the workflow executed
-
how many times each action inside it succeeded or failed
-
delivery metrics for emails (open, sent, delivered, bounced, clicked)
-
scheduled vs. instant action performance
-
which conditions executed successfully
Here is a sample response:
|
{ "workflow_rules": [ { "trigger_count": 3, // Total times this workflow was triggered "name": "High Value Lead Rule", // Workflow name "id": "4876876000013248001", // Workflow ID
"conditions": [ // Usage details grouped per condition { "instant_actions": { "actions": [ //Instant actions execution details { "queue_count": 0, //Asynchronous actions pending for execution in the queue "related_details": { //Email delivery metrics for bulk email_notifications actions "bulk_mail": false, "unopened": 0, "sent_percentage": 100, "opened": 1, "delivered": 1, "unsent": 0, "bounced": 0, "clicked": 0, "sent": 1 }, "name": "High revenue Lead added", //Action name "success_count": 1, // Number of successful executions "failure_count": 0, // No failures for this action "id": "4876876000016390103", // Action ID "type": "email_notifications", // Action type "associated_time": "2025-10-16T16:19:58+05:30" // When this action was added to the workflow }, ...... //omitted for brevity
] },
"scheduled_actions": [ // Scheduled actions usage metrics { "id": "4876876000016390118", // ID of the scheduled action block "actions": [ { "queue_count": 0, //Asynchronous actions pending for execution in the queue "related_details": { //Email delivery metrics for bulk email_notifications actions "bulk_mail": false, "unopened": 0, "sent_percentage": 100, "opened": 1, "delivered": 1, "unsent": 0, "bounced": 0, "clicked": 0, "sent": 1 }, "name": "High revenue Lead added", "success_count": 1, // Number of successful executions "failure_count": 1, // Number of failures "id": "4876876000016390103", "type": "email_notifications", "associated_time": "2025-10-16T16:19:58+05:30" } ] } ],
"usage_count": 2, // The number of times this condition matched "id": "4876876000013248002" // Condition ID },
// more condition blocks omitted for brevity ],
"reset_time": "2025-10-16T16:23:04+05:30" //When usage metrics were last reset } ] }
|
This single API call provides what would take hours of manual UI investigation, i.e., a complete performance audit. By scripting this for their key workflows, Zylker transforms workflow management from a time-consuming manual task to an easy, automated process.
STEP 3: Monitor system-wide integration health
The workflow usage report gave Zylker deep insight into individual workflows. But they still have unanswered questions about their external integrations.
Zylker relies on webhooks to push deal data to their project management tool, sync contacts to their marketing platform, and notify their support system. A single failing webhook can break an entire business process, and these failures often happen silently.
The CRM UI provides detailed views of each webhook's activity. However, identifying patterns across all integrations, like silent failures or volume anomalies, requires manually consolidating data from multiple screens. For teams with many integrations, this consolidation becomes time-consuming to perform regularly.
Zylker solves this by using the Webhooks Actions Usage Report API to get time-series data for all integrations at once, followed by the Get Action Failures API for diagnostics.
3.1 Track volume trends and spot anomalies using Webhooks Actions Usage Report API
They call the usage report API grouped by date and resource to see daily call volumes:
GET {api-domain}/crm/v8/settings/automation/webhooks/actions/usage_reports?group_by=date,resource&type=webhooks&from_date={date}
Sample Response:
|
{ "data_usage": [ { "date": "2025-12-09", "resource": { "name": "Premium Lead Alert", "id": "4876876000016390771" }, "count": 4, "type": "webhooks" }, { "date": "2025-12-09", "resource": { "name": "Deal to Project Sync", "id": "4876876000017550012" }, "count": 4, "type": "webhooks" }, { "date": "2025-12-09", "resource": { "name": "Contact to Marketing Platform", "id": "4876876000017550018" }, "count": 8, "type": "webhooks" }, { "date": "2025-12-08", "resource": { "name": "Deal to Project Sync", "id": "4876876000017550012" }, "count": 8, "type": "webhooks" }, // ...omitted for brevity ... { "date": "2025-12-07", "resource": { "name": "Deal to Project Sync", "id": "4876876000017550012" }, "count": 1, // Anomaly: very low number "type": "webhooks" }, // ... remaining entries omitted for brevity ... ], "info": { "max_limit": 2500, "per_page": 200, "count": 12, "page": 1, "more_records": false } } |
The response provides a daily log of which webhooks fired and how often. The real insight comes from analyzing two key patterns:
-
Missing activities: If a webhook that typically appears daily suddenly has no entries for multiple days, it indicates the upstream workflow has stopped. This is a silent business process failure.
-
Volume Anomalies: If a normally steady webhook shows a 300% spike in daily calls, it could indicate system errors generating duplicate records, or legitimate business surges worth investigating.
From the response data, Zylker can instantly spot that the Deal to Project Sync webhook's execution dropped to just 1 call on a specific day, which is a volume anomaly. Meanwhile, the Premium Lead Alert webhook may be missing entirely from recent dates, which is a missing activity alert.
3.2 Investigate Webhooks failures with Get Action Failures API - Webhooks
Volume anomalies tell Zylker that something is wrong. To understand what went wrong and where, they need detailed failure diagnostics.
For this, they use the Get Action Failures – Webhooks API:
GET {api-domain}/crm/v8/settings/automation/webhook_failures?from=2025-10-15&to=2025-10-22
You can optionally filter by:
-
webhook_id : to focus on a specific webhook
-
module : to see failures only for a specific module
-
from and to : to restrict the date range (max 90 days).
Sample Response:
|
{ "webhook_failures": [ { "webhook": { // The webhook that failed "name": "Premium Lead Alert", "id": "4876876000016390771" }, "entity_details": { // Record that triggered the webhook "module": { "api_name": "Leads", "id": "4876876000000002175" }, "name": "Freelancer.com", "id": "4876876000016474049" }, "failure_time": "2025-10-21T17:08:07+05:30", // When the failure occurred "failure_reason": "page_notfound", // Why it failed (e.g., page_notfound, unauthorized, timeout) "id": "4876876000016474075", // Failure entry ID "workflow_rule": { // Workflow that triggered this webhook "name": "WF-C", "id": "4876876000016390881" } }, //... omitted for brevity ], "info": { "per_page": 200, "count": 17, "page": 1, "more_records": false } } |
With a single request, Zylker now has a clear picture of exactly which workflows are causing failures, which records are impacted, and the precise technical reason for the failure. With this information at hand, they can promptly fix the issues and ensure that critical integrations do not silently break.
STEP 4: Ensure reliable communication through Email Notifications usage reports
Emails sent through workflows drive essential actions at Zylker. Sales managers get notified when high-value leads enter the system, account directors get alerted on lost deals, and service teams receive escalations. If these triggered emails are not sent consistently or begin spiking unexpectedly, decision-makers may be blind to critical updates.
To understand how workflow-triggered emails are being used over time, Zylker uses the Email Notification Actions Usage Report API.
Sample Request:
GET {api-domain}/crm/v8/settings/automation/email_notifications/actions/usage_reports?group_by=date,resource,type&type=email_notifications&from_date=2025-12-01
Sample Response:
|
{ "data_usage": [ { "date": "2025-12-09", // When the email was triggered "resource": { "name": "Lost Deal Alert", // Email notification name "id": "4876876000013500873" }, "count": 5, // Number of times it was sent that day "type": "email_notifications" }, { "date": "2025-12-09", "resource": { "name": "High Value Lead Notification", "id": "4876876000016390889" }, "count": 2, "type": "email_notifications" }, { "date": "2025-12-08", "resource": { "name": "Lost Deal Alert", "id": "4876876000013500873" }, "count": 8, // Higher usage on this day "type": "email_notifications" } // ... additional entries omitted ], "info": { "max_limit": 2500, "per_page": 200, "count": 18, "page": 1, "more_records": false } } |
By reviewing usage trends over time, Zylker can spot early signs of issues at either layer. If an email notification that normally triggers every day suddenly shows zero usage, it could mean the workflow condition has stopped matching, or it might indicate a failure due to factors like bounced addresses, inactive users, or restricted mail settings. Likewise, an unexpected spike in email executions might reveal either a legitimate business surge or a workflow repeatedly triggering because of duplicate records, import errors, or incorrect criteria.
In either case, Zylker is now in a position to take informed decisions.
Conclusion
Zylker began this journey wanting stronger workflow automation. Along the way, they learned how to discover, configure, update, and extend workflow rules and actions using APIs. But as their automation ecosystem grew, a new responsibility emerged regarding governing what they had built.
The Reports APIs complete that responsibility.
-
Action Counts reveal how complex each workflow has become
-
Workflow Usage Reports show whether actions are actually executing, succeeding, or quietly failing.
-
Webhook Usage and Failure Reports give a clear picture on the Webhook execution health.
-
Email Usage Reports highlight patterns in email communication actions.
With this complete toolkit, Zylker no longer just has automations. They understand them, analyze them, and continuously improve them. Their workflows have evolved from fragile scripts to managed business assets with known performance characteristics and early warning systems.
This concludes our Kaizen series on Workflow & Actions APIs. We hope this series has helped you to build, manage, and govern automation systems in your own organization.
If you have any feedback or questions, please let us know in the comments or reach out to us at support@zohocrm.com.
Until next time, Happy coding!
Additional Reading:
Topic Participants
Anu Abraham
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
Recent Topics
Disable Auto Send Email Notification in Invoice Creation
Here is what I am facing Make payment via Razor Pay (All Good) Capture payload data on my webapp Send this data, along with other data to Zoho books to create the invoice However in this step - An email goes to the client + The Invoice remains as draftP & L Sub-categorized accounts
How can I show sub-categorized Income and Expense accounts on the P & L report?Report showing Bill Details with Project and Sales Invoice Number
Hi There, I am hoping that someone can help, I am looking for report that can show the bill and expense details along with project its as assigned to and the invoice number that the sales has been raised in. The goal is I can filter a customer/projectAdvanced Payment for Inventory Items with serial numbers
Hello, We sell equipment that we track the unique serial numbers on using Sales Orders. We can charge the customers an advanced payment, then the balance on delivery. We cannot figure out a way to do this in Books/Inventory: - Cannot part invoice a SOIs it possible to restrict ZCRM user to see only custom views created by administrator
I have segmented data in my CRM and I want to allow different users to be able to see only parts of it based on some criteria. I've tried to create and share a custom view, but then there is always an option for user to see all open lead for example.Issues Logging into ZOHO
Hello, one of my coworkers is having issues logging into ZOHO, she has requested a code when entering and the email is correct but she has not received the code. can you help us with this?Google Fonts Integration in Pagesense Popup Editor
Hello Zoho Pagesense Team, We hope you're doing well. We’d like to submit a feature request to enhance Zoho Pagesense’s popup editor with Google Fonts support. Current Limitation: Currently, Pagesense offers a limited set of default fonts. Google FontsAdd Popup Rejection Metrics to Reports
Hello Zoho PageSense Team, We would like to request improved reporting for popup interactions. Current Limitation: PageSense currently provides conversion data, but there is no clear visibility into: Popup rejections Popup closes (✕ button clicks) DismissalsAbility to Reset / Reinitialize Popup Cookies
Hello Zoho PageSense Team, We would like to request the ability to manually reset popup cookies. Current Limitation: At the moment, it is not possible to initiate a new popup cookie from the our side. Visitors who rejected or closed a popup will not seeControl Popup Cookie Expiration Duration
Hello Zoho PageSense Team, We would like to request an enhancement related to popup cookie management. Current Limitation: Currently, PageSense popup cookies remain active for 365 days, and this duration cannot be modified by us. If a visitor closes orClone / Export Popup Design Across PageSense Projects
Hello Zoho PageSense Team, We hope you’re doing well. We would like to request an enhancement that allows popup designs to be reused across different PageSense projects. Problem Statement: Currently, Zoho PageSense allows popups to be duplicated onlyAre there settings for hyperlinks?
Clicking a hyperlinked cell in Sheet creates this little pop-up with the actual hyperlink inside. Is it possible to have a 1-click link where if you click the cell it opens the link directly with no pop-up?Automatically include all ticket attachments in the ticket resolution email
Hello Zoho Community, We are implementing Zoho Desk in a real customer-facing production environment and have run into a limitation that is becoming a blocking requirement for our clients. The problem When a ticket is closed or resolved, Zoho Desk sendsKeep Zoho People Feature Requests in the Zoho People Forum
Hello Zoho People Product Team, Greetings. We would like to submit a feature request regarding the handling of feature requests themselves, specifically for Zoho People. Issue: Feature Requests Being Moved to Zoho One Zoho People feature requests areCan I write a check in Zoho Books with no associated bill?
This currently does not seem possible, and I have a client that desperately needs this function if I am able to convert them with Quickbooks. Thank you in advance for your reply.Finding text within a ticket: Expand All or Search this Ticket
The auto-collapse feature within a ticket is nice for screen scrolling, however it makes it difficult to find text within the ticket if the email is collapsed. In fact you cannot find text if it is collapsed. I would like to propose a feature that allowsBooks & Desk. Client mapping
Hi, I’ve been using Zoho Books for several years and am now looking to improve my customer service. I'm experimenting with Zoho Desk and want to sync and map my client data from Zoho Books. However, it seems that mapping requires both contacts to haveString handling
If I cut a currency string from a quote and try and paste it into the Deal "Amount", it will fail unless I manually delete any commas. Dollar signs are no problem, but comma's seem to fail. Please correct this Input Validation error.Allow Stripe Credit Card and Stripe ACH payment methods to be enabled separately on an invoice.
I need to be able to pick at the invoice level whether Stripe Credit Card and/or Stripe ACH payment methods are available. Currently, I'm not able to select from the two Stripe payment methods individually on an invoice. However, there are some largerSKUs for Invoices, POs, etc.
It doesn't appear that one can enable SKU display on invoices, POs, etc. This is problematic, and I don't see a good reason why this shouldn't be an option. Some of our vendors and customers use this in their system. Every other identifier code is availableFeature Request - Allow Customers To Pick Meeting Duration
Hi Bookings Team, It would be great if there was an option to allow customers to pick a duration based on a max and minimum amount of time defined by me and in increments defined by me. For example, I have some slots which are available for customersYouTube Live streaming? how to? Zoom has this feature, built-in. Can't find it on zoho meetings.
YouTube Live streaming? how to? Zoom has this feature, built-in. Can't find it on zoho meetings.Feature Request - A Way To Search Item Groups
Hi Inventory Team, I can't find any way to filter or search by fields of Item Groups. It would be great to see that functionality added. I have a use case where a single product might come from 5 or more suppliers and each supplier's item is an Item inFeature Reqeust - Include MPN In Selectable FIelds
I have noticed that the MPN is not available to show in the list view of Items. Please consider adding it as EAN, UPC and ISBN are all available, so it doesn't make much sense to exclude this similar option. Thanks for considering my feedback.Feature Request - Option To Hide Default System Fields on Items
Hi Zoho Inventory Team, As far as I know it is not possible to hid some of the defult system fields on Items, such as UPC, MPN, EAN, ISBN. A good use case is that in many cases ISBN is not relevant and it would be an improved user experience if we couldCampaigns does not work!
I am running into so many problems trying to use Zoho Campaigns, that I am seriously considering dropping the app from my (shrinking) list of Zoho applications I actually use. Apart from having to fight the software trying to create a design and email,Feature Request - Make Available "Alias Name" Field In Item List View
Hi Zoho Inventory Team, I have noticed that the "Alias Name" field does not appear on the list of selectable columns in the Customise Columns feature in the Items module. This would be very useful to see for businesses who are using the Alias Name fieldproduct name field issue-n8n
Hey guys, I have a question. I want to create a new product using the workflow. The problem is with the product name field; I don't know how to fill it in. The workflow starts with retrieving information from the leads table, retrieving links to scrapeHow to filter Packages in zoho inventory api
Hi Team, I want to perform some tasks in a schedular on the packages which are in "Shipped" state. I tried to use filter_by in my api call but in return I get response as {"code":-1,"message":"Given filter is not configured"} My Api request is as followsCRM
Is anyone else experiencing this issue? Our company is not moving out of using Gmail's web app. It just has more features and is a better email program than Zoho Mail. Gmail has an extension (Zoho CRM for Gmail) that we're using but we've found some seriousSyncing with Google calendar, Tasks and Events
Is it possible to sync Zoho CRM calendar, task and events with Google Calendar's tasks and events. With the increasing adoption by many major tool suppliers to sync seamlessly with Google's offerings (for instance I use the excellent Any.do task planningHow can i view "Child" Accounts?
It can be very useful in our field of business to know the parent-child account relationship. However, there seems to be a shortcoming in the parent account view: no child account list. How can we view the child accounts per each account?Easily perform calculations using dates with the new DATEDIF function
Hey Zoho Writer users! We've enhanced Zoho Writer's formula capabilities with the new DATEDIF function. This allows you to calculate the difference between dates in days, months, and years. Function syntax: =DATEDIF(start_date, end_date, unit) Inputs:Adding Comments Using Workflows - How to Change User Attributed
We have worklflows in Desk where a comment is added to a ticket based on certain criteria. It seems that the comment added is always attributed to the user who last edited the workflow. This does not make sense for us because: - It's misleading to otherAdd Attachment Support to Zoho Flow Mailhook / Email Trigger Module
Dear Zoho Support Team, We hope you are well. We would like to kindly request a feature enhancement for the Mailhook module in Zoho Flow. Currently, the email trigger in Zoho Flow provides access to the message body, subject, from address, and to address,Conect chat of salesiq with zoho cliq
Is there any way to answer from zoho cliq the chat of salesiq initiated by customers?Les dernières avancées en saisie de données et collaboration
Après une année dédiée à la recherche et au développement, notre équipe est prête à dévoiler des améliorations majeures pour Zoho Sheet. Ces nouveautés seront lancées par étapes afin d’en assurer une prise en main optimale. Nous commençons avec des fonctionnalitésRich Text For Notes in Zoho CRM
Hello everyone, As you know, notes are essential for recording information and ensuring smooth communication across your records. With our latest update, you can now use Rich Text formatting to organize and structure your notes more efficiently. By usingImplement Meeting Polls in Zoho Bookings
Dear Zoho Bookings Support Team, We'd like to propose a feature enhancement related to appointment scheduling within Zoho Bookings. Current Functionality: Zoho Bookings excels at streamlining individual appointment scheduling. Users can set availabilityService Account Admin for API Calls and System Actions
Hello, I would like to request the addition of a Service Account Admin option in Zoho product. This feature would allow API calls and system actions to be performed on behalf of the system, rather than an active user. Current Issue: At present, API callsNext Page