Kaizen 213 - Workflow APIs - Part 1
If you have ever managed complex business processes, you know that Workflows are the quiet backbone of any well-run business process. They keep things moving; assigning owners, sending alerts, keeping deals on track, and much more. But until now, you could not manage them via APIs. That changes with the release of Workflow APIs.
In this series, we will work through a real-world scenario together, showing you how to transition from manually managing workflows to governing them using APIs. We’ll look at Zylker Cloud Services, an IT solutions provider trying to bring order to its growing CRM automations.
The use case: Scaling the sales process at Zylker Cloud Services
Zylker’s sales process touches multiple teams and modules like Leads, Deals, Calls, Appointments, etc. Over time, different team members created their own workflows. The result is familiar to anyone who has scaled fast:
Multiple versions of what should be the same process
Old, unused workflows still running.
Now, Zylker wants to bring structure and visibility to this automation sprawl. Their system administrators are building a custom admin dashboard to monitor and manage CRM workflows, without needing deep CRM expertise.
They want to:
Display a real-time list of all workflows with their status
Gain insights into workflow distribution across modules
Identify inactive or outdated workflows that may need cleanup.
However, the CRM UI only allows viewing one workflow at a time. There is no consolidated view to see all workflows, their triggers, and their status across modules. That makes auditing and governance tedious and error-prone, especially at scale.
This is exactly what the Workflow APIs solve. With this, they can:
Audit all existing workflows.
Review how and when they trigger.
Identify which modules and actions are supported before creating new rules or updating existing ones.
Update existing rules and create new rules.
Delete the rules that are no longer needed.
You can not build a dynamic admin dashboard or an automated audit system for Workflows through just clicks. But you can do this now, with Workflow APIs.
STEP 1: Discover and audit existing workflows
Before changing anything, we need to understand what we are working with. How many workflows do we have? What do they do? How many more can we create?
To get a complete inventory of Workflow rules, we can use the GET Workflow Rules API. This API returns a list of all the Workflow Rules configured for the CRM account.
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules
This initial audit acts like a master list, giving us an overall picture. It helps understand the scope of the automation landscape and identify obvious redundancies, like multiple workflows with similar names or purposes.
Sample Response:
{ "workflow_rules": [ { "created_time": "2024-01-15T14:20:30+05:30", "execute_when": { "details": { "trigger_module": { "api_name": "Deals", "id": "4876876000000002181" }, "repeat": false }, "type": "create_or_edit" }, "editable": true, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "deprecated": false, "deletable": true, "description": "Alert VP of Sales for high-value opportunities", "source": "crm", "created_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "last_executed_time": null, "modified_time": "2024-01-23T12:23:12+05:30", "name": "VP Alert - High Value Deal", "modified_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "lock": { "locked_by": null, "message": null, "status": false }, "id": "4876876000016390024", "category": "default", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions": [ { "related_details": null, "name": "VP notified", "details": { "module": { "api_name": "Deals", "id": "4876876000000002181" } }, "id": "4876876000016390063", "type": "field_updates" }, { "related_details": { "best_time": true }, "name": "High value deal alert", "id": "4876876000016390015", "type": "email_notifications" } ] }, "scheduled_actions": [ { "execute_after": { "period": "business_days", "unit": 1 }, "id": "4876876000016390074", "actions": [ { "related_details": null, "name": "Confirm VP follow-up", "id": "4876876000016390067", "type": "tasks" } ] } ], "criteria_details": { "relational_criteria": { "module_selection": null, "criteria": null, "module": null }, "criteria": { "group_operator": "AND", "group": [ { "comparator": "equal", "field": { "api_name": "Amount", "id": "4876876000000002557" }, "type": "value", "value": "50000" }, { "comparator": "equal", "field": { "api_name": "Stage", "id": "4876876000000002565" }, "type": "value", "value": "Negotiation/Review" } ] } }, "id": "4876876000016390025" } ], "status": { "active": true } }, { "id": "4876876000012015001", "name": "Lead Assignment - North Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T11:56:20+05:30" // ... other keys omitted for brevity }, { "id": "4876876000012020001", "name": "Lead Assignment - South Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T10:30:15+05:30" // ... other keys omitted for brevity } // ... additional workflows ], "info": { "per_page": 200, "count": 71, "page": 1, "more_records": false } } |
The response gives us a comprehensive overview of all configured workflows. For each rule, we get the metadata including its unique ID, name, description, the module it operates on, its activation status, and details about when it triggers. We also get audit information like creation timestamps and which user made changes.
Working with large results
When you have hundreds of workflows, pagination helps. The response includes an info object with pagination details:
count: The number of workflows on the current page
per_page: The maximum number of records per page (default and max is 200)
page: The current page number
more_records: Indicates if there are additional records to fetch.
If the more_records key is true, we can retrieve the next page by using the page parameter in the request.
While getting all workflows gives you the big picture, we may often want to focus on specific areas. This API offers several parameters to narrow down our search:
Parameter type | Description |
module | Filters workflows by the primary module they operate on. |
trigger_module | Filters by related modules that can trigger workflows. Use this when you want workflows that are triggered by changes in related records. |
execute_on | Filters by the specific action that triggers the workflow. |
status_active | Filters by activation status to see only active or inactive workflows. Useful for audits and cleanup operations. |
filter | Searches workflows by name using a JSON filter. |
page | Specifies which page of results to return. Use this for pagination when you have a large number of workflows. |
per_page | Limits the number of workflows returned per page. The default and maximum value is 200. |
sort_by | Sorts the workflows based on a specific field. The only supported value is modified_time. |
sort_order | Sorts the workflows in ascending (asc) or descending (desc) order. |
include_inner_details | Includes the inner details like conditions and actions of the workflows in the response. |
For example, to find all active lead workflows containing "Assignment" in their name, use:
Here is the API-call-ready version of the same, after URL encoding the filter value:
Now, if you inspect the response closely, you can see that we have two similar workflows: "Lead Assignment - North Region" and "Lead Assignment - South Region." And there is also an older workflow named "VP Alert - High Value Deal."
This workflow was created almost a year ago by a former team member, and it has not been modified for a long time. Is it still relevant? What exactly does it do? What criteria define a "high-value deal," and who exactly gets notified?
To answer these questions and understand the workflow's complete logic, we must examine it closely using the Get a Workflow API. This API returns the full configuration including all conditions, criteria thresholds, and specific actions for an individual workflow.
STEP 2: Inspect a single workflow using Get a Workflow API
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/4876876000016390024
Here, 4876876000016390024 is the unique ID of the Workflow rule whose details we want to fetch, obtained from the response of Get all Workflows API.
Sample Response:
{ "workflow_rules": [ { "created_time": "2024-01-15T14:20:30+05:30", "execute_when": { "details": { "trigger_module": { "api_name": "Deals", "id": "4876876000000002181" }, "repeat": false }, "type": "create_or_edit" }, "editable": true, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "deprecated": false, "deletable": true, "description": "Alert VP of Sales for high-value opportunities", "source": "crm", "created_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "last_executed_time": null, "modified_time": "2024-01-23T12:23:12+05:30", "name": "VP Alert - High Value Deal", "modified_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "lock": { "locked_by": null, "message": null, "status": false }, "id": "4876876000016390024", "category": "default", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions": [ { "related_details": null, "name": "VP notified", "details": { "module": { "api_name": "Deals", "id": "4876876000000002181" } }, "id": "4876876000016390063", "type": "field_updates" }, { "related_details": { "best_time": true }, "name": "High value deal alert", "id": "4876876000016390015", "type": "email_notifications" } ] }, "scheduled_actions": [ { "execute_after": { "period": "business_days", "unit": 1 }, "id": "4876876000016390074", "actions": [ { "related_details": null, "name": "Confirm VP follow-up", "id": "4876876000016390067", "type": "tasks" } ] } ], "criteria_details": { "relational_criteria": { "module_selection": null, "criteria": null, "module": null }, "criteria": { "group_operator": "AND", "group": [ { "comparator": "equal", "field": { "api_name": "Amount", "id": "4876876000000002557" }, "type": "value", "value": "50000" }, { "comparator": "equal", "field": { "api_name": "Stage", "id": "4876876000000002565" }, "type": "value", "value": "Negotiation/Review" } ] } }, "id": "4876876000016390025" } ], "status": { "active": true } }, { "id": "4876876000012015001", "name": "Lead Assignment - North Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T11:56:20+05:30" // ... other keys omitted for brevity }, { "id": "4876876000012020001", "name": "Lead Assignment - South Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T10:30:15+05:30" // ... other keys omitted for brevity } // ... additional workflows ... ], "info": { "per_page": 200, "count": 71, "page": 1, "more_records": false } } |
The detailed response gives us a complete blueprint of the workflow. We can now see the exact business logic: the workflow triggers when deals are edited and meet two specific conditions; when the amount equals exactly $50,000 AND the stage is Negotiation/Review.
More importantly, we can see all the actions that execute: an immediate field update to mark deals as "VP notified," an email notification sent at the optimal time, and a follow-up task scheduled for one business day later. Here's what is really interesting about this detail; this workflow has never actually executed, despite being active for nearly a year, because the last_executed_time is null in the response.
Now we are left with some important questions. Is that $50,000 threshold too narrow? What if a $49,000 deal is just as important? And is the VP still the right person to alert? Are there additional stakeholders who should be notified beyond just the VP? These are the type of questions you can start answering once you inspect your workflows closely.
STEP 3: Check limits and distribution
Before making any changes, we must understand our automation capacity and how workflows are distributed across the organization. The Workflow APIs provide two key endpoints for this:
1. Get Workflow limits API
This API provides a comprehensive view of your organization's workflow capacity across multiple dimensions.
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/actions/rules_count
Sample Response:
{ "rules_count": { "scheduled_actions_per_rule_limit": 5, "total_rules_limit": 2500, "active_rules_configured": 71, "rules_per_process_limit": 10, "total_actions_per_rule_limit": 50, "total_rules_limit_per_module": 125, "active_rules_limit": 2000, "total_rules_configured": 82, "active_rules_limit_per_module": 75 } } |
This response gives the following information:
Total Capacity: Zylker has a generous limit of 2,500 total workflows, with only 82 currently configured. This means that they are using just 3 percent of their total capacity.
Active Workflows: There are 71 active workflows, well below their 2,000 active workflow limit
Module-level Limits: Each module can support up to 125 total workflows, with 75 of those allowed to be active simultaneously.
Action Limits: Each condition in the Workflow can contain up to 50 total actions, with a maximum of five scheduled actions.
For Zylker, this is excellent news. Only 71 active workflows out of a 2,000 limit. This means we have substantial room for growth and can confidently create new workflows without worrying about capacity constraints.
2. Get module-wise counts API
This API tells you exactly how many workflow rules you have in each module. It shows both the total number of rules and how many are currently active. This helps you see where your automations are concentrated and where you might be missing opportunities.
Sample request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/actions/module_specific_count
Sample Response:
{ "module_specific_count": [ { "active_rules_configured": 2, "module": { "api_name": "Products", "id": "4876876000000002213" }, "total_rules_configured": 2 }, { "active_rules_configured": 2, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "total_rules_configured": 2 }, { "active_rules_configured": 4, "module": { "api_name": "Contacts", "id": "4876876000000002179" }, "total_rules_configured": 5 }, { "active_rules_configured": 2, "module": { "api_name": "Appointments__s", "id": "4876876000002362026" }, "total_rules_configured": 3 }, { "active_rules_configured": 4, "module": { "api_name": "Calls", "id": "4876876000000033015" }, "total_rules_configured": 5 }, { "active_rules_configured": 43, "module": { "api_name": "Leads", "id": "4876876000000002175" }, "total_rules_configured": 51 }, { "active_rules_configured": 14, "module": { "api_name": "Emails", "id": "4876876000000014163" }, "total_rules_configured": 15 } ] } |
Looking at this response, we can see 43 active workflows in Leads but only two in Deals. This tells us that Zylker is heavily focused on lead management but might be missing opportunities to automate their sales process later in the pipeline.
Together, these two APIs give a complete picture of the automation capacity and distribution.
What's next: From understanding to action
Now that we have our foundation, we are ready to start building and refining.
In the next part of this Kaizen series, we will move from discovery to design. We’ll use the Workflow Configuration, Create, and Update APIs to standardize Zylker’s automation management, create new workflow rules, and update existing ones for consistency and efficiency.
We hope that you find this post on Workflow APIs useful. If you have any feedback, or if there are any pain-points that you would like us to address in our Kaizen series, please let us know in the comments, or reach out to us via support@zohocrm.com. We will be happy to help!
Until we meet again next Friday, Happy coding!
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
Nederlandse Hulpbronnen
Recent Topics
'UnAuthenticated Connection: zbooks_connection'
I have a zoho connection in Zoho Books, the link name es zbooks_connection, but I like to validate if exist, by example if I use this line in my code: response=zoho.books.getTemplates("", "","zbooks_connection"); But I don't have the connection I likeCalling the new 'Custom API' feature from within a Custom Widget
From what I've learned it is not possible to call an endpoint from the new "Custom API" feature within a Creator Widget. The SDK's doesn't support it yet, when calling it natively you end up with CORS issues or at least I couldn't get it working evenCannot post to Instagram. I get the error: Insufficient permission to publish on this page. Check with your page Admin to update permissions.
We had another admin that left the company. Since he left, we get this error when posting to Instagram.Zoho desk desktop application
does zoho desk has a destop applicaion?Ability to re-order Workflow Rules
We really need the ability to re-order workflow rules within departments. Either the ability to drag/drop them into a different order or something.Create an article template
I have a question concern the Knolwedge Database from Zoho Desk. There is any possibility to create an article template ? Exemple of what I research : TODAY : I want to create a lot af articles with the same baseline > I create one article > I copy/pasteChange of Blog Author
Hi, I am creating the blog post on behalf of my colleague. When I publish the post, it is showing my name as author of the post which is not intended and needs to be changed to my colleague's name. How can I change the name of the author in the blogs?? Thanks, RamananZoho FSM API Delete Record
Hi FSM Team, It would be great if you could delete a record via API. Thank you,Instant Messaging Update | Now migrate your WhatsApp Business phonenumber from another BSP to Zoho Desk | Dec'23
Hi All, Everything seems to move at lightning speed these days, and time is certainly flying by for the IM team. But we are delighted at how much ground we covered this year. 🚀 For one, we enabled WhatsApp business phone number migration so that youUpload ticket attachments via Drag-&-Drop
Hello, if you want to upload a file to the ticket attachment you need to click the button and use the file browser to select and upload the desired file. In many cases, it would be much more efficient if you could simply drag the file to the browser window...Can we disable add to cart in Zoho Commerce?
Hello, Our sales happen on the phone. During the call the customer is directed to our website to inspect the products together with the sales rep. So we need a way to present our inventory. I figured Zoho Commerce is a good fit for this use case. HoweverIntroducing WhatsApp integration in Bigin
Greetings! In today's business landscape, messaging apps play a significant role in customer operations. Customers can engage with businesses, seek support, ask questions, receive personalized recommendations, read reviews, and even make purchases—allZoho One account closure vs deactivation
I wonder what are the best practices and guidelines around deactivating vs deleting Zoho accounts in organisations? Any practical considerations?Schedule Zoho CRM reports only on Business Days
Hello, Is it possible to schedule reports only on business days ? We currently get daily sales reports on weekend which has no value since the sales team doesn't work on weekends. ThanksHow to install Widget in inventory module
Hi， I am trying to install a app into Sales Order Module related list, however there is no button allow me to do that. May I ask how to install widget to inventory module related list?How to track a contact or customer's past product purchases in Bigin Premiere?
Hello there. I am the sole user of Bigin for a small company (chess club), and would like to track current and past purchases made by a contact (player) or company (family which includes the player). Players may register for multiple tournaments, takeLENTITUD EN RECIBIR MAIL
Buenas tardes, Estamos experimentando lentitud en la recepción de correos electrónicos.Items should display under specific warehouse
I have configured the multi warehouse but it show all the items under all warehouse which is not correct according to our business logic, so i want that items should only display under that specific warehouse not under all the warehouses not even with zero quantity. Some items should be common but not all so is there any option for that purpose so i can specific the items to its warehouse. RegardsPartial refunds
I am trying to process refund for a one item invoice, however the refund is partial: i am getting this error while creating credit note, can anyone share some wisdom about thisBest practice importing items and matching assemblies
Hi, I was wondering what would be the best practice to import items and composite items (assemblies) From my backup, what should I import first? The items or the composite items? I am on Zoho one, using inventory and books. Kind regards, SabineBulk Fill In & Edit PO/Bill/SO/Invoice
Hello, I am adding stock in bulk on a PO, the system is automatically populating the Rate (price) and Tax from the item data. Problem is that the bill rate is different from the rate on the item data, so I have to manually erase each and enter the price.Items Below Reorder Point Report?
Is there a way to run a report of Items that are below the Reorder Point? I don't see this as a specific report, nor can I figure out how to customize any of the other stock reports to give me this information. Please tell me I'm missing something sCancelled Transfer order problem
Hello, We've canceled a transfer order, and we can't add the related items to a new Transfer Order. The system tells us that the bin doesn't have the required quantity, but when we check the item, it indicates that there are 2 units in the bin. It alsoCreating a Chart from a Report
In Zoho Analytics, is it possible to create a chart from a Pivot View report? We are looking to use Zoho Analytics to replace Excel for Sales reports and would like to be able to show both the table and the chart together.Client Portal ZOHO ONE
Dear Zoho one is fantastic option for companies but it seems to me that it is still an aggregation of aps let me explain I have zoho books with client portal so client access their invoice then I have zoho project with client portal so they can access their project but not their invoice without another URL another LOGIN Are you planning in creating a beautiful UI portal for client so we can control access to client in one location to multiple aps at least unify project and invoice aps that wouldEmail Insights included in Bigin emals are marked as SPAM everywhere
Today I noticed that email recipients who use Office 365 never receive emails sent from Bigin. Further examination showed that all Email Insights links in email headers are marked as spam/phishing by Office 365. Example screen included. The problem isData Import | Zoho Analytics Custom Query Window Size
Please increase the window size for the Custom Query Data Import. It's impossible to work with such a small query window.Name changed in settings for mailbox but still not changed when typed in To field
In the email account secretary@ i have updaetd the new staff members details but the old members name still appears when I type secretary@ in the To field. I cant work out where Zoho is finding the old name from. I have deleted the browser cache. If ICannot add my name to my domain name
I want to have My name@mydomain.com and it says my name is linked to another account already. Please fix it since I do not have another account.Establishing new Zoho email account on laptop
Good Morning: I am very long time Outlook business user and decided to try your email service last night and had established an account. I am trying to verify my account; how do I establish my Zoho email account on my laptop? I opened the account withunable to send message reason 550 5.4.6 unusual sending activity
My email account can't send message. It shows unable to send message reason 550 5.4.6 unusual sending activity detectedhow to add email to existing organization i w
I am already registered my organization and i have an email id. I need one more email id but i can't find anywhere .i want the cheapest email id . how to add ?e-mail bloqueado
Estou com meu e-mail lucas@peplus.me bloqueado, preciso desbloquear para retorno de usos em minhas atividades.zoho labels api not working
We're using n8n to automte email reply using zoho api. I'm facing issue with label api. I added the required scopes but its not working. i followed zoho api documentation but didn't work. also, where do i find/how do i create zoho oauth token mentioneeedDesk DMARC forwarding failure for some senders
I am not receiving important emails into Desk, because of DMARC errors. Here's what's happening: 1. email is sent from customer e.g. john@doe.com, to my email address, e.g info@acme.com 2. email is delivered successfully to info@acme.com (a shared inboxStreams/Shared email doesn't show up in windows trident app. It works fine on MAC. Is there any difference between 2 install ?
I can see streams/share email boxs on my MAC version of trident app but i can't see them in windows version of trident app. Is there any difference between 2 install? I try to find setting but not able to see any setting to add stream/share email boxes.add zoho account
How to add a zoho mail to previous zoho account? I have twoZoho Desk Mobile App Year-End Roundup - 2025
Dear Zoho Desk users, Greetings! As you gear up for the festive season, we are excited to share a quick journey into all that is released in 2025! Zia's generative AI capabilities Zia insights can be highly beneficial in helping agents manage daily supportNarrative 17: The role of Zia AI in customer support
Behind the scenes of a successful ticketing system: BTS Series Narrative 17: The role of Zia AI in customer support Overview Zia in Zoho Desk is a layered AI assistant that combines generative AI, prediction, and automation to support agents, automateDomain Transaction
I have purchased a domain name called trainedworkforce.co.in I made the payment got the receipt but the domain is still not purchased after successful transaction .Next Page