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 applications' APIs without exposing sensitive credentials to end users. This abstraction is both secure and makes the integration easier because it eliminates the need for developers to implement complex authorization flows manually or handle authorization tokens directly.

Bigin's Developer Console offers a feature called a connection, which acts as a bridge between your topping and the third-party application you wish to integrate with. Once a connection is configured, you can reference it in your topping's functionalities using its unique link name. This enables the topping to execute REST operations such as fetching, updating, or syncing data with the connected application securely.

Now that we've achieved a basic understanding of what a connection is and how it helps toppings interact with other applications, the next step is to understand the types of connections available in Bigin's Developer Console.

Establishing connections with services

The connections feature in Bigin's Developer Console offers two types of services to help developers configure integrations according to their requirements: default services and custom services. Default services are preconfigured services available in Bigin's Developer Console that simplify integrations with some Zoho and third-party applications. If the application you want to integrate with isn't listed in the default services, you can create a custom service and configure it according to the API specifications of the third-party application.

Default services

The connections feature offers certain default services as preconfigured options that can be easily integrated with Bigin. These services come with predefined settings such as authentication type, token endpoints, scopes, and headers, which reduces the need for manual configuration. Currently, there are around 50 default services available in the Developer Console, covering a wide range of applications and platforms. This enables developers to connect to services with minimal effort.

If the application you want to integrate with your topping isn't listed in the default services, you can create a new custom service.

Custom services

Custom services enable developers to configure all aspects of a connection manually, including the authentication type, endpoints, headers, and scopes, which enables integration with third-party applications.

When setting up a custom service, developers can specify the exact authentication flow required by the external application, whether it's basic authentication, OAuth, an API key, or another method.

Note:

Refer to the official API documentation of third-party applications when configuring these settings, as this will provide the necessary details for authentication and data access.

To create a custom service, navigate to the Connections section and choose Custom Services in the Developer Console. Based on the authentication type supported, configure the custom service for the required product.

For more details on creating and configuring custom services, please refer to this guide.

Note:

Always handle sensitive information such as client IDs, client secrets, and API keys securely, and never share them publicly. After configuring and authorizing a custom service, reference it in Deluge scripts and workflow functions by using its unique connection link name, just as you do with default services.

Next, let's look at how to implement the default service connection with an example.

Create a default service connection

Let's say you're developing a Bigin topping to synchronize contact information between Bigin and Zoho Books. This integration enables contacts created or updated in Bigin to be automatically reflected in Zoho Books. The topping uses Zoho Books APIs to create, update, and retrieve customer data using a default service connection.

To create a default service connection for the topping, choose Connections from the left panel of the Developer Console and click Get Started.

Next, navigate to My Connections or Default Services. To fetch data from the Contacts module in Bigin, create a connection first. From Default Services, select Bigin and then click Create Connection to set it up.

The system will prompt you to enter the connection details. Provide a name for the connection (for example: Bigin Connection). A connection link name is generated automatically.

Next, select the scopes required for the topping's functionality. In this use case, select ZohoBigin.modules.ALL to access data from Bigin's Contacts module.

After selecting the scope, click Create and Connect to initiate the authorization process. The system redirects you to the authorization page. Click Connect, and you'll be taken to the service's login page. Choose the Bigin organization for which the topping was created, click submit, and the connection will be created.

After establishing the connection with Bigin, you must also create a connection for Zoho Books to enable record creation. To do this, create a default service connection for Zoho Books, similar to the one created for Bigin. Select the scope ZohoBooks.fullaccess.ALL to grant complete access to modules and operations in Zoho Books.

Once you've created the connections for both Bigin and Zoho Books, the system will generate connection link names for each. These link names must be used in the business logic.

Note:

During development, authorize the connection in the Sandbox environment to test integration workflows safely.

To understand the authorization process and how to implement them, please refer to this guide on authorizing connections.

After you authorize the connection, set up a workflow rule in the Bigin Developer Console that gets triggered whenever you create or update a contact in your Bigin account. Here, we need to specify the conditions that apply to the workflow and check that the email field isn't empty.

