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
To print Multiple delivery notes in batches
In Zoho Books, we can print a Delivery Note from an Invoice using the Print Delivery Note option, but it is non-editable and always prints all line items from the invoice. Our requirement is to deliver invoiced items in batches and print delivery notesInvoices not arriving and mail server settings
I am having an issue where some clients are not receiving invoices. I have configured Zoho Books to send on my behalf and configured the appropriate SPF, DKIM and DMARC settings on my mail server and tested these as working. I get the CC'd copies so IUPLOAD A CREATED PDF AUTOMATICALLY
Using the html header pdf+print button, I have managed to find a way to have a user create a pdf using entered form data. Using the schedule button, I can have a "file uploaded" pdf mailed to someone as an attachment. The missing piece is to be able to add the pdf, created in that html page to a file upload field automatically? Right now one has to save it to computer and then upload it in a FILE UPLOAD FIELD. Any help would appreciated !Consolidated Department-wise Payroll Cost Summary Report
Hello Zoho Payroll Team and Community, I am writing to discuss a reporting requirement regarding department-level expense tracking within Zoho Payroll. As we scale and manage salary distribution for employees across multiple departments, such as Accounts,How to remove chat icon from knowledge base?
I have set up a knowledge base to hold FAQs and documentation. It is currently standalone, and not integrated into our website. On every page there is a chat button in the bottom left corner that says "We're offline, please leave a message." How can I[ZohoDesk] Improve Status View with a new editeble kanban view
A kanban view with more information about the ticket and the contact who created the ticket would be valueble. I would like to edit the fields with the ones i like to see at one glance. Like in CRM where you can edit the canvas view, i would like to editAutomated Dismissal of Specific Notifications and Centralized Control of Toast Notification Settings
Dear Zoho Team, I hope this message finds you well. We would like to request two enhancements related to notification handling within Zoho Desk: Automatic Dismissal of Specific Notifications: Currently, when certain actions are taken in the ticket listShow field in spreadsheet view depending on other field value
Hello. Not sure if this is possible but let's say i have spreadsheet view in Creator with four different fields Field A, B, C and D Then i have a field named Response which for one record could contain only one of the pre-definde choices below A, B, CIntergrating multi location Square account with Zoho Books
Hi, I have one Square account but has multiple locations. I would like to integrate that account and show aggregated sales in zoho books. How can I do that? thanks.Zoho Learn Zapier Integration
Hello all, Is there any plan to integrate Zoho Learn with Zapier? It seems almost all Zoho products are in Zapier, with the exception of Learn and Marketing Automation.Notice: SalesIQ integration paused on Zoho Sites
I have this notice on my Zoho Sites in the SalesIQ integration setup. Can someone assist? "This integration has been temporarily paused for users. Reconnecting SalesIQ after disconnection will not be possible until we provide further updates." thankDifferences between Zoho Books and Zoho Billing
Without a long drawn out process to compare these. If you were looking at these Books and Billing, what made you opt for one and not the other. ThanksNew Feature : Copying tickets with all the contents such as conversations/history/attachments etc
Sometimes our customers and distributors do create tickets (or send emails) which contain more than one incident in them and then also some of the further conversations which are either created by incorrect new tickets or replies to old tickets are being created as combined tickets. In such cases we require to "COPY" the contents of the tickets into separate tickets and merge them into their corresponding original tickets. The "CLONE" feature doesn't copy the contents (especially the conversationsComo se agregan los empleados
Necesito saber si para agregar empleados los mismos necesitan tener licenciasDeluge Error Code 1002 - "Resource does not exist."
I am using the following script in a Custom Button on a Sales Return. Basically, the function takes the information in the sales return (plus the arguments that are entered by the user when the button is pushed) and creates a return shipping label viaAdding multiple Attendee email addresses when adding a Zoho Calendar event in Zoho Flow
I am trying to integrate Notion and Zoho Calendar via Zoho Flow. However, the Attendee email address supported by Zoho Calendar - Create event only supports one email address, so I am having difficulty implementing automation to automatically registerGraceful Handling of Exceeded Option Limits
Hi Zoho SalesIQ team. I would like to submit a feature request to deal with a bug in salesIQ Current Behavior (Bug): When a dynamic list passed to the Single Select Option Card contains more than 20 options, the Zobot stops responding (freezes/hangs)System default SLA descriptions can't be modified
The system default SLAs have identical descriptions for all SLA levels, but their settings differ. However, I am facing an issue where I cannot modify these descriptions and save the changes. The content of the description box can be edited but the changesAdding non-Indian billing address for my Zoho subscription
Hey Need help with adding a non-Indian billing address for my Zoho subscription, trying to edit the address to my Singapore registered company. Won't let me change the country. Would appreciate the help. Regards, RishabhHow to create one ZohoCRM organisation out of a multi-organization?
Hi, we have a multi-org including two different Zoho CRM organizations for two companies using respectively EUR and USD as default currency. I was wondering if there is any easy way to merge the two organizations into just one, so that users may accessGray screen while signing documents
We are all getting a "gray" screen when trying to sign documents in Zoho sign. Anyone else having issues?Projects custom colors replaced by default orange
Since yesterday, projects uploaded to Zoho, to which I had assigned a custom color, have lost the customization and reverted to the default color (orange). Has anyone else had the same problem? If so, how did you resolve it?Interview booked through Invite but no Notifications
We have a workflow that was developed through a developer/partner that was tested and worked. Today, we pushed a candidate through the process and invited them to an in-office interview. They were sent the booking link (as usual and as tested before successfully)Automatiser la gestion des SLA dans Zoho Desk avec Zoho Contracts
Les équipes du service client s’efforcent d’assurer un support rapide, régulier et fiable pour garantir la satisfaction de chaque client. Les accords de niveau de service (SLA) permettent de clarifier les engagements en définissant les termes et conditionsiOS App doesn't refresh for Document Creation
Hello Zoho team, I have created a workflow to be used on a mobile iOS device which starts in Zoho Creater and ends with a murge and store function that then opens the newly created document within the Zoho Writer app. This process is working great howeverUploading a signed template from Sign to Creator
Good day, Please help me on how to load a signed document back into Creator after the process has been completed in Sign. Below is the code that I am trying, pdfFile = response.toFile("SignedDocument_4901354000000372029.pdf"); info pdfFile; // AttachZoho DataPrep and File Pattern configuration
I'm using Zoho data prep to ingest data from One Drive into Zoho Analytics... The pipeline is super simple but I can't any way to get all the files that I need. Basically I need to bring all the files with a certain pattern and for that I'm using a regexAssistance needed: Activation of a domain
Hello Zoho Support, I purchased the .com domain "primesolva.com" via Zoho 6 days ago. The domain is still pending, and I cannot access the DNS panel to add the TXT verification for domain ownership. Please confirm the registration status and help me activateOperation not permitted
I am trying to add an email address to the list of user but I am getting error Operation not permittedRequest to Permanently Delete Email User (info@mehbobgulf.com ) from Old Organization
Please permanently delete the user email info@mehbobgulf.com It is still associated with my old Zoho organization. I cannot delete it because it shows ‘You cannot delete email. Zoho host’. I need to use this email in a new Zoho account.”Client host [89.36.170.5] blocked using Spamhaus
Hello please make make actions for delist ..... "Client host [89.36.170.5] blocked using Spamhaus"Suggestion: Option to Re-run a migration
As I'm going through a migration process, I like the IMAP migration tool, but it would be better if there were an option to re-run the same migration as configured. There's not even an option to copy/edit one that's already there. Just run if it hasn'tIssue with "Add Your Mobile Number"
Hello, I am trying to sign up for email service for a domain name, and I cannot finish the authentication. When I enter my mobile number, I receive the message "We’re unable to send OTP to this mobile number. Please contact support-as@zohocorp.com". Izoho mail non vérifié
Bonjour, Il y'a un jour que j'ai acheté un domaine et toute les tentatives pour l'associé a mon compte shopify son vaine. j'ai essayé TXT sans suite après, j'ai essayer avec CNAME sans suite. j'aurais besoin de votre assistance pour associé mon mail.Unable to send message;Reason:553 Relaying disallowed. Invalid Domain
i have facing the issue "Unable to send message;Reason:553 Relaying disallowed. Invalid Domain" if i verify domain evertthing i did but still face the same error.ZohoMail is so close to being Perfect BUT
Why don’t you have HILIGHTING???!! I've been trying to find a substitute for Edison Mail but I want & need hilighting (preferably in more than just yellow)! Is this even on your To Do list? I’m so disappointed. 🙄Override Auto Number field?
We are preparing to migrate from Salesforce. In Salesforce, we auto-generate a unique number on our Opportunities (Potentials). If the Opportunity results in a contract, we use that unique number as the Contract number. There are some situations whereUsing a third party service provider want to move directly with Zoho
Hi good day I’m currently using Zoho but I’m using a third party service provider I want to move directly with you guys I’m using Zoho email and invoices and my domain please let me know if it’s possible to move away from the third party provider my emailRequest for Assistance Regarding Email Sending Issue (554 5.1.8 - Email Outgoing Blocked)
Dear Zoho Support Team, I hope this message finds you well. I am writing to request assistance with an issue we are currently facing regarding our Zoho Mail account. Our email account, admin@tuyensinhcanuoc.com, is encountering the following error whenZoho Mail API returns empty inbox (0 messages) but webmail shows 37 unread emails
Hello, I'm experiencing a discrepancy between Zoho Webmail and the Mail API (EU region). **Setup:** - Account: EU datacenter (mail.zoho.eu) - API: Self Client OAuth2 via api-console.zoho.eu - Scopes: ZohoMail.messages.READ, ZohoMail.messages.UPDATE, ZohoMail.folders.READ,Next Page