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
Operation Questions.
Hello, I hope you are well. To explain a little, we are a company that sells services and products with a technical team responsible for installation and maintenance. Zoho FSM can be useful for the technical team, namely for the technical coordinatorUpdate date & time when a cell is edited
Hi All, I am desiring to have a cell update with the current date and time when another cell is edited. Any ideas? Thank youAdd "Groups" to "Share With" on Reports & All Entries
Hi, On Forms we can share Publicly, with Specific Users And/Or Specific Groups or All Users. With Reports and All Entries we lack the "Groups" option, please add this as with many users this saves a lot of work. Thanks DanAdd Pause / Resume Option to Zoho Quartz Recordings
Hi Zoho Team, We would like to request an enhancement to Zoho Quartz recordings: the ability to pause and resume an ongoing recording. Current Limitation: At the moment, when recording an issue with Zoho Quartz, the recording continues even when we areCustom Fields Not Showing Up in Invoice PDF Template Document Information
I have added 2 custom fields under Sales > Invoices > Manage Custom Fields. They are set to show in all PDFs. However when I am editing my Invoice PDF template, i do not see the custom fields under Document Information.ZOHO Books
Hi there, Why after I upgrade my Zoho invoice > Books then i wanted to add plugin which i cannot do. Please advise.How is Your eCommerce Experience w/Zoho Inventory?
First off, I'm SUPER grateful for the advent of Zoho Inventory and now the Zoho Commerce Suite. Overall, Inventory is a great product, especially for customers without an eCommerce presence. For eCommerce companies (especially those shipping more than ~10 packages/day), however, there are certain drawbacks that keep my clients from moving over to Zoho Inventory: Cons: 1. Invoice + Package Creation from Shopify/Other eCommerce Integrations: Zoho Inventory makes the somewhat perplexing decision toSimplify Mass Replies with Predefined Templates and Snippets
Hello everyone, We are happy to introduce a new enhancement to Mass Reply that helps agents respond to customers quickly and consistently. With the addition of Email Templates and Snippets in the reply window, agents can use predefined messages whileMapping custom fields from one module to another
I have a custom field, "Subscription Period" that appears as a required field in every Opportunity (Potential). I want that field to appear on any Quotes derived from that Opportunity (and have created a custom field of the same name in Quotes for thatThe Social Wall: November 2025
We’re nearing the end of the year, and the holiday season is officially kicking in! It’s that time when sales peak and your social media game needs to be stronger than ever. We’re back with exciting new updates across AI, analytics, and the mobile appHow to update Multi File upload field
Assume that i have a multi file upload field,how can i update the same field again?Customer Address Not on Standard Invoice when Address is on Contact Record
Hi, I entered the customer billing and shipping address in Zoho CRM. I created an invoice in Zoho Books with the same customer contact. The contact is correctly in Zoho Books with the billing and shipping address. The invoice for the customer does notApply partial payments to invoices from the Banking Module
We need this! Why is this not possible?Welcome to the Zoho Show Community Forums page!
Hello everyone, The Zoho Show community is a place for you to discuss and share anything and everything related to Zoho Show Presentations, our online presentation software. It includes users from all over the globe and all walks of life. Our community helps answer your Zoho Show questions with responses from other knowledgeable community members to give you the best experience creating and designing exciting presentations. Along the way, you'll meet recognized experts from our software team andHow can I convert an existing contact into a lead?
I imported many contacts into ZOHO CRM. In order to select a few of them as leads, I want to mark or convert a few hundred as Leads. Who can I do that?Price book functionality enhancement
A common use of price books is to create a price book for a given customer level or contract with a specific company. Given that this is done at a company/customer level it would be great to see a way to associate a price book to a given customer andCan we have 24x7 live support for Zohobooks ?
Can we have 24x7 live support for Zohobooks ?Important update about notification security in Business Messaging SDK
As part of our ongoing effort to strengthen the security of notification data, we have enhanced how notifications are processed and protected in our applications. These improvements ensure that all notification related data follows the most up-to-dateSync Zoho Marketing Automation with Zoho Forms
I can't find a section where the integration between Zoho Marketing Automation and Zoho form is explained. And how form subscription works with opt-in and consents.What is the difference between Zoho Campaigns and marketing hub?
Zoho Campaigns is a permission-based email marketing tool for sending marketing emails and mass emails. Marketing Automation is a multichannel marketing automation tool that caters to organizations looking for tools to engage their users across multipleWebhook not firing.
I created a webhook using the Web UI, it looks very nice and the testing worked without an issue, but when i save/ update a ticket, the webhook is not firing. Here are the details of the web-hook i get from using the API "modifiedTime": "2019-10-22T09:23:37.380Z",Duplicate customers being created in Desk
Hi I've trying to work out why I've getting duplicated customers being created in my desk. I have an external booking system that generates an email when I get a customer booking a job. A booking email gets sent to Desk where I manage the booking andCreating a custom CSV file using deluge script/
I have an application I have developed and the client wants us to place an export file in csv onto an ftp server daily. Now I don't see au options in creator to change the separator to anything else. The client wants the separator to be the pipe symbol "|" I think i would be able to create schedule with some code to create the appropriate data in a string using deluge script but I haven't seen any functionality that would allow me to deposit that data as a file anywhere or attach it to an emailCan we add custom fields to portal community profiles?
How do we add custom fields to our profile pages in our portal community? If we have the ability to add custom fields, will we be able to access those fields via API? We want to use our Desk community in our help portal as our primary community and wouldE-Invoicing in Belgium with Zoho Billing
Starting January 1, 2026, Belgium is introducing mandatory electronic invoices (e-invoicing) for all B2B transactions between VAT-registered businesses. Invoices and credits notes must be exchanged in a prescribed digital format. How E-Invoicing worksdelayed: host mx2.zoho.com (136.143.183.44): Network error: Unexpectedly disconnected (STARTTLS)
Hi Team, I'm not receiving any email. Seems to be an issue. Sender sent me the error message they received: "delayed: host mx2.zoho.com (136.143.183.44): Network error: Unexpectedly disconnected (STARTTLS)" Please advise.Additional Address - Company Name
It would be very helpful to have a "Company Name" field in the Additional Address shipping section. In a situation where you drop-ship orders to a different address or different company entirely, it may be necessary to list the company name of the receiver. I understand that the Attention field can be used for that purpose, but that's not really the intended purpose of that field.Incorrect Email Notifications for Product Reviews
Dear Zoho Commerce Support Team, I am writing to report a technical issue that occurs frequently on our platform. Problem Description: We regularly receive email notifications informing us of new product reviews awaiting approval. However, when we accessHow to Rank Tables by Row Count in Descending Order
I am trying to understand the consume of lines that grow up so fast in the last week. Is there any way to create a pivot table or query to get TABLE NAME LINES in descending order?Can we do Image swatches for color variants?
We want to do something like the attached screenshot on our new zoho store. We need image swatches instead of normal text selection. We want to user to select an image as color option. Is this doable? I don't see any option on zoho backend. Please hannualy customer report
we need a report per customer that looks like this invoic number cleaning laundry repair management 01 january xxx euro xx euro xx euro xxx euro 02 february xxx euro xxx euro x euro xxxx euro and so on the years 12 months is that possible to make andExport your notes from Notebook!
Dear users, The long awaited feature is now live. Yes, you can now export your notes from Notebook app in bulk. But the feature has just started with web app alone for now. You can try the export feature as mentioned below: Go to our web app, https://notebook.zoho.com Go to 'Settings' > 'Export' Now, select the format: You can select either ZNote or HTML Once done, you can use the same to import or can have this a local backup of your notes. Note: Export for other platforms are in development andCanva Integration
Hello! As many marketing departments are streamlining their teams, many have begun utilizing Canva for all design mockups and approvals prior to its integration into Marketing automation software. While Zoho Social has this integration already accomplished,Prepopulating Fields
Hello, I have a form (Assets) with 2 lookup fields: Client (from Clients) Site (from Client Sites) I modified the code (highlighted in red below), so the Site dropdown shows the list of sites related to the Client. must have Client_Site ( type = picklistREPORT THAT SHOWS SOH FOR ITEMS THAT HAVE ZERO SALES
When we started Zoho we imported a lot of inventory lines directly off our suppliers price list and have never ordered / sold. I want to clean up our data base and remove all these lines. What reeport will show me what lines have zero sales as well asAutomation series : Close all tasks once the project is completed
When a project is marked as Completed, it might still have open tasks such as recurring tasks that were not marked as complete, tasks that are no longer relevant, or tasks that no longer need attention after closure. To ensure the project reflects itsConverting Sales Order to Purchase Order
Hi All, Firstly, this code works to convert a sales order(SO) to a purchase order (PO) via a button, however I am running into an issue when I convert the SO where the values from the line items are not pulled across from the SO to the PO. The ones inHorrible Connectivity!
I have used Meetings several times, but most of the time the connection is horrible. The video freezes, the audio freezes, and we end up cancelling the meeting. I am on a high speed internet connection, and Zoom works fine, so I know it's not a problemIs it really true that I can't set the default 'deposit to' account in 2025?
I've been using Books for 7 years and the default account has never been a problem. I usually manually reconcile invoices and have never had a thought about which account. It has always been my account. However, I recently noticed that for the past 4Zoho DataPrep switching Date Format
When using a pipeline that is importing Zoho Analytics data into Zoho DataPrep, the month and day of date fields are switched for some columns. For example, a Zoho Analytics record of "Nov. 8, 2025" will appear in Zoho DataPrep as "2025/08/11" in "yyyy/MM/dd"Next Page