Note:

In our use case, we'll use the email address to check whether the newly created contact in Bigin already exists as a customer in Zoho Books.

When the workflow meets the specified conditions, an instant action - in this case, a function - which will execute a custom functionality that performs the following operations:

1. Retrieves the contact details from Bigin by referencing the established connection link name biginandbooksconnection0__booksconnection.
   
2. Searches Zoho Books for an existing contact that matches the email.
   
3. If a matching contact exists, update the contact's phone and contact person details in Zoho Books.
   
4. If the script doesn't find a matching contact, it creates a new contact in Zoho Books with the relevant information.

Below is the code that automates contact synchronization between Bigin and Zoho Books:

1. //Retrieve contact details from Bigin using the established connection
2. biginContact = zoho.bigin.getRecordById("Contacts",contact.get("Contacts.ID"),Map(),"biginandbooksconnectionnew__biginconnection");
3. //Extract relevant contact data
4. biginData = biginContact.get("data");
5. contactDetails = biginData.get(0);
6. email = contactDetails.get("Email");
7. phone = contactDetails.get("Phone");
8. mobile = contactDetails.get("Mobile");
9. fullName = contactDetails.get("Full_Name");
10. //Search Zoho Books for existing contacts by email
11. searchParams = Map();
12. searchParams.put("search_text", email);
13. booksContactsResponse = invokeurl
14. [
15. url :"https://books.zoho.com/api/v3/contacts"
16. type :GET
17. parameters:searchParams
18. connection:"biginandbooksconnectionnew__booksconnection"
19. ];
    
20. info "Searched by name in Books: " + booksContactsResponse;
21. booksData = booksContactsResponse.get("contacts");
    
22. if(booksData != null && booksData.size() > 0)
23. {
24. // Extract the existingContactId
25. existingContactId = booksData.get(0).get("contact_id");
26. // Update existing contact
27. updateParams = Map();
28. updateParams.put("contact_name",fullName);
29. updateParams.put("phone",phone);
30. updateParams.put("mobile",mobile);
31. updateParams.put("email",email);
32. // Define contact person details
33. contactPerson = Map();
34. contactPerson.put("last_name",fullName);
35. contactPerson.put("mobile",mobile);
36. contactPerson.put("phone",phone);
37. contactPerson.put("email",email);
38. contactPerson.put("is_primary_contact",true);
39. contactPersonsList = List();
40. contactPersonsList.add(contactPerson);
41. updateParams.put("contact_persons",contactPersonsList);
42. //Prepare and execute update request
43. parameters_data = Map();
44. parameters_data.put("JSONString",updateParams.toString());
45. info "parameters_data value:" + parameters_data;
46. updateResponse = invokeurl
47. [
48. url :"https://books.zoho.com/api/v3/contacts/" + existingContactId + "?organization_id=XXXXXXX"
49. type :PUT
50. parameters:parameters_data
51. connection:"biginandbooksconnectionnew__booksconnection"
52. ];
53. info "Updated Contact: " + updateResponse;
54. }
55. else
56. {
57. // Create new contact
58. contactDetails = Map();
59. contactDetails.put("contact_name",fullName);
60. contactDetails.put("email",email);
61. contactDetails.put("phone",phone);
62. contactDetails.put("mobile",mobile);
63. // Define contact person details
64. contactPerson = Map();
65. contactPerson.put("last_name",fullName);
66. contactPerson.put("mobile",mobile);
67. contactPerson.put("phone",phone);
68. contactPerson.put("email",email);
69. contactPerson.put("is_primary_contact",true);
70. // Add to contact persons list
71. contactPersonsList = List();
72. contactPersonsList.add(contactPerson);
73. contactDetails.put("contact_persons",contactPersonsList);
74. // Prepare and execute the create request
75. parameters_data = Map();
76. parameters_data.put("JSONString",contactDetails.toString());
77. createResponse = invokeurl
78. [
79. url :"https://books.zoho.com/api/v3/contacts?organization_id=XXXXXXX"
80. type :POST
81. parameters:parameters_data
82. connection:"biginandbooksconnectionnew__booksconnection"
83. ];
84. info "Created Contact: " + createResponse;
85. }

