Kaizen 148 - trigger in Records APIs
Hello everyone!
Welcome to another week of Kaizen!
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
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideClient Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! CommandsExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achievedExtension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー