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 #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

• 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

• Recent Topics

• How can I setup Zoho MCP with Chat GPT

  I can set up custom connections with Chat GPT but I cat an error when I try to set it up. The error is: "This MCP server can't be used by ChatGPT to search information because it doesn't implement our specification: search action not found" Thoughts?

• API ZOHO CRM Picket list with wrong values

  I am using Zoho API v.8. with python to create records in a custom module named "Veranstaltung" in this custom module I've got a picket list called "Email_Template" with 28 Values. I've added 8 new values yesterday, but if I try to use on of those values

• Group Emails

  I have synced Zoho CRM to Campaigns but there are certain email not synced. showing it is Group Emails, but this email ids belongs to different individuals. please provide a solution as i nedd to sync the same.

• Enable Password Import option in ulaa browser

  Dear Ulaa Team, I noticed that the Ulaa Password Manager currently offers an option to export passwords, but not to import them. This limitation poses a challenge for users like me who have stored numerous credentials in browsers like Chrome. Manually

• "Is Zoho CRM customer" vs "Is linked with Zoho CRM"

  Recently while building a Flow, I was setting up a Decision action following a Zoho Invoice Fetch record action. There were 2 choices that I had not seen as something I could manually action in Zoho Invoice: "Is Zoho CRM customer" and "Is linked with

• Client Script | Update - Introducing ZRC: Simplified HTTP request library

  Hello Developers! Are you tired of juggling different methods to make API calls? Are you confused with multiple syntaxes and version restrictions? Have you ever wished for one simple way to make all API calls in CRM? We heard you :) Here comes ZRC (Zoho

• Selection Filed for Data Export section

  Hi FSM Team, I hope you are all doing well. I would like to share an idea for future development based on my experience. Currently, in FSM, we can only download up to 5,000 records at a time. If the development team could add a selection option to choose

• What if I dont see contacts on the left side list

  My CRM does not show the contacts tab. In order to create list this is needed and I cant find it.

• Comments Vs. Replies

  I'm curious as to the difference between a "Reply" and a "Comment" on a ticket. It appears that "Replies" are what's used to determine response time SLA's and there are also used to automatically re-open tickets. I'm just trying to understand the key differences so I can educate both our clientele and our back-end users on which function/feature to use to better improve the ticket lifecycle. If anyone has any insight it would be appreciated. Thanks!

• Transitioning to API Credits in Zoho Desk

  At Zoho Desk, we’re always looking for ways to help keep your business operations running smoothly. This includes empowering teams that rely on APIs for essential integrations, functions and extensions. We’ve reimagined how API usage is measured to give

• Can you prevent closing Ulaa window when the last tab is closed (inadvertently)?

  Most browsers have started to bring this feature in to prevent closing their windows when the last tab is closed (inadvertently). I hope Ulaa should get this in too.

• Microsoft Phone Link

  Does anyone know if you can use Microsoft Phone Link to make calls through Zoho?

• Voip Phone system that integrates with Zoho

  Just checking to see if anyone could tell me what phone system they are using with Zoho that is on the list of systems that integrate with Zoho.  I use Vonage and have been with them for quite a few years but their service has really gone down hill and

• Removing Related Modules Lookup Fields Assignment / Relationship

  Issue: When creating a related list, I accidently selected module itself creating a circle reference. See attached. Situation: I wish to relating a custom module called "Phone Calls" to Leads and Contacts. Outcome: 1) I either want to remove the this

• Multiple email accounts, one phone

  Hi, I have my own businesses that use Zoho mail, now I would like to use zoho mail also for a local charity. But I noticed adding a phone number is compulsory for registering an account, and I only have one phone. This means I can not open an account because my phone number is already in use for another account. Can this be fixed? Thanks Vincent