For details about the API endpoints and request formats used in this code, refer to the Bigin Deluge reference library and Zoho Books contacts API documentation.

After you configure the workflow and associate the function with the instant action, test the topping in the sandbox environment.

1. To do this, click Test Your Topping in the upper-right corner of the Developer Console. This action will redirect you to the Bigin sandbox account, where you can create a new contact to test whether the functionalities work properly.
   
2. After creating a new contact in Bigin, navigate to the Customers module in the Sales section of Zoho Books. When you set up the integration correctly, you'll see the newly created contact here, which confirms that Bigin and Zoho Books are synchronizing as expected. This process provides a safe and effective way to validate the workflow before deploying the topping to a production environment.
   

In this post, we've explained that default service connections in Bigin simplify authentication and connection with third-party applications by using predefined settings such as authentication type, token endpoints, and scopes. These connections are convenient because the Developer Console pre-configures the authentication flow and endpoints of the application you're integrating with.

To sum up: Bigin's connections feature provides a flexible foundation for integrating with a wide range of external services, and using these connections, developers can extend Bigin's integration capabilities.

Stay tuned for more about developing toppings and exploring other related features available in the Bigin Developer Console.

<< Previous                                                                                                                                                      Next>>                                                                                                                                                                                                                                              

• Topic Participants

• Sabitha M

  

• Sticky Posts

• 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

• Building Toppings #2 - Learn how to use Bigin's Developer Console to build toppings

  Hey Biginners, In our last post, we discussed what toppings are, why they're essential to extending Bigin's capabilities, and how the Bigin Developer Center serves as the starting point for building them. As a cloud platform, the Developer Center empowers

• Building Toppings #1 - Serving your needs with Bigin Toppings

  Hey Biginners! We're excited to kick off our Developer Community series on building toppings for Bigin, and our goal is to provide an accessible, beginner-friendly, and relevant path for every developer. Imagine creating tiny pieces of software that unlock

• Recent Topics

• Categorize Items with Item Headers

  Hello customers, Did you ever want to classify items based on specific categories to help your customers understand your invoice better? With the new Item Header feature, you can easily categorize items in your invoices and estimates and give them a common title.  Item Headers are available in the Invoices, the Recurring Invoices and the Estimates module. It can be carried forward from estimates to invoices at the time of converting the estimates.  To add an item header: Go to the Estimates, Invoices

• Discount on the transaction level in POS

  "Is it possible to apply a discount on the total bill before tax in Zoho POS?" I want to apply a discount on the total transaction amount in Zoho POS, but the discount should be calculated before the taxes are applied. Is there an option to do this in

• Send Automated WhatsApp Messages and Leverage the Improved WhatsApp Templates

  Greetings, I hope all of you are doing well. We're excited to announce a major upgrade to Bigin's WhatsApp integration that brings more flexibility, interactivity, and automation to your customer messaging. WhatsApp message automation You can now use

• Jobs at multiple locations

  Hi A lot of times we have same job open at multiple locations. So I would like an option where we can create a job and choose multiple locations. Currently we have to create individual jobs for each location. If we can create one job and mention multiple

• Tag Adding Option in Kanban Card Customization Bigin CRM Mobile App

  I would like to request an option to add and display tags on Kanban cards in the Bigin CRM mobile app. This feature would make it easier to categorize deals and quickly identify priorities while working on the go.

• Empowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM

  Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individuals

• Associating a Candidate to a Job Listing

  Hello, I am trying to use Zoho Forms embedded on my website for candidates to apply for a job opening. I want the form then to tie directly with zoho recruit and have the candidate be automatically inputed into Recruit as well as associated with the specific

• WhatsApp Voice Message Sending Option in Bigin CRM

  I would like to request a feature that allows users to send WhatsApp voice messages directly from Bigin CRM. This would help improve communication efficiency and make it easier for teams to respond quickly to customer inquiries.

