Kaizen #148 - 'trigger' in Records APIs

Kaizen #148 - 'trigger' in Records APIs



Hello everyone!
Welcome to another week of Kaizen!
In today's post, we will discuss the "trigger" key in the Insert, Update, and Upsert records APIs.

What is "trigger"?

"trigger" is a key of the JSON type array. You can use this key in insert, update, or upsert records APIs to:
  • trigger workflows
  • make the records enter a blueprint
  • send records for approval
  • start the path finder journey of the record

JSON format

{
"data": [
],
"trigger": ["workflow", "blueprint", "approval", "pathfinder", "orchestration"]
}

Key Points

  • If you do not include the "trigger" key, all automation actions like workflow, blueprint, approval, etc, will be triggered if the conditions are met.
  • If you include the "trigger" key and specify the automation actions, the specified actions will only be triggered.
  • If you include an empty array for the "trigger" key, no automation actions will be executed.

Let us consider a sample use case where Zylker Inc. wants to close the deals when the amount is greater than $50,000, within a week after they were created or edited.
Zylker Inc has set up a workflow "Notify Record Owner". this workflow is triggered whenever the Deal Amount is greater than $50,000, and creates a ask to the record owner to close the deal within a week. The workflow also includes reminders.
Here is a glimpse of the workflow.



1. The default flow

Automation rules have a set of conditions that allow the records to fall into that process when these conditions are met.
So, when you create/update/upsert a record, and that record matches the criteria in any of the automation rules, those rules are triggered automatically. Hence, you need not specify the 'trigger' key in the input body.
In the below example, the insert records API does not have the "trigger" key, but the workflow is triggered.



2. An empty 'trigger' array

Sometimes, you do not want any of the automation actions to trigger when you create, update, or upsert a record. In that case, you can pass an empty array to the trigger key. An empty trigger array prevents the execution of automation rules.

Request URL: {{api-domain}}/crm/v6/Leads
Input:
{
"data": [
{
"Deal_Name": "Kaizen deal 1",
"Amount": 65000,
"Stage": "Negotiation/Review",
"Pipeline": "Standard (Standard)",
"layout_id": {
"id": "3652397000000091023"
},
"Lead_Source": "Employee Referral"
}
],
"trigger": []
}

In the following GIF, you can see that the workflow is not triggered.



3. Trigger specific automation action

Many times, when a record is created or edited, the criteria in more than one automation action may match. For example, a record creation can trigger both workflow and blueprint, but you want to trigger only the workflow.
In this case, you must pass only the value "workflow" to the trigger key.
Here is the input JSON.

{
"data": [
{
"Deal_Name": "Kaizen deal 2",
"Amount": 65000,
"Stage": "Negotiation/Review",
"Pipeline": "Standard (Standard)",
"layout_id": {
"id": "3652397000000091023"
},
"Lead_Source": "Employee Referral"
}
],
"trigger": ["workflow"]
}

This triggers only the workflow and prevents the execution of other automation actions such as blueprint, approvals, orchestration etc. Similarly, if you want to trigger only the blueprint, pass the value "blueprint" to the trigger array.

Equivalent Deluge Script using v2 Integration Task

mp=map();
mp.put("Deal_Name","Kaizen Deal 3");
mp.put("Amount",90000);
mp.put("Account_Name","ABC");
mp.put("Stage","Negotiation/Review");
mp.put("Pipeline","Standard (Standard)");
mp.put("Layout", "3652397000000091023");
mp.put("Lead_Source","Employee Referral");
mp.put("Closing_Date","2024-07-30");

resp= zoho.crm.createRecord("Deals",mp,{"trigger":{"workflow"}});
info resp;

Here is the task created through the workflow after executing this function.


Similarly, you can pass the required values to the trigger key to execute the required automation actions.

We hope you found this post useful. Let us know your thoughts in the comments or write to us at support@zohocrm.com.
We'll see you next week with another interesting topic.


