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
Deluge function to copy parent record file upload field to child record file upload field
I'm stuck trying to write a deluge function that is triggered via automation in child record "Appointments," confirms if a file is in file upload "Report" field of parent "Contacts" record via Contacts lookup field "Contact_Name". If no file is in parentZoho 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 aMake panel configuration interface wider
Hi there, The same way you changed the custom function editor's interface wider, it would be nice to be able to edit panels in pages using the full width of the screen rather than the currently max-width: 1368px. Is there a reason for having the configuration panel not taking the full width? Its impossible at this width to edit panels that have a lot of elements. Please change it to 100% so we can better edit the layouts. Thanks! B.Image Compression Options
Much better if we have level of options to compress the image [20%, 40%...] We are dealing with service reports daily that has before and after photos (image field)- the file size too large and one thing, the current limit is 10mb or 15mb for reportCannot get code to work with v2.mergeAndStore!
Please can someone help me pass subform items into a repeating mail merge table row using v2.mergeAndStore? I have a mail merge template created in Writer and stored in Workdrive. This template is referenced by a custom CRM function which merges all ofHow to hide or archive a blog post temporarily in Zoho commerce website builder?
I would like to temporarily hide or archive a blog post in zoho commerce website builder so that it doesnt appear on my website till I enable it again. I tried to look for this option but could not find it. It only allows me to permanently delete a blogFounders using Zoho — are you leveraging Zoho Campaigns + Zoho Social for thought leadership… or just sending emails?
I’ve noticed something interesting in the Zoho ecosystem. Many founders use Zoho Campaigns and Zoho Social for basic marketing—newsletters, scheduled posts, and announcements. But very few are using these tools strategically to: • Position themselvesHow to mix different types of inputs (such as dropdown list and textbox)
Hi, I'm creating a form called "Room Reservations" for a company. I created a "table" using "Matrix Choice". I created "Room 1", "Room 2" and "Room 3" with the "Questions". I would then like to create two columns with the "Answers", one called "Department"Reply to Email for SO/PO
Hello, We are new to Zoho Books and running into an issue. Our support@ email is our integration user. When our team is sending out PO/SO's we are updating the sender email, but for some reason many of our responses are coming back to our support@ emailHow to Convert NSF to PST Format Effortlessly? - SYSessential
It is highly recommended to obtain the error-free solution of the SYSessential NSF to PST converter to convert NSF files from Lotus Notes. Using this professional software, it becomes easier to convert all NSF database items, including emails, journals,Zoho Commerce - Poor Features Set for Blogging
Hi Zoho Commerce team, I'm sure you will have noticed that I have been asking many questions about the Blogs feature in Commerce. I thought that it would be useful if I share my feedback in a constructive way, to highlight the areas which I feel needPass shipping info to payment gateway Zoho Books to Authorize.net
For some reason the integration from Zoho books to Authorize.net does not pass the shipping address. Authorize.net is ready to receive it, but zoho books does not send itMassive Zoho Books failure
We have not received any communication or notification from Zoho, but we have detected that Zoho Books is not working for all our users. We cannot access or use Zoho Books. This is critical. We are trying to contact Zoho on the Spain telephone number,Does the Customer “Company Name” field appear anywhere in the Zoho Books UI outside of PDFs?
Hi everyone, I’m trying to understand how the Company Name field is actually used in Zoho Books. There is a Company Name field on the customer record, but when viewing transactions like a Sales Order in the normal UI (non-PDF view), that field doesn’tEmail outbox is now available in the sandbox
Hello all! Testing emails without visibility has always been a blind spot in the sandbox. With the new Outbox, that gap is closed. You can now view and verify every email triggered from your sandbox, whether it’s through workflows, approvals, or massLooking For Recruit Developer
Hi everyone, I am looking for a Zoho Certified Developer to assist with a development project for MetalXpert. We are building a software system designed to bridge the gap between a candidate mobile app and an employer web portal using Zoho Recruit assales IQ issue on website
i integrated the zoho sales IQ code on the website but it is comming in distroted form i am sharing the screenshot below the website is bulit in wix platformMulti-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. ThereDeprecation of the Zoho OAuth connector
Hello everyone, At Zoho, we continuously evaluate our integrations to ensure they meet the highest standards of security, reliability, and compliance. As part of these ongoing efforts, we've made the decision to deprecate the Zoho OAuth default connectorI need to know the IP address of ZOHO CRM.
The link below is the IP address for Analytics, do you have CRM's? IP address for Analytics I would like to know the IP address of ZOHO CRM to allow communication as the API server I am developing is also run from CRM. Moderation Update: The post belowImportant Update: Google Ads & YouTube Ads API Migration
To maintain platform performance and align with Google's newest requirements, we are updating the Google Ads and YouTube Ads integrations by migrating from API v19 to the newer v22, before the official deprecation of v19 on February 11, 2026. Reference:Zoho recruit's blueprint configuration is not functioning as mapped
Current Status: Zoho Blueprint is not functioning as configured. Issue: We are moving a Candidate status in Zoho Recruit "for active file" but we encountered: "Status cannot be changed for records involved in Blueprint." This happens to various clientSuper Admin Logging in as another User
How can a Super Admin login as another user. For example, I have a sales rep that is having issues with their Accounts and I want to view their Zoho Account with out having to do a GTM and sharing screens. Moderation Update (8th Aug 2025): We are workingBlocklist candidates in Zoho Recruit
We’re introducing Block Candidate, which helps recruiters to permanently restrict a candidate from applying to current/future job openings. Once the candidate is blocked, they will no longer be able to participate in the recruitment process. This willAdmin asked me for Backend Details when I wanted to verify my ZeptoMail Account
Please provide the backend details where you will be adding the SMTP/API information of ZeptoMail Who knows what this means?Zoho Desk - Upsert Ticket
Hi Desk Team, It is common to request more information from end-users. Using forms is a great way to ensure all the required information is collected. It would be great if there were an "upsert" option on the Zoho Form -> Zoho Desk integration which wouldAll new Address Field in Zoho CRM: maintain structured and accurate address inputs
The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest updateClient Side Scripts for Meetings Module
Will zoho please add client side scripting support to the meetings module? Our workflow requires most meeting details have a specific format to work with other software we have. So we rely on a custom function to auto fill certain things. We currentlyIntroducing Multiple Sandbox Types and Support for Module's Data Population
Register here for the upcoming Focus Group webinar on Multiple Sandbox | Help documentation to learn more about the new enhancements Hello everyone, Sandbox in CRM is a testing environment for users to create and test new configurations like workflowCreator Offline
We had online access setup and working on our iphones. We have just set it up on an 'Android Tablet' and it is not downloading all the images? We use it to show customers our catalogue. Any ideas. Offline components all setup on both devicesUpdated font library: New font styles and custom font options in Zoho Sheet
Zoho Sheet's font library now supports 500+ font styles in 60+ languages! The updated font library is stacked with new font styles, and some of the previously available font styles have been replaced with equivalent options. There are two ways you canEnable or disable any Field Rule!
Hello Zoho Forms Community, We are excited to announce a powerful new enhancement to Field Rules that gives you greater control and flexibility in managing your form logic! Previously, if you wanted to temporarily deactivate a field rule, you had twoMarketing Tip #20: Increase traffic with strong meta titles and descriptions
Meta titles and descriptions are what people see first on search results before they ever click through to your website. If your pages use generic titles or basic descriptions, you miss the chance to stand out, and search engines may not know which pageKanban view on Zoho CRM mobile app!
What is Kanban? The name doesn't sound English, right? Yes, Kanban is a Japanese word which means 'Card you can see'. As per the meaning, Kanban in CRM is a type of list view in which the records will be displayed in cards and categorized under the givenNot able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed Jobs
Not able to delete a QC nor able to revert or create a cycle of manufacturing for QC failed JobsDheeraj Sudan and Meenu Hinduja-How do I customize Zoho apps to suit my needs?
Hi Everyone, I'm Meenu Hinduja and my husband Dheeraj Sudan, run a business. I’m looking to tweak a few things to fit my needs, and I’d love to hear what customizations others have done. Any tips or examples would be super helpful! Regards Dheeraj Sudanis there any way to change the "chat with us now" to custom message?
is there any way to change the "chat with us now" to custom message? I want to change this textDeprecation Notice: OpenAI Assistants API will be shut down on August 26, 2026
I recieved this email from openAI what does it means for us that are using the integration and what should we do? Earlier this year, we shared our plan to deprecate the Assistants API once the Responses API reached feature parity. With the launch of Conversations,Capture Last check-in date & days since
I have two custom fields on my Account form, these are "Date of Last Check-In" and "Days Since Last Contact" Using a custom function how can I pull the date from the last check-in and display it in the field "Date of Last Check-In"? and then also display the number of days since last check-in in the "Days SInce Last Contact" field? I tried following a couple of examples but got myself into a bit of a muddle!CRM gets location smart with the all new Map View: visualize records, locate records within any radius, and more
Hello all, We've introduced a new way to work with location data in Zoho CRM: the Map View. Instead of scrolling through endless lists, your records now appear as pins on a map. Built on top of the all-new address field and powered by Mappls (MapMyIndia),Next Page