• CRM: hosting a single html file in Zoho and displaying it as a widget

  I have seen that CRM offers the option of uploading a web project to Zoho itself and displaying it as a widget in CRM. The instructions then talk about setting a development environment with Node and developing an application to upload to Zoho. But I

• How to change position button transtition of Blueprint?

  Hi Everyone, Look at my screenshoot, it is possible move the reject button to the right? I couldn't find that setting in the blueprint. Thank you.

• Multi file upload

  Hi, I just wonder if one could upload multiple files in one shot, say between one and three files, without adding multiple File Upload fields? Thanks, Alalbany

• Sorting Descending in a lookup

  I have a case number lookup on multiple forms. I need the most recent added to appear at the top of the lookup or as the list of cases grom it's too much to scroll. Is there a way to have a look up sort descending?

• Auto-upload Creator Files to WorkDrive

  Hi everyone, I’m working on a workflow that uploads files from Zoho Creator to specific subfolders in Zoho WorkDrive, as illustrated in the attached diagram. My Creator application form has two multi-file upload fields, and I want—on successful form submission—to

• Asap Widget 2.0

  Where's the documentation for the new ASAP widget? https://www.zoho.com/desk/developers/asap/#introduction this one is outdated How can we dynamically navigate between different views? How can we prefill ticket forms using ASAP 2.0?

• Can the Trigger be changed?

  I'm afraid I already know the answer, but here goes... After activating a workflow (under Campaigns > Automations), Then later choosing to Edit the workflow, Can the Workflow's Trigger be changed? Currently the entire Trigger section + options are gone

• Marketer's Space: Proven tips to improve open rates – Part I

  Hello Marketers! Welcome back to another post in Marketer's Space! In this week's post, we'll discuss the ever-important concept of open rates. This will be a multi-part series, as we have a range of topics to cover. Open rates—which measure the percentage

• Can't send nor receive emails on my external email accounts since this morning

  Greetings, I have two external accounts integrated into Zoho mail through POP3 + SMTP. These accounts have always worked normally since the day I've set them up. Starting 10:30 AM this morning (Western European Time) both suddenly stopped sending and

• Creating Custom PDF Template from Form

  I am trying to create a custom PDF from form submissions. I have the standard subscription and it indicates that PDF forms are included. I cannot find anywhere to create PDF forms. I try to follow the instructions from here: https://help.zoho.com/portal/en/kb/forms/form-settings/pdf-settings/pdf-editor/articles/creating-your-own-pdf-template#Creating_your_template_from_the_scratch

• Important Update: Facebook Metrics Deprecation & Impact on Zoho Analytics

  Dear Zoho Analytics users, Facebook has deprecated a set of metrics from the Facebook Pages Insights API, effective November 15, 2025. As a result, these changes will affect any reports and dashboards in Zoho Analytics that rely on Facebook Pages data.

• Introducing Zoho MCP for Bigin

  Hello Biginners! We're excited to introduce Zoho MCP for Bigin, a completely new way of interacting with Bigin data using AI. With Zoho MCP, you can securely connect your Bigin account with popular AI tools like Claude, Cursor, Windsurf, and VS Code,

• MCP > Creator connection failing with Claude

  I'm trying to get claude to access any of my Zoho Creator apps and it keeps failing. I have enabled all tools for creator and ensured in claude settings that everything is authorised. Here is what claude says : Unfortunately, the error messages I'm receiving

• Is it possible to sync data every 5–10 minutes in Zoho Analytics (CRM or Excel imports)?

  Hello Team, I want to know if Zoho Analytics supports near real-time syncing of data from different sources. My requirements: I am importing data from Zoho CRM → Zoho Analytics I also have some datasets maintained in Excel/CSV I want both data sources

• Feature Request: Dynamic Dimension Control for zc_LoadIn Popups

  As detailed in this community discussion, Zoho Creator's zc_LoadIn parameter is a vital tool for opening components (forms, reports, or pages) in modal dialogs via HTML snippets, Notes, or Rich Text Fields. While powerful, this feature suffers from a

• Subforms in stateless forms

  I think the title says it all. We need to be able to add subforms to stateless forms. Currently the only workaround is to create a Form and delete each record upon submission of the form. I need to build an interface to update our inventory. Basically

