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:

1. Real-world scenario
   
2. Deploying a custom Zia Agent
   
3. Understanding the Agent API
   
4. Triggering the agent using Zoho Flow
   
5. Setting up required connections in Flow
   
6. Implementing a custom function for Agent API
   
7. Understanding the function workflow
   
8. Integrating Bigin with the agent via Flow
   
9. 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:

1. We send a prompt as a query, which tells the agent what to do.
   
2. We pass the contact ID through systemArgs, so the agent can fetch full details from Bigin.
   
3. 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:

1. X-ZIAAGENTS-ORG - Identifies the Zia Agent Organization.
   
2. X-ZIAAGENTS-AGENT-SESSION-ID - Helps track execution sessions.
   
3. 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:

1. Provide the Client ID and Client Secret from the Zoho API Console.
   
2. Provide the Authorization URL, Access Token URL, and Refresh Token URL. For details, refer to the Zoho Accounts API documentation.
   
3. 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 email
  
        query = "New lead added. Send a short, friendly welcome email to the newly created contact based on auto-reply-agent-skill instructions.";
  
  
        // Build request body
  
        body = 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 it
  
        recordInfo = Map();
  
        recordInfo.put("id",id);
  
        sysArgs = Map();
  
        sysArgs.put("ContactId",recordInfo);
  
        body.put("systemArgs",sysArgs);
  
  
  
        // 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");
  
        
  
        // Trigger the agent — fire and forget, no return needed
  
        response = invokeurl
  
        [
  
              url :"https://agents.zoho.com/ziaagents/api/v1/agents/2307000000029001/trigger"
  
              type :POST
  
              body:body.toString()
  
              headers:headers
  
              connection:"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:

1. query: defines the task
   
2. reasoning: disabled to keep the response concise
   
3. 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 :POST
  
        body:body.toString()
  
        headers:headers
  
        connection:"ziaagentconnection1"
  
  ];

This is where the API call is made.

At this stage:

1. The request is sent to the Zia Agent.
   
2. The agent processes the query.
   
3. It fetches the contact details using the provided ID.
   
4. 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:

1. Trigger: Select Bigin and choose the event Contact Created.
   
2. Action: Add the Custom Function created earlier.
   

Map the required input parameter:

1. 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:

1. The flow is triggered successfully.
   
2. The custom function is executed.
   
3. The Zia Agent is invoked.
   
4. 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.

• 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'll

• Building 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 connection

• Building 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 other

• Building 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

• Recent Topics

• Has anyone successfully gotten conditional rendering to work in Zoho Books Sales Order HTML PDF templates?

  I’m trying to hide a custom field box when the custom field is blank. The value placeholder itself works perfectly: ${salesorder.cf_distribution_reference_numb} If the Sales Order has a value, it renders correctly. Example: 45488045. But when I wrap that

• How To Invoice Immediately for Future Subscription

  Hi, When a new subscription is created that has a future start date, Zoho Subscriptions does not invoice the customer until the start date of the subscription. Is there a way to immediately invoice the customer as soon as the subscription is created,

• Deleted User Emails

  I need to delete a user as I need to re-use their license, but I'd like to keep all their emails that are attached to various contacts in the CRM. Their emails are hosted externally on an M365 license. Anyone any idea how best to engineer this? TIA

