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

                                                                                                              • PROBLEMA

                                                                                                                Salve, non riesco a inviare email, e mi esce una tabela errore temporaneo. come posso risolvere il problema ?
                                                                                                              • Forever FREE Business Email with Zoho Mail

                                                                                                                Forever FREE Business Email with Zoho Mail: is it available?
                                                                                                              • Weekly Tips : Make collaboration effortless with Whiteboard in Zoho Mail

                                                                                                                Working with your team often means switching between emails, notes, and other applications just to explain an idea. Maybe you are trying to sketch a layout, plan a workflow, or quickly brainstorm ideas—with text alone, things can get confusing. So how
                                                                                                              • Formula field number of days between 2 dates

                                                                                                                Hi, I want to have a formula field which calculates the following: IF EndDate < TODAY and Oproep is true (this is a checkbox field) than EndDate - StartDate, otherwise TODAY - StartDate It should calculate the number of days How can I write this for
                                                                                                              • 'email address already exists'

                                                                                                                I deleted a user from my organization and want to use the same email address that user had, but the email address seems to still exist somewhere as I get 'email address already exists' when I try and create it. I have deleted the entire organization and
                                                                                                              • ZOHO reporting DKIM entries are not configured, when they have been configured and verified by 3rd parties

                                                                                                                Why is ZOHO reporting to my organisation users the following: "The DKIM entries in your domain's DNS records are not configured. Please contact your administrator for configuring DKIM to ensure optimal RSVP invite delivery." When I have configured the
                                                                                                              • Manage Bookings directly from Zoho Mail

                                                                                                                Greetings from the Zoho Bookings team! We’re introducing the new Zoho Bookings extension for Zoho Mail, designed to help you view appointments, copy time slots and share booking links without leaving your inbox. This integration brings scheduling right
                                                                                                              • My notes from the past 2 months have disappeared

                                                                                                                Hola, necesito ayuda urgente. Hoy, al iniciar sesión en mi Zoho Notebook como todos los días, me llevé una gran sorpresa al descubrir que todas mis notas de los últimos dos meses habían desaparecido. Estas notas son muy importantes para mí, ya que uso
                                                                                                              • How can I load a network into the cliq desktop app?

                                                                                                                I have both the standard cliq log in for my org and I am part of a cliq network. In the browser I can choose which I log in to. However, in teh desktop app if I log in it will alwasy load my org's cliq. Can I switch this to the network I have create
                                                                                                              • Ability to modify what displays in calendar invite?

                                                                                                                I am a long time calendly user and want to make the switch to bookings.  I understand that there is not currently a meets/hangouts integration, is one on the roadmap? Is there anyway I can modify the calendar invite to include the meet link?  I can add it to the emails no problem, but I would also like it to display on their calendar.  Is there some work around I can do to get it on the calendar?  Also am I able to modify the calendar event title?
                                                                                                              • Issue with Booking Confirmation Page Not Displaying, Leading to Customer Anxiety and Unnecessary Support Calls

                                                                                                                I am writing to express my growing concern regarding the confirmation process in Zoho Bookings, particularly the inconsistent display of the confirmation page after a successful payment. As a mobile service provider, I rely on Zoho Bookings platform for
                                                                                                              • Is it possible to turn off all capabilities for a customer to schedule, reschedule or cancel an appointment?

                                                                                                                Is it possible to turn off all capabilities for a customer to schedule, reschedule or cancel an appointment? I would like to set it up so only staff can schedule appointments. Is this possible?
                                                                                                              • Is there a way to generate a virtual meeting for a group service in Zoho Bookings?

                                                                                                                Are virtual meetings not supported for group services/meetings? I have integrated Zoom with one-on-one services, but I need a way to create an online group meeting. Thanks
                                                                                                              • Where we can change the icon in social preview

                                                                                                                Hi, we changed our logo, and the image that appear in preview (ex : when we post a appointment link somewhere) is still our old logo. I did change our logo in the org setting. https://bookings.zoho.com/app/#/home/dashboard/settings/basic-info?clview=false
                                                                                                              • Zoho Bookings changes Lead Source

                                                                                                                Hi. i would like to know if there's a way for Zoho Bookings to not change the lead source when booking a lead for an appointment as the lead source will be used in a report. Scenario: Lead source: Website after booking an appointment Lead source: Zoho Bookings Thanks. Dan
                                                                                                              • Need to set workflow or journey wait time (time delay) in minutes, not hours

                                                                                                                Minimum wait time for both Campaigns workflows and Marketing Automation journeys is one hour. I need one or the other to be set to several minutes (fraction of the hour). I tried to solve this by entering a fraction but the wait time data type is an integer
                                                                                                              • Suggestion: Associating Assets with Company in Zoho FSM

                                                                                                                Hello Team, I would like to share an idea based on practical experience. Currently, all assets in the Zoho FSM Asset module are linked to a specific contact person. I would like to know if it is possible to associate assets with a company instead. This
                                                                                                              • Zoho Inventory / Finance Suite - Extend Visibility of File Names on Attachment Fields

                                                                                                                Hi Inventory / Finance Suite team, I noticed recently that when you add an attachment field to a module in Inventory, only the first 8 characters of the file name are visible on the details view. 8 characters is not a useful amount and there is plenty
                                                                                                              • Many Notes Becoming Unusable

                                                                                                                Hello. The Notebook app is becoming unusable. I'm getting odd-looking results from my searches. Some of the notes, after clicking on them, show an update button that does absolutely nothing. Not sure what has happened, but it would be nice to get this
                                                                                                              • Kaizen #218: Actions APIs - Field Updates

                                                                                                                Hello all!! Welcome back to a fresh Kaizen week. In the previous weeks, we covered Workflow Rules APIs, Actions APIs - Email Notification APIs, and Tasks Update APIs. This week, we will continue with another Actions API - the Field Update API in Zoho
                                                                                                              • How Contract Types and Templates Form the Backbone of Zoho Contracts

                                                                                                                Every contract in Zoho Contracts starts with two essential elements: Contract Type and Template. These are not just administrative steps. They define how every contract in your organization is created, governed, and managed over time. Let us look at the
                                                                                                              • Zoho Books Finance Modules Not Accessible in Zoho CRM Mobile App

                                                                                                                We have integrated Zoho CRM with Zoho Books using the Zoho Finance Suite integration. In the CRM web version, we can see the Finance modules (Estimates/Quotes, Invoices, Sales Orders, Items, Payments) and are able to create invoices and quotes directly
                                                                                                              • CRM Related list table in Zoho analytics

                                                                                                                In Zoho Analytics, where can I view the tables created from zoho crm related lists? For example, in my Zoho CRM setup, I have added the Product module as a related list in the Lead module, and also the Lead module as a related list in the Product module.
                                                                                                              • Zoho learn Custom portal - networkurl & CustomPortalId

                                                                                                                I want to get my individual account’s networkurl and customportalId to use in this API: https://learn.zoho.com/learn/api/v1/portal/<networkurl>/customportal/<customportalId>/manual How can I retrieve the networkurl and customportalId using the API? I
                                                                                                              • Connecting zoho creator to zoho writer to send prefilled documents

                                                                                                                i will paste the worflow below // Get user's submitted data from the form userSalary = input.Current_Salary; userCIBIL = input.CIBIL_Score; userEmail = input.Email; userName = input.Name; // You need to get the Document ID from the URL of your Zoho Writer
                                                                                                              • Zoho Creator to Zoho Writer for prefilled documents...

                                                                                                                In response to the question about connecting Zoho Creator to Zoho Writer for prefilled documents, I wanted to share a working implementation that demonstrates how to use the record_id parameter with the Zoho Writer Merge API. This allows Writer to automatically
                                                                                                              • Managing functions

                                                                                                                Can someone let me know if there are any plans to improve the features for managing functions in CRM? I have lots of functions and finding them is hard. The search only works on the function name and the filter only works on function type. I have created
                                                                                                              • Introducing our latest privacy enhancement - Hiding email IDs in Zoho Cliq Networks

                                                                                                                Hello everyone, Zoho Cliq Networks offers a powerful collaboration platform that allows businesses to create dedicated digital workspaces for external vendors, partners, or individuals you want to communicate with professionally without adding them to
                                                                                                              • zoho performance

                                                                                                                OVERALL CONFIGURATION OF ZOHO PERFORMANCE Quarterly performance review Self rating and scoring Manager rating and scoring
                                                                                                              • When will it be possible to edit Subform records via either views or tabular reports?

                                                                                                                Hey there, data maintenance often requires mass update of quite a lot of records. While this is a piece of cake via either List view or Zoho sheet view, the same cannot be carried out for subform records yet. When one of the two options will be made available?
                                                                                                              • Onboarding

                                                                                                                Hello Team, Im yuktha working as HR at Ossisto Technologies. We are currently utilizing zoho for onboarding candidate. right now facing issue with onboarding Attaching the screenshots for your reference
                                                                                                              • Archiving Contacts

                                                                                                                How do I archive a list of contacts, or individual contacts?
                                                                                                              • How do I change a form's name? Why isn't this more intuitive?

                                                                                                                Can someone please let me know how to change a form's name?
                                                                                                              • Control Over Zia Generative AI Reply Assistance Behavior

                                                                                                                Hello, I would like to request an enhancement to the Zia Generative AI feature, specifically concerning the Reply Assistance within Zoho Desk. Current Issue: When replying to a ticket, the Ticket Properties section is automatically replaced by the Zia
                                                                                                              • Zia now integrated with Open AI in Zoho Desk

                                                                                                                The powerful integration of Zia with OpenAI, has empowered Zoho Desk reach a new level of efficiency and performance. With contextual self-service capabilities, Zia enables agents to boost their productivity and delivers superior customer experiences.
                                                                                                              • Zoho 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 keynote
                                                                                                              • Employee self-service portal: Onboarding and continuous learning platform for support reps

                                                                                                                Hello everyone, In any organization, employees must go through multiple courses to learn about the product, their organization's standards, and how to respond to customer queries using the knowledge base articles available. This typically requires completing
                                                                                                              • 2024 Email Authentication Standards: Elevating Security with Google and Yahoo

                                                                                                                In contemporary email communication, email authentication plays a pivotal role in mitigating email fraud, spam, and phishing attacks. Brace yourself for a new level of security. Starting February 2024, Gmail and Yahoo will be implementing robust email
                                                                                                              • Contact custom field in layout

                                                                                                                Good day, all, I have an "Extension" custom field in contacts, and would like to display the contact extension in the ticket layout, but I don't seem to be able to. What am I missing? Thanks Rudy
                                                                                                              • Exact match in name when searching workdrive

                                                                                                                Hello, I am wondering how to search workdrive files/folders with an exact match in the name. For example, when I search across folder with the url param search[name]=someName, I get multiple results such as "someName", "someNameAndMore", or "someName
                                                                                                              • Next Page