• Attendance | Flexible Working Hours

  hi there, we are a small digital business working with flexible working hours and we are having a hard time setting up zoho people for attendance tracking. everyone of us has an individual agreement with the company regarding weekly hours (e.g. 40 hours/week,

• Seriously - Create multiple contacts for leads, (With Company as lead) Zoho CRM

  In Zoho CRM, considering a comapny as a lead, you need us to allow addition of more than one contact. Currently the Lead Section is missing "Add contact" feature which is available in "Accounts". When you know that a particular lead can have multiple

• can I link a contacts to multiple accounts

  can I link a contacts to multiple accounts

• Free webinar! Digitize recruitment and onboarding with Zoho Sign and Zoho Recruit

  Hello, Tired of being buried in onboarding paperwork? With the integration between Zoho Sign and Zoho Recruit, a powerful applicant tracking system, you can digitize and streamline the entire recruitment and onboarding process, all from one platform.

• Open Activities view.

  I really like the new views for the open and closed activities inside the deals. But when you are in the tab view instead of the column view you can only complete and edit the open activity there isn't the 3 dot option to be able to delete the activ

• Potentially Outdated and Vulnerable Chromium Engine Installed by Ulaa Browser Installer

  I just installed Ulaa Browser a few minutes ago. Whats My Browser page shows I am using an outdated Chromium engine meaning I might be vulnerable for security exploits that might have got fixed in the new version.

• Potentially hardcoded list of Browsers to import from (after Ulaa Setup)

  I have just installed Ulaa Browser and found that the list of browser to import data is potentially hardcoded ones rather than looking at the system. I do not have FF, IE and Edge is not my default itself. I would appreciated if Ulaa detected my browsers

• From Layout to Code: Finding Custom Field IDs in Zoho Projects.

  Hello everyone! Ever found yourself wondering how to get the API names and IDs of custom fields in Zoho Projects while working on custom functions? Here’s a simple and effective way to do it! This method makes it super easy to locate the right field details

• Can I create multiple Zoho mail accounts?

  Hey there I've searched the FAQ for this but didn't find the answer I was looking for. I like to have a different e-mail address for personal stuff, for creating account on websites, and for online banking / e-commerce. Is it allowed to create three accounts for one person on Zoho? I already have one personal e-mail address, can I sign up two more times from the homepage? Thanks

• Employee type and source translation

  In Zoho People, when I fill in the employee’s information, there is the option to determine the type of employment (employee type) and the hiring source. Both options ALWAYS appear in English. It is extremely inconvenient to deal with poorly translated

• Sync Issue Between Zoho Notebook Web App on Firefox (PC) and Android App

  Hi Zoho Notebook Community, I'm facing a sync problem with Zoho Notebook. When I use the web version on Mozilla Firefox browser on my PC, I create and save new notes, and I've synced them successfully. However, these new notes aren't showing up in my

• Request for Clarity on Timeline for True GPT/Zia Auto-Response Capabilities

  I appreciate Zoho’s steady innovation, but I’m concerned that Desk and Zia remain well behind modern AI capabilities. For years, GPT-based tools have been able to generate and send contextual responses, yet Zoho Desk only supports summarization or suggested

• Notebook audio recordings disappearing

  I have recently been experiencing issues where some of my attached audio recordings are disappearing. I am referring specifically to ones made within a Note card in Notebook on mobile, made by pressing the "+" button and choosing "Record audio" (or similar),

• Has anyone built a ticket export that allows Help Center users to export the tickets shown in the My Area list they are looking at?

  Hi, We are moving to Zoho Desk soon. Our current support system displays an option in our help center allowing customers to export their Open, Closed, or all tickets based on which list they are looking at. We need to offer the same in Zoho Desk help

• Zoho Desk: Q2 2025 | What's New

  Hello everyone, We are excited to announce Zoho Desk's 2025 Autumn updates. This release brings new features and enhancements that improve work management and enable businesses to provide a better overall support experience. Spanning from Zia Agents to

• Checkboxes not adhering to any policy in mail merge - data from CRM

  I want checkboxes to appear depending on whether the checkbox in the CRM module is ticked or not. However, the tickboxes that appear are either ticked or not, but don't correlate to the actual selections in the CRM module. This is is despite updating

• Items Landed Cost and Profit?

  Hello, we recently went live with Zoho Inventory, and I have a question about the Landed Cost feature. The FAQ reads: "Tracking the landed cost helps determine the overall cost incurred in procuring the product. This, in turn, helps you to decide the

• CC and/or BCC users in email templates

  I would like the ability to automatically assign a CC and BCC "User (company employee)" into email templates. Specifically, I would like to be able to add the "User who owns the client" as a CC automatically on any interview scheduled or candidate submitted

• Create Contract API Endpoint Unclear "inputfields" Requirements

  Hello, I'm trying to create a Deluge function that accepts inputs from a form in Zoho Creator and creates a barebones contract of a given type. See below for the current code, cleaned of authentication information. // Fetch form data // Hidden field client_name

• Kaizen #46 - Handling Notes through Zoho CRM API (Part 1/2)

  Hello everyone! Welcome back to another week of Kaizen! This week, we will discuss Handling Notes through Zoho CRM API. What will you learn from this post? Notes in Zoho CRM Working with Notes through Notes APIs 1. Notes in Zoho CRM 1a. Why add Notes to records? Notes are a great way to summarize your observations on customer and prospect interactions and outcomes. By saving notes as CRM data, a sales rep will always be able to keep track of how a sale is progressing. To know more about notes in

• Marketer's Space - Why email marketing matters in ecommerce (and how to get started with Zoho Campaigns)

  Hello Marketers, Welcome to this week's Marketer's space post. Today, we'll discus why email marketing matters in ecommerce businesses. Running an online store is exciting but challenging. If you're running an online store, you've probably experienced

• Zoho Campaigns Event timestamps do not propagate to Zoho CRM

  We have integrated Zoho CRM and Zoho Campaigns. But when looking at Contact records, the Campaign event data is missing the actual timestamps: especially when a particular email was sent. They're not in the Campaigns related list, and the cannot be found

• Kaizen #121 : Customize List Views using Client Script

  Hello everyone! Welcome back to another interesting Kaizen post. In this post, we can discuss how to customize List Views using Client Script. This post will answer the questions Ability to remove public views by the super admin in the Zoho CRM and Is

• Setting default From address when replying to request

  At the moment, if I want to reply to a request, the From field has three options, company@zohosupport.com, support@company.zohosupport.com, and support@company.com.  The first two are really internal address that should never be seen by the customer and

• Tip #45 - Explore Your Support Reach with Zoho Assist’s Geo Insights - 'Insider Insights'

  Understanding where your remote support sessions are happening can help you make smarter decisions, allocate resources effectively, and improve overall customer satisfaction. In this week's Zoho Assist's community post we will be exploring Geo Insights

• Next Page