• In wiki editor, dragging an image fails

  Expected behavior: Within the WYSIWYG editor, we have been able to select and drag an image (that is already inserted in the page) to move it to a different position on the page. Current behavior: For a few days recently (possibly longer and I didn't

• Not able to see appointements when the territory permission is activated

  Hello, I created different territories to separate the various departments within the company that will be working on different projects. The issue I am currently experiencing is that when I enable territory-based permissions, I can see the work order

• Print multiple uploaded images in an HTML snippet in a Page

  I have a Form: Job_Preparation It stores details of each new item that must be built by the fabricators in our workshop. The form has a field: Documents I upload 4 image files to the Documents field. I want to print a sheet for our workshop staff with

• Quotes Module - import data

  Hello Zoho, is it possible to import Quotes records? I was trying and i have no results. Raport shows no data imported. Could you help me please how to do it?

• Introducing the new Zoho Announcements Hub

  Hello, Enterprise Support Community! We are excited to announce a new way to keep up to date with recent product releases and announcements for the Zoho apps you use on a regular basis. Introducing our new centralized location to bring together all Zoho

• Introducing Custom Columns in Forecasts in Zoho CRM

  Hello all, Forecasts in Zoho CRM help sales representatives, managers, and business stakeholders evaluate performance and plan future sales activities. While standard metrics such as Target, Achieved Amount, and Pipeline Amount provide a baseline view,

• Can Zoho CRM Emails be used in Zoho Analytics in any capacity?

  We're wanting to display details about Lead Activity in regular reports through Zoho Analytics but we're having difficulty integrating Emails at all. We'd like to be able to note when an email is received and when it is sent somewhere other than just

• Related list view for Assets

  We first set up all our parent assets in FSM and now we are adding child assets which are the parts for the parent assets. When under the customer related list, since it only displays 5 rows of data, I have to click through many assets to locate the parent

• Zoho Books - France

  L’équipe de Zoho France reçoit régulièrement des questions sur la conformité de ses applications de finances (Zoho Books/ Zoho Invoice) pour le marché français. Voici quelques points pour clarifier la question : Zoho Books est un logiciel de comptabilité

• Smart URL Determination

  I would like to see Vault implement some sort of "smart" URL determination. When one starts to add a new username-password combination from a new site, Vault brings in the exact URL of the page from which this is happening. All too often, it looks something

• Project Statuses

  Hi All, We have projects that sometimes may not make it through to completion. As such, they were being marked as "Cancelled". I noticed that these projects still show as "Active" though which seems counter intuitive. In fact, the only way I can get them

• Composite Services and Account Tracking

  I am looking to garner support/request the ability to make composite services. A quick search in the forums brings up multiple requests for this feature. I fail to see why an item is mandatory while services are optional. I also would like to see the

• Marketer's Space: Lists vs. segments—what's the difference?

  Hello Marketers, Welcome back to another post in Marketer's Space! In email marketing, reaching the right audience is just as important as crafting the right message. Yet many marketers often confuse lists and segments, using them interchangeably without

• Building a Multi-Step Form Experience in Zoho Creator Using Standard Forms

  Zoho Creator does not currently provide native multi-step form functionality. For applications with a large number of fields, a common requirement is to split data collection into manageable sections while maintaining a single application record. In this

• Implementing Back Button Navigation in Zoho Creator

  Zoho Creator does not currently support a native Back button within forms, so implementing backward navigation requires a workaround. We recently implemented this in an application that was split into 9 modular forms. Since users needed to move between

• Add Video link to interview record

  Hi Team, we are having team members consistently go to the interview record to find the link for their upcoming meeting and have been confused that they have not been able to find them. When the interview is created can you please upload the link to the

• Zoho projects dependancies is a joke

  About to cancel our Zoho One subscription because Zoho Projects is a mess. Can't build a proper progream in it because the dependancies doesn't work properly. Can't believe this software is promoter as a project program when one can't even build a proper

• Vorrei disdire l'abbonamento

  Vorrei disdire l'abbonamento, ma non trovo il modo. Mi assistete?

• Wiki Add Attachment upload fails at about 15.3 MB

  I am seeing consistent "Error in uploading file" for files larger than about 15,430 kB. For 15,300 kB or smaller, no problem, but 15,430 kB or larger always fail. This is over numerous trials. My test files, to examine this problem, were generated by

• Stop Wasting Clicks: Let Us See All Notes in Quick View

  Hi Zoho Recruit team, I would like to suggest an improvement to the candidate/application experience in Zoho Recruit. Today, it is difficult to get a full picture of a candidate when working from the Quick View, since notes are split between: Notes related

• Zoho Books | Product updates | June 2026

  Hello users, Welcome to this month's roundup of what's new in Zoho Books! We have an exciting line-up this time. The highlight is the launch of the all-new France Edition with full ISCA compliance. We're also introducing features such as Layout Rules

• issue invoice for future subscription

  Hi, I selected the invoice at the date of subscription from the setting (since the alternative is to pre-set a date of a month) which is not my case. So, my question : Some times I need to create a subscription that will start at a future date but I need

• Associate emails from both primary and secondary contacts to deal

  We need to associate emails from multiple contacts to a deal. Please advise how this can be achieved. At present, only emails from primary contacts can be associated. Thanks

• How to set default reply email address depending on receipt email address

  Hi, I have a number of different customer support email addresses (info@XYZ.com, retuns@XYZ.com etc.) and want to set Zoho Desk so that the email address from which an agent replies is automatically defaulted to a predetermined address depending to which

• What's New in Zoho Inventory | April & May 2026

  Hello users, We're excited to roll out the latest Zoho Inventory updates for April and May 2026. These enhancements are designed to make your daily operations smoother and more efficient, from advanced inventory management and flexible pricing to automated

• Writer is horrible

  Form filling is about unusable for complex forms! I am so tired of it.

• How to Migrate from MDaemon to Zoho Mail Account?

  Hi there, Zoho Mail is one of the most popular as well as leading competitor for several cloud email service providers. It is It provide cloud email service as well as desktop based email client. In recent years people are migrating from third party cloud servers to Zoho Mail. The reasons are plenty, i.e. the user interface, security, high performance and many countless amazing features. On the other hand MDaemon Mail (aka WorldClient) is also popular among cloud email servers. But there are some

• Trigger workflows from SLA escalations in Zoho Desk?

  Hey everyone, I’m currently working with SLA escalation rules in Zoho Desk and ran into a limitation that I’m hoping someone here has solved more elegantly. As far as I can tell, SLA escalations only support fairly limited actions (like changing the ticket

• CRM Portal Lookup Linkage and Related Fields

  hi, if someone can give me the right path, would be greatly appreciated. we want to do a customer portal for our partners who we issue work orders for our customers, the linkage via lookup fields Partner -> Work Order -> Customer in our portal, the primary

• HOW TO: Searching a thread (email body/text) with a custom function, allowing filtering and specific actions

  We are still trialing out Zoho at this time, but have found a major expected feature to be missing - the ability to search within the text of an email for automation/workflows. NOTE: You need to create a connection for zohodesk under settings -> Developer

• Cold emails not allowed?

  I planned to use Zoho Mail to send businesses some cold emails to offer my freelance writing services, but I noticed that the anti-spam policy is very strict -- no commercial emails whatsoever without prior permission from the recipient? I would be very

• Zoho Team Inbox - roadmap

  Hi, would be good to understand the Teaminbox roadmap, in particular: 1. API / Zoho Deluge connections. We have a process where the each email needs to be either tagged or assigned daily. It would be great if we could automate a 5pm alert for any exemptions

• Leave Time - Past Dates by Pay Period

  Under Settings | Leave Policy | [policy name] | Restrictions, one can set a number of days that an employee can go back to apply leave. This is very good and very needed. However, in most organizations, the real deadline isn't X number of days from the

• Link webform to a job opening

  I have a webfrm embeded on my website and everytime a candidates fill the form, their candidate status is to new. Is it possible that it links to a specific job opening instead of me having to assing it manually ? Thanks

• New in WorkDrive: Organize your storage using Data Templates

  Organizations generate huge volumes of data day in and out. From financial reports, client details, and resumes to promotional images, product videos, and more. The list is endless. When you have so much data to manage, you need to classify your documents and structure them in a way that makes them more accessible.  This is exactly what WorkDrive's Data Templates lets you do! You can create Data Templates, add meta data as custom fields, and associate those fields with files and folders based on

• Need Native Support for docx files in Zoho Writer

  Absolutely love Zoho Writer, but often need to share files by email with people who are in the Office ecosystem. Downloading a file as docx, then sending it by email, getting the comments back, converting it to Zoho format, editing it, then converting

• Mirror Component in Zoho CRM: Access real-time related data without leaving your record

  Hi everyone, This feature is now available for the JP, CA, SA, UAE, and AU DCs. We're excited to bring to you Zoho CRM's mirror component, which presents relevant data on a record's details page and keeps everything users need in one place without having

• Next Page