Cheers!

    Access your files securely from anywhere







                            Zoho Developer Community




                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts



                                                            • Sticky Posts

                                                            • Kaizen #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
                                                            • Kaizen #152 - Client Script Support for the new Canvas Record Forms

                                                              Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
                                                            • Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

                                                              Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
                                                            • Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

                                                              Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the


                                                            Manage your brands on social media



                                                                  Zoho TeamInbox Resources



                                                                      Zoho CRM Plus Resources

                                                                        Zoho Books Resources


                                                                          Zoho Subscriptions Resources

                                                                            Zoho Projects Resources


                                                                              Zoho Sprints Resources


                                                                                Qntrl Resources


                                                                                  Zoho Creator Resources



                                                                                      Zoho CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner









                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources

                                                                                              Zoho Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ



                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                              • Recent Topics

                                                                                                              • Any insights about API/v2? Having problem for a while.

                                                                                                                I don't know why it is throwing a 404 error, my report name is correct. Has someone had this issue and how you fix it?
                                                                                                              • Edit QR code with redirect to form

                                                                                                                Guten morgen, wir haben ein Formular Reklamation_erstellen. Dort soll ein QR Code erstellt werden, der im Lieferschein angezeigt wird. Beim Scannen auf dem soll das jeweilige Formular zum BEARBEITEN geöffnet werden. Leider bekomme ich es nur so hin, dass
                                                                                                              • Getting all the ingredients together for baking an app

                                                                                                                Good day everyone. After reading a lot of the help docs and watching videos, I now started on my app. To prevent hours and hours wasted on going down the wrong track, I would like some clarification on the following. But first some background: I have
                                                                                                              • Help Needed with Configuring ZC Microservice

                                                                                                                I'm attempting to create a simple microservice, but am running into problems with scope and auth. Using Custom API Builder, here's my setup: 1. Method: GET 2. Auth: OAuth2 3. User Scope: All users 4. Response: Standard 5. Function: A function that returns
                                                                                                              • Creator Simplified #10: Predefine Form Field Values and Make Them Read-Only for Users

                                                                                                                Hey Creators, Ready for this week's tip in the Creator Simplified series? Today, we will explore how to have read only fields in a form. Use Case: Assume a scenario where the default value for a Department field needs to be English Literature, but you
                                                                                                              • Zoho Mail : Email Outgoing Blocked

                                                                                                                I suddenly received the following message yesterday. I cannot send any mail. Please resolve as soon as possible, I cannot work without sending email. Dear User, We regret to inform you that your email outgoing has been blocked and you will not be able
                                                                                                              • Creator and Tables

                                                                                                                Good day. I am trying to create my first application. I have imported my data into Tables and am creating my app in Creator. I do not see my tables and cannot see how to write forms data to a table. Even the Workflow just uses the form. In one of the
                                                                                                              • customer Name and address details

                                                                                                                i created one application there is no customer details in that . how to add customer details and
                                                                                                              • Recalculate every row in the subform

                                                                                                                Hello, Can anyone help me with a script, please? I have an issue. Sometimes it happens, that in a multi row subform one of the rows show an incorrect row total value. Not really understand how it can happen, if I have a 20 row subform, 19 rows show correct
                                                                                                              • Creating Repeat Forms that remove redundancies

                                                                                                                I wanted to understand if you can make multi-layer forms that reduce the need for users to input information in again and again. We want a form that our suppliers fill out per ingredient they sell, and the end result should have the Ingredient (Section
                                                                                                              • What is the difference between the free plan and the mail lite plan?

                                                                                                                What is the difference between the free plan and the mail lite plan? How many emails can I send per day?
                                                                                                              • Unblock email

                                                                                                                Hi The outgoing mail from a client of me is blocked. I already made tickets and tickets are send to the EU desk but nobody is responding. The problem is already 4 days! There is absolutely no help from the support. I am really not satisfied at all! Can
                                                                                                              • Domain verification failure

                                                                                                                Hello Zoho Support, I purchased my domain directly through Zoho Mail, but the domain verification keeps failing with the message “TXT verification failed.” I’ve already waited and retried several times, but it still won’t verify. Could you please manually
                                                                                                              • Unable to send message;Reason:554 5.1.8 Email Outgoing Blocked.

                                                                                                                My email account is unable to send emails, and I urgently need to use it. How can I resolve this?If there is anything we have done wrong, please let us know in advance so we can actively cooperate to improve. User ID: 850482493
                                                                                                              • URGENT: Email stopped workin - can't access admin panel

                                                                                                                For some reason email sending stopped working. When I try to send an email it fails with "Unable to send message;Reason:451 4.7.1 Temporary system error" I can receive email just fine I see in my notifications some errors about the MX records, however
                                                                                                              • Can I associate an invoice to a Project after the fact?

                                                                                                                We have generated an invoice but would like to assoicate it to a Zoho Project after the fact.  Is there any way to accomplish that? Thanks, Scott
                                                                                                              • Emails I send as a cc or bcc NEVER GO THROUGH TO THA RECEIVER !!

                                                                                                                every time i send a cc or bcc copy of an email to anyone when I’m using my zohomail.com email - no one ever gets the cc of bcc copy if the email: why???? And i triple check that the email addresses are correct; then i get back an email message (EVERYTIME)
                                                                                                              • Cannot see correct DNS config for mail after moving domain to another provider

                                                                                                                I have moved my domain from one provider to another and after that zoho mail stopped working (expected). Problem is, zoho mail admin panel still shows (10 hours after move) that all records are correct while I haven't changed anything in my domain DNS
                                                                                                              • Add Support for Authenticator App MFA in Zoho Desk Help Center

                                                                                                                Hello Zoho Desk Team, We hope you are doing well. We would like to request an enhancement related to security for the Zoho Desk Help Center (customer portal). Currently, the Help Center supports MFA for portal users via SAML, JWT, SMS authentication,
                                                                                                              • Auto-fill Contacts in Zoho Mail not working for me

                                                                                                                We just switched to Zoho Mail for our company, and I am noticing that the "auto fill" feature when composing an email -- where the "to" field is autofilled (like in the attachment) from Contatcts works for everyone except me. Any way I might have made
                                                                                                              • How to unlink a SAML user from the existing Zoho Desk user (domain change case)

                                                                                                                Hi everyone, I’m trying to understand how to handle a situation where a customer changes their company domain. In our setup, users authenticate via SAML, so when the domain changes, the SAML system treats them as a new user. However, in Zoho Desk, I’d
                                                                                                              • Price Managment

                                                                                                                I have been in discussions with Zoho for some time and not getting what I need. Maybe someone can help explain the logic behind this for me as I fail to understand. When creating an item, you input a sales rate and purchase rate. These rates are just
                                                                                                              • Related to zoho survey

                                                                                                                Hi team. I want to know something regarding zoho survey question builder. I have two questions each of dropdown (One answer) - question type. In the first question, there are 16 answer choices and in the second question, there are 3 answer choices. For
                                                                                                              • Text Message

                                                                                                                When trying to sent a text message, it says its an error i should contact a zoho agent
                                                                                                              • Zoho POS is now available for Canadian retailers

                                                                                                                Hey everyone, We're excited to introduce the all-new Canadian edition of Zoho POS, which helps retail businesses simplify and manage their end-to-end business operations. Start by signing up and exploring the 15-day free trial. Sign up now How does Zoho
                                                                                                              • Payroll In Canada

                                                                                                                Hi, When can we expect to have payroll in Canada with books 
                                                                                                              • Mass update to change or shift all project dates and keep project structure + shift all sub-tasks dates with main tasks

                                                                                                                Most users would expect that if they change the start date of their project then that will be reflected inside the actual project and any project structure would be retained.  Additionally if a task list with associated sub-tasks is moved, most users would expect that those sub-tasks would also be moved along with their parent task.  This is not the case. For a total Project shift of dates: * the start and end date from > "Edit Project" page can have a radio button added to "shift all project tasks
                                                                                                              • Closing Accounting Periods - Invoice/Posting dates

                                                                                                                Hi, I have seen in another thread but I'm unsure on how the 'transaction locking' works with regards to new and old transactions. When producing monthly accounts if I close December 24 accounts on 8th Jan 25 will transaction locking prevent me from posting
                                                                                                              • In-person ZUG Meetups for Real Estate Professionals - US Q1 2026

                                                                                                                The Real Estate Zoho User Group is going on a multi-city, in-person meetup tour across the US, and we’d love to see you there! These meetups are a great opportunity to: Connect with fellow real estate professionals using Zoho Share challenges and discover
                                                                                                              • Zoho CRM custom fields not showing in zoho creator

                                                                                                                Hi Team, I have created a Products form with Zoho CRM integration and connected it to Products module of CRM. But when I see the reports of Products in Zoho creator then I am not able to see custom fields of Products module. Only standard fields of Products
                                                                                                              • Sending email notifications based on language

                                                                                                                Hello. I would like to know how we can bypass the default notifications (which are just in English) for when a ticket is created/replied to/closed, to be in other languages, based on the language field in the ticket? I can create other email templates,
                                                                                                              • Zoho Error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details

                                                                                                                Hello There, l tried to verify my domain (florindagoreti.com.br) and its shows this error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details. Screenshot Given Below -  please check what went wrong. Thanks
                                                                                                              • Download a file from within a zoho creator widget

                                                                                                                I have a widget running in Zoho Creator , it displays uploaded documents in a table file, and I have added a download link in the view. ( The widget is created with html, css and javascript). I do not succeed in getting the download working. Do I have
                                                                                                              • Zoho / Outlook Calendar sync

                                                                                                                The current Marketplace -> Microsoft -> Meetings integration needs 2 changes. 1. The current language for the Two-Way sync option should be changed. It currently states, "Sync both your Zoho CRM Calendar and Office 365 Calendar meetings with each other."
                                                                                                              • Email content just contain 'OK' ,not what we expect

                                                                                                                create campaign API URL: https://campaigns.zoho.com/api/v1.1/createCampaign req params: {'campaignname': 'General_Outreach_d0cfc415-43aa-4b96-bb09-558e76a3dda3_50_20251117_214806_660', 'from_email': 'admin@allinmedia.ai', 'subject': 'ALL IN MEDIA', 'list_details':
                                                                                                              • Possible to connect Zoho CRM's Sandbox with Zoho Creator's Sandbox?

                                                                                                                We are making some big changes on our CRM so we are testing it out in CRM's Sandbox. We also have a Zoho Creator app that we need to test. Is it possible to connect Zoho CRM's Sandbox to Zoho Creator's Sandbox so that I can perform those tests?
                                                                                                              • Reopen ticket

                                                                                                                Hello! Can I reopen a ticket just using the API ticket/sendReply ? What's the rules to do it? I'm trying but it doesn't reopen the ticket, it just send the reply
                                                                                                              • Allow Admins to Transfer Ownership of Their Own Files & Folders

                                                                                                                Hi Zoho WorkDrive Team, Hope you are doing well. We would like to request an important enhancement to the ownership-transfer functionality in Zoho WorkDrive, specifically regarding administrator capabilities. As administrators, we have the ability to
                                                                                                              • Tip#46: Capture accurate log hours

                                                                                                                Hello everyone, Use the newly introduced timer settings that will streamline the usage of timers and help admins or workspace owners to manage the time entries of the workspace users better. Check out the below mentioned timer settings added to the Timesheet
                                                                                                              • Moving to app-specific authentication for Google integrations

                                                                                                                Hello everyone, We’re making an important change to how Google integrations work in our platform. Until now, we used a common Google project across Zoho to enable integrations like Google Drive, Calendar, and more. Going forward, we’ll be moving to an
                                                                                                              • Next Page