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
Recent Topics
Re: Ca.gory groups and not all email addresses being added to a group emails
Hi, I have added emails under 'Contacts' into categories but when sending a group email and putting the category name in not all email addresses go onto the email. I have refreshed the page, deleted and redone the info etc with no luck. I only found outIMPORTANT
Dear Zoho Support Team, I am currently experiencing an issue when trying to send emails from my Zoho Mail account. Each time I attempt to send a message, I receive the following error: "Unable to send message; Reason: 554 5.1.8 Email Outgoing Blocked."Able to Send Emails from Zoho but Not Receiving Emails from Gmail
Hello, I am experiencing an issue with my shopify domain email setup and would appreciate your help. Current situation: I can successfully send emails using Zoho. I can receive emails from some services (for example, Facebook). However, I cannot receiveAntispam validation failed for your domain in Accounts
I tried adding a domain to zeptomail.zoho.com, but the “add domain” operation failed. The front‑end error reads: “Domain could not be added. Please contact support@zeptomail.com.” The back‑end API returned: ``` { "error": { "code": "TM_3601", "details":Announcing new features in Trident for Windows (v.1.38.5.0)
Hello Community! Trident for Windows just received a major update, with a range of capabilities that focuses on strengthening and enhancing communication. Let’s dive into what’s new! View complete technical email details. For those who need deeper visibilityWindows Desktop App - request to add minimization/startup options
Support Team, Can you submit the following request to your development team? Here is what would be optimal in my opinion from UX perspective: 1) In the "Application Menu", add a menu item to Exit the app, as well as an alt-key shortcut for these menusAccounting of Amazon
I have recently started selling on Amazon.in and I am facing issues with different types of transactions: What entry to do in case of return? If I had sent two products and customer returned both the products but I had received only one and got the claimCompose Emails Faster Using Templates and Snippet
Hello everyone, We have made an enhancement to the Send as Email option in Tickets. Agents can use templates and snippets to draft their response, which helps save time and maintain consistency. The Send as Email page will display the available templatesCustomize Colors used on graphs and charts according to users desire.
It would be great if we could customize the graph's colors as we see fit. I hate that yellow is always the default color!Emails not integrating
My emails from Hubspot did not integrtate over. How do I fix that?Creating meetings from an email
Hi. Similar to Outlook, it would be helpful if a meeting can be scheduled from an email so that the attendees need not be manually entered every time it's created.Zoho Social API for generating draft posts from a third-party app ?
Hello everyone, I hope you are all well. I have a question regarding Zoho Social. I am developing an application that generates social media posts, and I would like to be able to incorporate a feature that allows saving these posts as drafts in Zoho Social.CRM Percent custom fields: When will it show the % symbol and behave like %?
1. Actually Percent custom fields fail to show the % symbol. 2. When in formulas Percent fields work like number: 100 x 5% = 5 ideal world 100 x 5% = 500 what happens actually 3. When importing Percent fields the % symbol has to be removed and the dataDeprecation 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 connectorRouteIQ for Zoho FSM
Beste, Zou wel top zijn dat we een RouteIQ hebben voor FSM aangezien we constant moeten zien wat de beste route is voor onze monteurs. Nu moeten we een speciale aparte programma hebben om de beste route te berrekenen voor onze monteurs aangezien de planningLet us view and export the full price books data from CRM
I quote out of CRM, some of my clients have specialised pricing for specific products - therefore we use Price Books to manage these special prices. I can only see the breakdown of the products listed in the price book and the specialised pricing forChanges to the send mail Deluge task in Zoho CRM
Hello everyone, At Zoho, we continuously enhance our security measures to ensure a safer experience for all users. As part of our ongoing security enhancements, we're making an important update on using the send mail Deluge task in Zoho CRM. What's changing?How to Invoice Based on Timesheet Hours Logged on a Zoho FSM Work Order
Hi everyone, We’re working on optimizing our invoicing process in Zoho FSM, and we’ve run into a bit of a roadblock. Here’s our goal: We want to invoice based on the actual number of hours logged by our technicians on a job, specifically using the timesheetsInclusion is the new engagement
When in a very challenging situation, you may have peers or friends around you saying, “Everything will be okay.” They speak to you in a way that they are connected or in a language or tone that feels close. But your inner voice comes to you in a trulyDKIM verification for Squarespace website - Corrections to instructions
Zoho Campaigns DKIM TXT record instructions for Squarespace show that Host field should show: 22111._domainkey.[domain name, e.g. mywebsite.com] However, after 72hrs, I had to reach out to Squarespace tech support, and they confirmed that the domain namePassing the image/file uploaded in form to openai api
I'm trying to use the OpenAI's new vision feature where we can send image through Api. What I want is the user to upload an image in the form and send this image to OpenAI. But I can't access this image properly in deluge script. There are also some constraintsMy client requires me to have custom pdf file names to except payment for invoices, how can I customize this before emailing.
Hello! I love the program so far but there are a few things that are standing in the way. I hope you guys can code them in so I can keep the program for years to come. My client requires I customize the pdf file names I send in for billing. Can you pleaseDisable All
I want to disable all the fields on the form when it loads. I know there is a way to do this by listing all the fields as follows: disable Name; disable Address; disable City; ... I have over 50 fields on my form and i am wondering if there is a single command or way to just disable all fields on load. On load = disable All Thank you for any help.Migrating my email from GMAIL to ZOHO MAIL..........
I am a long time GMAIL user and I really only understand how they operate, but after reviewing your tutorials and forums online, it is quite unbelievable how much more and how much more streamlined ZOHO mail is, not to mention ZOHO's wonderful, more advanced capabilities. I do have several questions about transitioning over to ZOHO. Primarily, where is the best place to start, what do I do first? And how hard is it actually to move all my business and personal accounts over here? When I sign upiOS Zoho Mail App Crashesruni
Whenever I trying to search emails via the Zoho Mail app on my iPhone the app crashes, I am running the latest version of the app and the latest iOS version. I have all set reset the app and deleted the app and still have the same issue. Thank you inAssessment Answered - Automation (Related List)
Hello everyone, We have linked a candidate assessment to our job posting. When someone applies, they are required to answer all the assessment questions. However, some candidates submit their applications without completing the questions. In such cases,Paid Support Plans with Automated Billing
We (like many others, I'm sure) are designing or have paid support plans. Our design involves a given number of support hours in each plan. Here are my questions: 1) Are there any plans to add time-based plans in the Zoho Desk Support Plans feature? TheCan't change form's original name in URL
Hi all, I have been duplicating + editing forms for jobs regarding the same department to maintain formatting + styling. The issue I've not run into is because I've duplicated it from an existing form, the URL doesn't seem to want to update with the newCalendar report with order options and more quick view templates
I think many of us regularly work with calendar-style reports. It would be great to be able to customize the quick view with new templates and have options to sort the entries for each day of the calendar by different criteria. I think this is an interestingShared Views
Hello, is there a way to prevent an agent from changing a shared table view? I have no issues with agents being able to create and customize their own view, but when I create a view and share it to my team -- the expectation is that they are viewing itUsing Zoho answer bot across departments (help center articles from another department)
Hi Zoho Community, I’ve run into a major issue and hope someone here has experience with this setup. We currently have a Help Center in the department A where all of our knowledge base articles are maintained. However, we would like to use a Zoho AnswerZoho Desk Partners with Microsoft's M365 Copilot for seamless customer service experiences
Hello Zoho Desk users, We are happy to announce that Zoho Desk has partnered with Microsoft's M365 to empower customer service teams with enhanced capabilities and seamless experiences for agents. Microsoft announced their partnership during their keynoteThe Social Wall: January 2026
Hello everyone, We’re back with the first edition of The Social Wall of 2026. There’s a lot planned for the year ahead, and we’re starting with a few useful features and improvements released in January to help you get started. Create a GBP in SocialPipeline: Copying rulesets from one data source to another
When creating and editing data pipelines, it would be really helpful to be able to copy the ruleset from one data source and 'paste' it to another. This would save time and reduce manual mistakes.Doubt about maximum email reach
Good morning, greetings. This is Bramdon García from EDULABS S.A.S ESP, located in Colombia. I'm writing to inquire about the possibility of sending an email to 35,000 people simultaneously. Our company has a Zoho account, but we'd like to know if there'sZoho calendar not working in browser
Hello, I am new to Zoho. I have two accounts for two separate businesses. In one of them, calendar loads in a browser no problem. However, if I use this account (sairfeetmusic.co.uk) calendar does not load. I also cannot add it to my Thunderbird LighteningAuthentication Failure when adding POP3 accounts
Hi everyone, I am a new user currently migrating from Gmail to Zoho Mail. I decided to make the switch following Google's decision to discontinue POP3 fetching. I previously used Gmail as my primary mail hub, and Zoho seems like the perfect alternativeTrident Application Folder
Hi, How to choose installation folder for Trident, by default it gets installed in C drive. How to change drive?Email disappeared to specific contact
Good afternoon, this morning I emailed somebody. This email isn’t showing up in my sent folder. They sent me a response which I clicked on and it disappeared immediately. Why could this be?Create an Eye-Catching Announcement Widget for Your Help Center
Hello Everyone! In this week’s edition, let’s explore how to keep your customers updated with exciting news in the Help Center. See how ZylkerMobile wowed their customers by bringing updates right to their portal. ZylkerMobile, the renowned brand forNext Page