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
Bug: OAuth 2.0 State Parameter fails with Pipe Delimiters (RFC 6749 Non-Compliance)
I've discovered a bug in how Zoho's API Console handles the OAuth 2.0 authorization flow when the state parameter contains pipe characters (|), and I'm hoping the Zoho team can address this in a future update. The Issue Zoho's OAuth 2.0 implementationCustom Function to increment a value by one
Hi, I'm trying to find a solution to set up a counter on CRM records that tracks how many times certain actions have taken place. As a specific example: We have a field on Deals called "Times Close Updated". This starts at 0 on record creation. I'd likeAccess token generate from the refresh token not working for API
Dear Sir/Madam, When I use my refresh token to obtain new access_token, that token return INVALID_TOKEN when the same API is called. I made sure that my api site is correct and match the auth web site. However the original access_token work fine.why does my campaign move back to draft?
Every time I try to send my email campaign, it reverts back to Draft status.. this has happened three times in a row..how do i find out what the problem is? ThanksService and Parts Line Item Limitations
Hi FSM Team, We work with clients who deliver large-scale field service projects. In many cases, a single work order can contain 200+ service and parts line items. Currently, Zoho FSM limits work orders to 30 service and parts line items. While this works【Zoho CRM】やりとりの要約機能リリースのお知らせ
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中から、新機能のやりとり要約機能をご紹介します。 Zoho CRMのやりとりの要約は、Ziaが生成する機能で、データに関連付けられた最近のやりとりを簡潔にまとめて提供します。 メール、通話、ミーティング、メモなどを1つの明確な要約にまとめ、重要なポイント、過去の話し合いの要点、結果、次のステップを表示することで、日常的な課題に対処します。 Ziaの強みは、単なる要約にとどまらず、内容の解釈も行える点です。やりとりの要約では、顧客との会話に潜む遅延、フォローアップ漏れ、約束、期限、感情、意図を特定します。Recent post analytics not very useful
Hi, I'm enjoying some aspects of the Zoho Social. like being able to schedule posts to multiple channels. However, the recent posts analytics is disappointing. For example, I put up a reel on Instagram and Facebook yesterday. Instagram insights showsWhat happens to the files created by user, whose account is deleted.
Hello, I created a folder in the My folders names "Quote" I shared the same with my colleague. She created some files and folders in that folder over the period of 1 and half year. Now she left company, and I deleted her account from Zoho. What happensInternal Error When Accessing Team Inbox.
All our users are seeing this error in teaminbox. Because its a critical tool kindly resolve this issue ASAP.Sharing URLs and direct access
Hello, I am storing my team's email signature images on Workdrive. I am creating a public image download share and adding “?directDownload=true” so that the image can be accessed without the Workdrive interface. A few questions: 1) Can we generate friendlyZoho Mail Android app update: Calendar enhancements
Hello everyone! In the most recent version of the Zoho Mail Android app update, we have introduced various new enhancements for the calendar module. Let's explore what's new. Drag and drop events to update the date and time We have enhanced the calendarEnhance Delay Configuration in Zoho Flow
Dear Zoho Flow Support Team, We are writing to request an improvement to the delay configuration process within Zoho Flow. Currently, users are required to manually enter the exact delay duration (e.g., "2 days") in the delay block. This can be time-consumingContratação ProdutivosX
Bem-vindo(a) ao processo de contratação da ProdutivosX. Este formulário tem como objetivo coletar informações essenciais para análise de perfil profissional, alinhamento de competências e possível integração ao equipamento ProdutivosX. A ProdutivosX éEnhance Sign CRM integration
Hello all, I'm working on a custom Deluge script to enhance the integration between Zoho CRM and Sign by using a writer merge template for additional flexibility. I want to replicate the post-sign document integration that exists between CRM and SignUnified WhatsApp Number Management in Zoho Desk and SalesIQ
Dear Zoho Desk Support Team, We are currently utilizing both Zoho Desk and Zoho SalesIQ for our customer support operations. While both platforms offer WhatsApp integration, we are facing challenges due to the requirement of separate WhatsApp numbersPlug Sample #15 - Enable Human-Like, Contextual Interactions in SalesIQ with Zia Agents
Zia Agents are conversational AI assistants designed to understand user intent and respond intelligently, helping businesses automate conversations and offer personalized support at scale. While Zia Agents are yet to be publicly released, access is currentlyBest way to schedule bill payments to vendors
I've integrated Forte so that I can convert POs to bills and make payments to my vendors all through Books. Is there a way to schedule the bill payments as some of my vendors are net 30, net 60 and even net 90 days. If I can't get this to work, I'll haveSeamless Round-Trip Navigation for Related Blocks (Detail View)
As highlighted previously in this post (and here, here, here, and here), we still lack a fundamental capability for seamless navigation in Related Blocks. The popup that appears when adding a related record doesn't exist for viewing/editing existing records,Social Profile Logo Format
Hello, I'm using Zoho Sites and am attempting to add a couple of social media accounts to my profile that aren't included in the default platforms that are available. What format is the logo required to be in? I have tried .png and .jpg with no success.How to create Sepa Direct Debit XML file: solution and code
Even though Books provides a payment integration for Stripe and Gocardless (in Europe) there are customers that want to use the Sepa services of their own bank. Mainly because Stripe and Gocardless are quite expensive. In that case they would need a SepaTraditional Spreadsheet vs Zoho Tables
Hello everyone, This article explains the differences between Spreadsheet applications and no-code databases, such as Zoho Tables. While both tools belong to the "grid" family, the core difference lies in their purpose. A spreadsheet (such as Zoho Sheet,RFQ MODEL
A Request for quotation model is used for Purchase Inquiries to multiple vendors. The Item is Created and then selected to send it to various vendors , once the Prices are received , a comparative chart is made for the user. this will help Zoho booksDelegate Access - Mobile iOS/iPad
We’re over the moon that delegate access is now available in Zoho Mail as we were nearly ready to switch platforms because of it! Is there a timeline on when delegate mailboxes will be accessible from the iOS and iPad OS applications? Thanks, JakeRequest For Quotation (RFQ) module
Hello, Do you have any plans to implement a RFQ module in to ZOHO Inventory? I would like to chose items that I require a price for, select a number of different suppliers to e-mail and have them submit there pricing online. I would then like to see aSupport for Developing Zoho Recruit Extensions via Zoho Sigma
Hi, I’m interested in building an extension for Zoho Recruit using Zoho Sigma. However, when I navigate to Sigma and attempt to create a new extension (via the "New Extension" option), Zoho Recruit does not appear as a listed service—only options likeFOLDER DISAPPEARED
Hello Zoho Community. I recently found a problem with no explanation: a folder in Zoho Analytics just disappeared, but the tables and SQL sentences still existed, the folder was not deleted. The solution for me in this case was to create a new folder,How to create estimates/Invoices with sub-totals
Every other accounting package can create estimates and invoices with Sub-totals. How can I do that in ZohoBooks?Deluge scripts
Why is there not a search function to make it easier to find the script of interest when modifications are required.Social media simplified with Zoho Social: Why should brands have a Threads profile?
Just over a year ago, Instagram launched Threads, the all new social media app primarily focusing on sharing text online. It was welcomed by people worldwide with more than 10 million users in just seven hours, and it currently has over 175 million activeAuto tracking URL generation based on Carrier
Hi, While creating a shipment order for a package in Zoho Books, I have a requirement that for example, if the carrier is Delhivery and tracking number is 1234, then can automatically the tracking link/URL be generated as www.delhivery.com/1234. Similary,New Beginnings with Zoho Desk mobile app best practices: Part 3
In focus: Scaling consistency, intelligence, and customization In our third installment, we'd like to share tips to help you elevate your customer experience as you handle support operations seamlessly on mobile. Let's reconnect with Omniserve, the fieldHighlights of 2025: Milestones and moments
Hey everyone! As we step into 2026, it’s a great time to look back at everything 2025 brought to Zoho Social. This year was big, packed with powerful new features, smart enhancements, exciting events, and a major milestone: a whole decade of Zoho Social.Introducing the sandbox environment in Zoho Sign
Hey there! Customer and partners across the globe have been requesting a testing environment—also called a sandbox—for quite some time. Sandboxes help you try out document workflows before using them in your production setup. This new year, we are excitedCan I share the drive with another Windows user?
We use the WorkDrive Sync application on a server with several remote desktop users. Our question is: Can the drive created by WorkDrive Sync be shared from one of these remote users with the other users so they can access the files, or do we need toSyncing Bills in Zoho Books to Zoho CRM
Is there any way to sync the Bills in Zoho Books in Zoho CRMAuto CheckOut Based On Shift.
This Deluge script runs on a scheduled basis to automatically set the 'Actual_Check_Out' time for employees who haven't manually checked out. If the current time is past their scheduled 'Shift_End_Time', the script updates the check-out time to matchERROR: Product type cannot be changed for Items having transactions.
I have mistakenly added a product type as goods for an item that was a digital service. Now when HSN/SAC became mandatory, this brought my attention to this error I did. So I tried changing the product type but it displayed this error message ProductBoost your CRM accuracy with smart Data Enrichment
Hello all! In this post let's look at data enrichment from a holistic perspective to gain more clarity on how you can use it. So, here's a quick recap of what data enrichment is and how you set it up it to enhance your existing module data! What is dataIs it possible to set a region lookup table so that my deal country can lookup this lookup table
Hi there, I would like to be able to add a data lookup table with the following fields: Country, Region. And then in my deal report, i can then lookup this table to fish out the region in my report. This will be important for my sales process to categoriseTest Emails Show Sent "via zcsend.net" in My Gmail Account
I noticed the following info... However, a few email service providers such as Outlook and Gmail will display that the email was sent by zcsend.net (Zoho campaigns’ server) on your behalf instead of just your from email address. In order to prevent this, you can go for either of these options: Do not select the check box meant for DomainKey Signature which is listed under Unverified sender domains. Include our mail servers by advanced authentication method such as SPF/ Sender ID and DomainKey/ DKIM.Next Page