Integrating Custom Zia Agents with Bigin
Hello Biginners!
With the introduction of Zoho's Zia Agents, automation in Bigin has moved beyond predefined rules into something much more dynamic and intelligent. Instead of building rigid workflows, you can now create custom Zia Agents that understand context, process instructions, and perform actions across your applications.
Using Agent Studio, you can construct these custom Zia agents to handle specific business needs such as responding to leads, updating CRM records, or executing communication workflows on behalf of Bigin users.
What You'll Learn in This Post
In this post, we'll cover:
- Real-world scenario
- Deploying a custom Zia Agent
- Understanding the Agent API
- Triggering the agent using Zoho Flow
- Setting up required connections in Flow
- Implementing a custom function for Agent API
- Understanding the function workflow
- Integrating Bigin with the agent via Flow
- Testing the integration flow
How the Custom Zia Agent Integration Works
Before we begin, here’s a simple flow diagram showing how a custom Zia Agent connects with Bigin through Zoho Flow to automatically handle new contacts and send personalized welcome emails.
Real-world Scenario
To understand how this works in implementation, let's consider a common use case in Bigin:
Let's say you use Agent Studio to build a custom Zia Agent called Auto-Reply Agent for Leads. This agent is set up to generate and send a personalized email automatically whenever a new lead (contact) is created.
For detailed instructions on how to create and configure agents, refer to the Creating Agents guide.
In most sales workflows, when a new contact is created, the next step is to acknowledge the lead with a quick response—something that's often done manually or through predefined workflows using generic email messages.
With Auto-Reply Agent for Leads, we can now take this a step further by integrating it with Bigin so that the entire process happens automatically with personalized email messages.
Now that the Auto-Reply Agent is ready, the next step is to deploy the agent and make it available for integration.
Watch the Integration in Action
Before we begin the implementation, here's a quick demo of the complete configuration in action. It covers from deploying a custom Zia agent to generating and sending a personalized welcome email.
Deploying a Custom Zia Agent
Zia's Agent Studio provides two ways to deploy a Zia Agent, depending on how you want to use it. One way is to deploy it as a digital employee, which allows the agent to act as in-app assistant within Zoho apps. The other way is to deploy it as a connection, where the agent is exposed via an API endpoint.
In this scenario, we deploy the agent as a connection because we want it to be triggered automatically whenever a new contact is created in Bigin. By deploying it as a connection, we can use the agent's API and integrate it with Zoho Flow to handle the automation seamlessly.
To deploy the agent, navigate to the Deploy dropdown button in Zia's Agent Studio configuration page and select Deploy using connection.
In the Tools Param Mapping sliding panel, review the configured parameters. Modify these settings if required, and then click Next to proceed.
Next, choose an existing connection from the dropdown or click New to create a new connection for the required service.
Follow the prompts to authorize the connection. Once completed, the agent will be successfully deployed and ready to be triggered via its API.
Understanding the Agent API
Let's now review the Agent API details by navigating to Integrate > Agent API. These details are essential for integrating the agent with your automation.
The deployed agent exposes an Agent API endpoint that allows you to send instructions along with contextual data.
Endpoint:
- https://agents.zoho.com/ziaagents/api/v1/agents/3989000000030001/trigger
Method: POST
Authentication: OAuth
Headers:
- {"X-ZIAAGENTS-ORG": "903723720","X-ZIAAGENTS-AGENT-SESSION-ID": "","Authorization": "Zoho-oauthtoken <token>"}
Request body:
- {"query": "","reasoning": false,"attachments": [""],"systemArgs": {}}
At a higher level, this API works like this:
- We send a prompt as a query, which tells the agent what to do.
- We pass the contact ID through systemArgs, so the agent can fetch full details from Bigin.
- The agent processes the request and performs the action.
In our use case, the action is generating and sending a personalized welcome email.
To ensure the request is routed correctly and securely, the Agent API provides the following headers:
- X-ZIAAGENTS-ORG - Identifies the Zia Agent Organization.
- X-ZIAAGENTS-AGENT-SESSION-ID - Helps track execution sessions.
- Authorization - Provides OAuth token for secure access.
Optionally, we can also use X-ZIAAGENTS-AGENT-ID to specify which agent to trigger.
Triggering the agent using Zoho Flow
Now that the agent is deployed, the next step is to trigger it automatically whenever a new contact is created in Bigin.
To achieve this, we use Zoho Flow to build the automation.
Setting up the connections
Before building the flow, we need to configure the required connections to ensure that data can be fetched from Bigin and the Zia Agent can be triggered securely.
The Bigin connection is used to fetch details of the newly created contact. Since Bigin is available as a default server in Zoho Flow, this connection can be created directly while configuring the trigger.
To set up a Bigin connection, go to Settings > Connections in Zoho Flow. Click on Create Connection, then select Bigin from the list. Provide a name of your choice for the connection and click Authorize to complete the setup.
Ensure the connection has the Contact Created trigger access while authorizing the connection:
This allows the flow to access contact data and pass it to the custom function.
The Zia Agent is not available as a default service in Zoho Flow, so we must create a custom connection using an Auth Profile.
This connection is used to authenticate and trigger the agent via its API.
To configure this, we create an OAuth2-based Auth Profile using client credentials obtained from the Zoho API console.
First, navigate to the Zoho API Console and register a server-side application. While registering, use the redirect URI:
https://flow.zoho.com/oAuth/callback
Once the client is created, you'll receive the Client ID and Client Secret, which are required to set up the Auth Profile in Zoho Flow.
In Zoho Flow, go to Settings > Auth Profiles and click Create to add a new authentication profile. Choose OAuth v2 as the authentication method, then enter a name of your choice for the auth profile.
Once done, do the following:
- Provide the Client ID and Client Secret from the Zoho API Console.
- Provide the Authorization URL, Access Token URL, and Refresh Token URL. For details, refer to the Zoho Accounts API documentation.
- Set the scope as: ZiaAgents.agents.TRIGGER.
Using OAuth ensures that the connection remains active and secure, without relying on access tokens that expire frequently.
This Auth Profile is then used to create the Zia Agent connection.
Once the connection is created, it's used in the custom function during the API call:
- connection:"ziaagentconnection"
This allows the function to invoke the Zia Agent API securely.
Implementing the custom function
In Zoho Flow, navigate to Settings > Custom Functions and click Create Custom Function.
Provide a function name and set the return type as void, since this function is only used to trigger the agent. Add an input parameter named id with the type string, which represents the contact ID from Bigin.
Once created, the Deluge editor will open where you can define the function logic as shown below:
- void trigger_lead_auto_reply(string id){// Instruct the agent to fetch contact and send welcome emailquery = "New lead added. Send a short, friendly welcome email to the newly created contact based on auto-reply-agent-skill instructions.";// Build request bodybody = Map();body.put("query",query);body.put("reasoning",false);body.put("attachments",List());// Pass the contact ID nested under the tool name — required for agent to extract itrecordInfo = Map();recordInfo.put("id",id);sysArgs = Map();sysArgs.put("ContactId",recordInfo);body.put("systemArgs",sysArgs);// Headersheaders = Map();headers.put("X-ZIAAGENTS-ORG","111860686");headers.put("X-ZIAAGENTS-AGENT-ID","2307000000029001");headers.put("X-ZIAAGENTS-AGENT-SESSION-ID","10000");headers.put("Content-Type","application/json");// Trigger the agent — fire and forget, no return neededresponse = invokeurl[url :"https://agents.zoho.com/ziaagents/api/v1/agents/2307000000029001/trigger"type :POSTbody:body.toString()headers:headersconnection:"ziaagentconnection1"];info response;}
How this custom function works
This function acts as the bridge between Bigin and the Zia Agent API, constructs the API request, sends it to the agent, and triggers the required action.
Let's understand how it works step by step.
A. Defining the instruction (query)
- query = "New lead added. Send a short, friendly welcome email ..."
This is the instruction sent to the agent. It tells the agent what action needs to be performed and how the response should be generated.
B. Building the request body
- body = Map();body.put("query",query);body.put("reasoning",false);body.put("attachments",List())
Here we construct the request body based on the Agent API format:
- query: defines the task
- reasoning: disabled to keep the response concise
- attachments: not used in this scenario
C. Passing contact context using systemArgs
- recordInfo = Map();recordInfo.put("id",id);sysArgs = Map();sysArgs.put("ContactId",recordInfo);body.put("systemArgs",sysArgs)
Instead of passing all contact details, we pass only the contact ID.
The agent uses this ID to fetch complete contact information from Bigin. This ensures that the agent works with latest data without increasing the request payload.
D. Setting headers
- headers = Map();headers.put("X-ZIAAGENTS-ORG","111860686");headers.put("X-ZIAAGENTS-AGENT-ID","2307000000029001");headers.put("X-ZIAAGENTS-AGENT-SESSION-ID","10000");headers.put("Content-Type","application/json");
These headers help identify the organization and the specific agent being triggered.
X-ZIAAGENTS-AGENT-ID is the agent's unique identifier. You can find it on the agent's overview page in Agent Studio.
X-ZIAAGENTS-AGENT-SESSION-ID is the session ID, which you can define per your preference.
Authentication is handled through the configured connection in the function.
E. Triggering the Agent API
response = invokeurl
- [url :"https://agents.zoho.com/ziaagents/api/v1/agents/2307000000029001/trigger"type :POSTbody:body.toString()headers:headersconnection:"ziaagentconnection1"];
This is where the API call is made.
At this stage:
- The request is sent to the Zia Agent.
- The agent processes the query.
- It fetches the contact details using the provided ID.
- It generates and sends the personalized welcome email.
Integrating Bigin with Custom Function
Once the connections and custom function is set up, the next step is to configure the flow.
Create a new flow in Zoho Flow and define the following:
- Trigger: Select Bigin and choose the event Contact Created.
- Action: Add the Custom Function created earlier.
Map the required input parameter:
- Pass the Contact ID from the Bigin trigger to the function input parameter id.
This ensures that wherever a new contact is created in Bigin, the flow is triggered and the contact ID is passed to the custom function, which in turn invokes the Zia Agent.
Testing the Flow
After configuring the flow, it's important to test the setup to ensure everything works as expected.
Create a test contact in Bigin and verify the following:
- The flow is triggered successfully.
- The custom function is executed.
- The Zia Agent is invoked.
- A welcome email is generated and sent to the contact.
Once verified, the flow can be enabled for real-time execution.
In this post, we explored how to deploy and integrate a custom Zia Agent with Bigin using Zoho Flow.
This approach enables you to move beyond predefined workflows and build intelligent, automated communication systems using Zia Agents.
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
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?
Topic Participants
Aravind Kumar V
Sticky Posts
Building Toppings #7 - Using schedules and workflow functions
Hello Biginners, In our previous forum post, we explored install and uninstall actions and learned how to trigger custom logic the moment a topping is added or removed from an organization. In this post, we'll look at how to automate actions during regular,Building Toppings #6 - Install and uninstall actions
Hello Biginners! In our previous forum post, we explored creating connections - specifically, custom service connections in the Bigin Developer Console. In this post, we'll focus on another feature that can be used in every topping: install actions. We'llBuilding Toppings #5 - Creating and configuring custom service connections in Bigin Toppings
Hello Biginners, Integrating Bigin with external applications extends its capabilities and enables customized functionalities. In our last post, we saw how to create a default service connection. Today, we'll see how to create a custom service connectionBuilding Toppings #4 - Setting up and using connections in Bigin toppings
When building a topping to extend Bigin's functionality and connect it with third-party applications, creating and handling connections is an important step. Connections provide a secure way for your topping to authenticate and communicate with otherBuilding Toppings #3 -Testing and publishing Bigin toppings
Hey Biginners! In previous forum posts, we discussed what a Bigin topping is and explored the Bigin Developer Console's features. In this post, we're going to create a topping from scratch and discuss how to test and publish it. Our topping will automate
New to Zoho TeamInbox?
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
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セミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
How to Switch from Outlook for Mac to Outlook for Windows
The most often used file formats for users to manage crucial data are OLM and PST files. PST files keep a copy of data on the configured system from Outlook, while the OLM file contains the Mac Outlook data items, which are only accessible with OutlookDifferent languages for users
Hello, Do you plan to enable individual users to select their languages for interface? Currently language can be changed for everyone - it looks like a settings for a whole portal, which is not good when you are working internationally. Best regards,Issues migrating Google email
I am considering Zoho because Google will start charging for G Suite legacy free edition. So, a key element in my decision is the ability to migrate as much from Google as possible. I am giving email a try first, but after hours of trying, I can't"Print" option of GET Expense Report API not working
Hello! I have been trying to use the "print" option of the GET Expense Report API but it seems the option does not alter the output. Is there an issue with the API or am I using it wrong? Here's my request code, in Deluge: response = invokeurl [ url :"https://www.zohoapis.com/expense/v1/expensereports/"Related List Expanded View in Zoho CRM: see more related records at a glance, filter and take bulk actions
Hello everyone! Related lists show you the records connected to what you're working on: contacts under an account, activities tied to a deal, products linked to a quote. But until now, you could only see 10 records at a time. If you needed to filter resultsAdd Comprehensive Accessibility Features to Zoho Writer
Hello Zoho Writer Team, We hope you are doing well. We would like to submit a feature request to enhance Zoho Writer with a full set of accessibility tools, similar to the accessibility options already available in the Zoho Desk agent interface. 🚧 CurrentHow to automatically update a % field according to a dropdown field in the Quote table
Hello there, I have following couples: Success % Status 0% NP 30% No Feedback 50% PR 80% Opp. Concreta 100% A I would like the Success % field (percent) to automatically update based on the item of the Status field (dropdown). The fields are within theCRM iOS App Missing Tags support
Hi, I remember reading either a tread on iOS (Maybe Later) & Android (i believe Now Supported) regarding “Tags” in the mobile apps unfortunately I can’t seem to find either. Could we clarify are “Tags” support coming to CRM iOS app as searching the forumsMarketing Tip #41: Add a clear value proposition to your homepage
When someone lands on your homepage, they should understand what you sell and why it is worth exploring within 5 seconds. If your homepage is too vague, cluttered, or focused only on design, visitors may leave before they even start browsing. A strongZoho Writer adds conditional logic and AI assistance to formulas: A step toward dynamic document automation
Hi users, We are excited to announce new formula enhancements in Zoho Writer. This includes: New string formulas: Use 12 new string functions to dynamically transform and manipulate text in documents and automation templates. Conditional formulas: ConfigureWhat's New in Zoho Billing | June 2026
Hello users! June brings a new set of updates to Zoho Billing designed to strengthen how you manage subscriptions, customise your records, and handle expense documentation. This month's highlights include a new one-time addon quoting workflow for subscriptions,What's New in Zoho Inventory | June 2026
Hello partners, June 2026 introduces a range of exciting enhancements to Zoho Inventory. With the full rollout of the Zoho Inventory Windows application, the launch of Terminal Payments, and new tracking combinations in Advanced Inventory Tracking, you[Zoho Writer webinar] Driving productivity through document automation
Live webinar on July 9, 2026 | Time: 2 PM IST | 2 PM EST Hi Zoho Writer users, Creating, reviewing, approving, and distributing business documents manually can slow teams down and introduce errors. Join our live webinar to learn how Zoho Writer helpsFree Webinar Alert! Zoho Workplace + Zoho Billing: Align Rev-ops and collaboration for greater efficiency
Hello Zoho Community! Want to make your billing process more connected and efficient? Join our upcoming webinar to see how Zoho Workplace and Zoho Billing work together to streamline your day-to-day operations. In this session, we'll show you how to manageCanvas View: Add font family selection (incl. Google Fonts / Hebrew & RTL fonts)
Hi Zoho CRM team, The Canvas design suite (List View, Tile View, Table View and Record Detail) currently allows customizing font weight, size, color, alignment and case - but there is no option to choose the font family. All text is rendered in the built-in【無料／オンライン】7/22開催｜Zoho ワークアウト｜ユーザー同士で学び合うオンラインもくもく会
ユーザーの皆さま、こんにちは。 コミュニティグループの中野です。 7月開催の「Zoho ワークアウト」のご案内です。 本イベントは、Zohoユーザー同士で交流しながら、 設定・検証・運用改善を進めるオンラインの「もくもく会」です。 「設定を進めたいけれど、一人だと手が止まってしまう」 「他社がどう活用しているのか知りたい」 「同じ課題を抱える仲間と話したい」 そんな方にぴったりのイベントです。 ▶︎ 参加登録はこちら（無料 ） URL：https://us02web.zoom.us/meeting/register/t7lA28wlQceRW6sZpeFEhQDYK 9: Dependent Layout Rules
Did you know that you can configure dependent fields in Task and Issue Layouts? In a project, tasks and issues vary in nature and so do the fields needed for each. Displaying relevant fields and values keeps the layout organised and ensures necessaryDoes anyone else wish you could download Mail Merge quotations from the Zoho CRM mobile app?
Is it just me, or has anyone else run into this? I’m in sales, so I’m rarely at my desk. I’m usually in meetings, visiting clients, or travelling. One thing that genuinely frustrates me is that if a client asks me for a quotation, I can’t generate orIntroducing parent-child ticketing in Zoho Desk [Early access]
Hello Zoho Desk users! We have introduced the parent-child ticketing system to help customer service teams ensure efficient resolution of issues involving multiple, related tickets. You can now combine repetitive and interconnected tickets into parent-childUpdate on default settings for AI features in Cliq
Hello all, We'd like to provide clarity on a recent change to AI feature defaults in Cliq. As part of our regular review of AI features conducted in April 2026, we re-evaluated how these features are enabled by default. We've decided that the AI featuresText on Zoho Sign confirmation dialouge is very small compared to text used everywhere else on Zoho Sign.
I've reported multiple times through Zoho's support email that the text on this notification is very small in contrast to all the other text on the Zoho Sign app. I think it's a bug and it just needs the font size to be increased. It's very minor butCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsZoho CRM custom button function, how to add line breaks/ new lines in the return message
When creating button function in CRM it requires a `return "";` Then when the button is client by the user a message pops up with what ever is returned from the function. But I want to have a message with multiple lines, meaning I need to add a line breakFeature Request: Dynamic Date Filter Criteria
Please implement the ability to select a dynamic date for all Filter Criteria. This would be helpful to create views that don't constantly need to be updated (example custom date field on an account) Examples: - Today - Tomorrow - This week - This MonthSalesIQ's Summer '26 Release: For The Moments That Matter
Every customer journey is made up of moments. The moment someone discovers your business. The moment they need help. The moment you decide to reach out. The moment a simple chat turns into something more. And the moments that continue long after the conversationThere is no link between Deals and Projects in Analytics
Hello there, I am trying to link Deals with Projects in a Pivot view on Zoho Analytics. However, there is no relationship, yet on CRM there is a relationship. As you can see below, there is no link between them: However, on CRM, if you go into a Deal,How to Access Zoho Mail Messages to Microsoft Outlook? - Zoho Mail Converter
Zoho Mail is the free email hosting service which provide mailing with CRM service, so if you are one of them who is trying to import Zoho Mail emails to Outlook then keep reading. In this article we are going to provide accurate solution that will help you to import Zoho Mail emails to Outlook format in Batch. Zoho Mail service provide option to export mailbox in Zip format. So first – Export Zoho Mail emails in Zip format later use Zoho Mail to Outlook Converter to migrate Zoho emails into PSTZoho Cliq REST APIs v3 : A complete guide to what's changed and why
APIs are not just consumed by a developer with numerous automations and a series of open browser tabs. They are parsed by LLMs, fed into agent pipelines, and auto-completed by AI coding assistants that have zero tolerance for inconsistency. A verb tuckedFeature Request: Include Creator-applicable Deluge updates in the Creator Release Notes
I'd like to put forward a suggestion about how Deluge updates are surfaced to Zoho Creator developers, and I'm hoping the Creator team will consider it. Zoho Creator is built on Deluge. Every workflow, custom function, validation and schedule we writeZoho CRM Reports Module on Mobil App
I have the mobile app and the reports module doesn't appear in the sidebar for some reason. I saw a Youtube video where the user had the Reports module on mobile. Is there a setting to show it on mobile? Thanks.Sigma function call hangs forever from Desk widget — app_install_id/encapiKey are null
Calling ZOHODESK.request() from the widget to invoke a Sigma DRE function URL hangs forever (never resolves, never rejects, no error) until client timeout. Tried with merge fields app_install_id={{sigmaInstallId}}/{{installationId}} and encapiKey={{enCapApiKey}}Workdrive on Android - Gallery Photo Backups
Hello, Is there any way of backing up the photos on my android phone directly to a specific folder on Workdrive? Assuming i have the workdrive app installed on the phone in question. EmmaAuto sync Photo storage
Hello I am new to Zoho Workdrive and was wondering if the is a way of automatically syncing photos on my Android phone to my workdrive as want to move away from Google? ThanksPostcode problems
So we were very pleased to see we could limit shipping with postcodes. Brilliant. Unfortunately we have discovered It does not seem fit for purpose. In the UK we write postcodes in various ways Examples BH217NL BH21 7NL Bh217nl bh217NL and many more waysGetting Notifications but unable to load email
I am getting notifications through the web browser and my phone app that i am receiving emails, but i can not open the email to view. Below is the screen shot of the console panel.WORKFLOW ISSUE: Zoho Finance Extension
Workflows are no longer triggering in my extension. This is true for the testing environment and 5 other organizations it is installed on. There are no conditions set for the workflow, and this is true for both create and delete related actions. WorkflowsZoho CRM Layout Rules: Nine New Actions, Profile-Based Execution, and Interactive Preview
Hello everyone, Availability: This feature is now available for customers in the JP and SA DCs. It is planned to be released for other customers in soon. We’re excited to announce powerful new enhancements to Layout Rules in Zoho CRM - a feature builtCertain items certain shipping
Me again it would be helpful to have different shipping for different categories. Our example are salt. Delivery is free but have a minimum delivery. Pickup is cheaper so it has its own category- pickup.Zia Agents looks promising, but I still cannot deploy my first agent or connect WhatsApp after weeks of support tickets
Hi Everyone, I am posting here because I am stuck and need practical help from someone who has successfully deployed a Zia Agent with WhatsApp. Zia Agents looks like a very promising product. I have watched the platform expand quickly, and I have noticedHandling Hard Bounce Contacts with Active Phone-Based Users (WhatsApp Use Case)
In Zoho Marketing Automation, when a contact is marked as “Hard Bounce”, we noticed that the contact stops receiving updates from CRM fields and may be excluded from automations. Is this expected behavior? In our case, the primary identifier and verifiedNext Page