• Text wrap column headers in reports?

  Is it possible to auto wrap column headers so that a longer multi-word header displays as two lines when the column is narrower than the width of the header title?

• What’s New in Zoho Inventory — Latest Features, Integrations & Updates | December 2025

  Zoho Inventory has evolved significantly over the past months, bringing you smarter, faster, and more connected tools to streamline your operations. Whether you’re managing multichannel sales, complex fulfillment workflows, or fast-moving stock, our newest

• Marketer’s Space - Multi-Channel Campaigns for the Biggest Shopping Week with Zoho Marketing Automation

  Hello marketers, Welcome back to another post in Marketers Space! The biggest shopping week of the year is almost here, and it’s your moment to shine without the stress. With Black Friday and Cyber Monday just around the corner, being present across email,

• Pricing Strategies: #5 Stay local, Price & Sell Global

  Arun had always dreamed of taking his handmade craft business beyond his hometown. For years, he sold locally. Most of his customers are familiar faces, in our usual currency and with the exact expectations. But one day, a traveller visited his workshop

• No feedback from Zoho Books regarding Yodlee feeds for Investec

  I reported on 6 Feb 2025 that the Bank Feeds for Investec bank via Yodlee are not working. To date there has been no resolution. You are charging us for a suite of products where the functionality does not work. Please advise how you will refund me for

• Service One. Bill Another. Zero Hassle.

  In field service operations, one challenge often comes up: the person who needs the service isn’t always the one who pays for it. Think about tenants vs. property managers, corporate offices vs. their finance departments, or school buildings vs. central

• Presenting ABM for Zoho CRM: Expand and retain your customers with precision

  Picture this scenario: You're a growing SaaS company ready to launch a powerful business suite, and are looking to gain traction and momentum. But as a business with a tight budget, you know acquiring new customers is slow, expensive, and often delivers

• Can Zoho Flows repeat Actions more than once?

  I'm attempting to make an intentional Zoho Flow loop using the below layout. However, when "WithinLimit" condition is met, the program fails to execute the action "Get & Add Request Co..." again. Is this by design? Is Zoho Flows unable to repeat actions

• Video interviews not compatible on mobile

  Hi Zoho,  The 2-way video interview feature you have added to Recruit would be great if the candidate was able to use the link to the video on a mobile phone, it doesn't work on Samsung browser, it doesn't work on chrome/firefox mobile version of browser,

• Zoho Desk View Open Tickets and Open Shared Tickets

  Hi, I would like to create a custom view so that an agent can view all the open tickets he has access to, including the shared tickets created by a different department. Currently my team has to swich between two views (Open Tickets and Shared Open Tickets).

• Enviro Recycling EHF Fee's

  ​​I'm in Canada and each province has it's own recycling program with it's own fee's. There are numerous categories that electronics fall into and each category has a taxable rate applied to it. I need a way to be able to apply the correct rate depending

• Zoho Desk API - Influence which layout is used

  Hello, how can the ticket layout be changed using the API? I would like to choose the layout directly when creating the ticket. If this is not possible, my question would be how can I change it afterwards? Best regards, Sven

• Has CSS Changed for Common Elements?

  I noticed today that the standard title headings on my Forms and Reports display smaller in size than before. Google Dev Tools (attached), seems to confirm my suspicion. Something appears to be overriding the 1.375rem to 1.125rem. The font size on the

• Text field alignment

  Is it possible to align text in the text field? Or even better, is there a possibility to have a field which accepts only numbers?

• email moderation issue when email is sent in the name of a mail group

  Symptom: an email that is sent by a mail group moderator in the name of a moderated mail group is held back for approval. Reproduction: Create a moderated mail group with members and moderators. Allow that mails can be sent in the name of the group (extended

• Pipeline in Custom Modules

  I love the way the Sales Pipeline looks and functions with reports. I would like to add the save pipeline features and visualization to a custom module, however, I only see that these pipelines are only available for the Deals module. Is there a way to add pipelines to custom modules?

• Next Page