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

• Zia Agent activation in Zoho Desk forces new Organization creation instead of deploying to existing one

  While attempting to complete the deployment and activation sequence of a new Zia Agent within our existing Zoho Desk environment, the activation process failed on the user interface, throwing a generic error (see print). However, despite the activation

• Allow native Webhooks to authenticate via Connections

  Allow native Webhooks to authenticate via Connections (Basic Auth) instead of plaintext custom headers Summary Please allow native Webhooks (Workflow Rules > Instant Actions > Webhooks) to authenticate against the destination endpoint using the existing

• How do page versions work these days?

  I thought that Zoho Wiki had the capability to display previous versions of a page, and optionally reinstate them. But I can't find a current doc on this subject -- is there one? From what I remember, that capability was accessed via the Version number

• Warehouse -> Locations Transition Causing Errors

  After saying "okay" to the transition from 'warehouses' to 'locations', I've now got shipped Sales Orders that I cannot invoice. How does one proceed?

• Problem with the blueprint flow.

  Scenario: 3 departments in a single environment: A-B-C agents from department 1 D-E-F agents from department 2 G-H agents from department 3 Since we've been using Zohodesk (2023), agents can assign tickets to the correct department using the blueprint

• 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

• Ability to run report over 180 days

  Is there a reason Zoho limits the ability to run reports for records older than 180 days? In my view, the only reason I can think of is that it forces us to pay for Advanced Analytics (which I do).

• Cloning a View

  When I clone a View, it doesn't make a copy; it only creates a new copy with the same default fields as if I were creating a new view. What is the purpose of cloning if it doesn't bring in the same fields? Thanks Rudy

• New tickets with empty image contents

  Dear Support. From the end of last week onwards customers send messages for new tickets through microsoft graph (by email to support at procert.ch using the procert portal). We have an issue with the emails because well packed images are no longer visible.

• Images not showing up in Desk tickets

  Customers are trying to send us screenshots to diagnose their issues. But Desk seems to be stopping the images/breaking the link when the ticket comes in. (We can see them in an email box getting cc'd on all tickets...so it's not our mail system). Help!

• Introducing Databridge for Zoho Creator

  Hello, Enterprise Support Community! We'd like to highlight a recent utility that was released for Zoho Creator, that will allow you to connect external, private datasources with your Creator apps, Databridge. Databridge is an application that will need

• Zoho HTML editor is removing MSO (Outlook) specific code.

  The ability to add in custom HTML is great. We are using MJML to generate our wonderfully cross platform and responsive email code that works on Act-On, Salesforce, Hubspot, Active Campaign, and lead liaison. The way it supports MSO (Outlook) is it included

• Retail Payment Receipt

  Hi, So "payment receipts" have a "Retail" template for thermal printers, but the template is configured at A4 paper size!!! How is this retail guys? On the other hand, Invoices have 3 Retail templates which have 3 and 4 inch paper size, perfectly fitting

• Custom Portal URL causing SAMEORIGIN error with embedded Page snippet

  In my app, I have a page that embeds another page. The URL that I have for the embedded page starts with https://creatorapp.zoho.com but the custom domain I have set up is https://kors.kerndell.com. Because the user logged into the app at https://kors.kerndell.com,

• Pasting images is a mess

  I’m trying to paste images into my tickets, in the comments field. But when I paste images, they end up in the wrong order or behind the text.

• Sort by Project Name?

  How the heck do you sort by project name in the task list views??? Seems like this should be a no-brainer?

• Zoho Contracts Just Got Better! CRM 2.0, Regional Settings & 6 New Reports

  Zoho Contracts is evolving to bring you a more efficient and customizable contract management experience. In this update, we are introducing powerful enhancements to our Zoho CRM integration, regional settings, and reports. Let us explore what’s new:

• Zoho Finance Limitations 2.0 #5: Can't select "Account Id" if creating Custom Links in Related Panel (but it's available for Custom Buttons)

  When creating a custom link within the Zoho Finance module there is no option to select the "Account Id". If creating a Custom Button, it's available. Any plans to make this available within a reasonable timeframe? ======== Perspective: using Zoho finance

• Zoho Cliq not working on airplanes

  Hi, My team and I have been having this constant issue of cliq not working when connected to an airplane's wifi. Is there a reason for this? We have tried on different Airlines and it doesn't work on any of them. We need assistance here since we are constantly

• 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

• 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

• 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

• [Free Webinar] New portal page customization in Zoho Creator - Creator Tech Connect

  Hello everyone, We’re excited to invite you to another edition of the Creator Tech Connect webinar. About Creator Tech Connect The Creator Tech Connect series is a free monthly webinar featuring in-depth technical sessions designed for developers, administrators,

• #11 Stop Absorbing Cost That Client Should Pay

  One of the easiest ways of losing profit in a business isn't losing a customer. It's forgetting to include the expenses that are incurred for half of your customers. A taxi ride to a client location A software subscription purchased for a project. Domain

• Related products & AI product recommendations through commerce API.

  Hello Zoho team I’m looking to add related products and AI product recommendations to my Zoho Commerce webshop with custom storefront. Is this supported through the API? And if not, is this on your roadmap? Thanks in advance David

• Can you sell Subscriptions using Zoho Commerce?

  In addition to physical products and the apparently coming soon 'Digital Products', it is possible to sell Subscriptions using Zoho Commerce?

• Zoho Commerce B2B

  Hello, I have signed up for a Zoho Commerce B2B product demo but it's not clear to me how the B2B experience would look for my customers, in a couple of ways. 1) Some of my customers are on terms and some pay upfront with credit card. How do I hide/show

• A method for renaming tab titles in Creator to display more relevant information

  Hi Zoho Devs, Updates: Rules Export File attached; you can now import this into Tab Modifier instead of manually entering the rules yourself) 2022-06-08: Updated rules so that crm.zoho.com tabs are not affected; uploaded new .json import file 2022-06-09:

• Bulk upload images and specifications to products

  Hi, Many users have asked this over the years and I am also asking the same. Is there any way in which we can bulk upload product (variant) images and product specifications. The current way to upload/select image for every variant is too cumbersome.

• Problem with CRM Connection not Refreshing Token

  I've setup a connection with Zoom in the CRM. I'm using this connection to automate some registrations, so my team doesn't have to manually create them in both the CRM and Zoom. Connection works great in my function until the token expires. It does not refresh and I have to manually revoke the connection and connect it again. I've chatted with Zoho about this and after emailing me that it couldn't be done I asked for specifics on why and they responded. "The connection is CRM is not a feature to

• Conditional Drop Downs

  Am I the only one that has a problem when setting up the same project for multiple customers - resulting in a HUGE number of projects (e.g. Project A - customer 1, Project A - customer 2, Project A - customer 3 etc.). OR, am I doing it wrong? What results

• Getting Project Template List using the REST API

  I am trying to confirm that I can use the REST API to create a project using a project template. The API documentation indicates this is possible by providing the Template ID, but it is not clear at all how to get a list of available Project Templates

• Can't delete shared mailbox emails from mobile app

  I have the mobile app on iOS and cannot seem to find a way to delete an email from a shared mailbox. Is there something I'm missing here? Michael

• From Zoho CRM to Paper : Design & Print Data Directly using Canvas Print View

  Hello Everyone, We are excited to announce a new addition to your Canvas in Zoho CRM - Print View. Canvas print view helps you transform your custom CRM layouts into print-ready documents, so you can bring your digital data to the physical world with

• Boost your CRM communication with new font types, sizes, and default reply-to options while composing emails

  Hello Everyone, We’re excited to introduce a series of impactful enhancements to the email composer settings in Zoho CRM. These updates enable you to personalize and optimize your customer interactions with greater efficiency. So what's new? Add custom

• Associate records via the Multi-select lookup RELATED LIST via API

  In the REST API, is there a way to associate records for a multi-select lookup related list other than via the linking module? There are two methods for the lookup: 1. via insert records API 2. via the linking module ...as described in https://help.zoho.com/portal/en/community/topic/kaizen-125-manipulating-multi-select-lookup-fields-mxn-using-zoho-crm-apis

• OAuth integration issues

  I'm experiencing persistent OAuth errors when trying to connect Make with Zoho API. I've tried multiple approaches but keep encountering the following issues: First error: 'Invalid Redirect Uri - Redirect URI passed does not match with the one configured'

• Zoho Books Placeholder: Inventory Counts

  I was hoping to figure out how to find the placeholders for inventory counts by item. We use Location based inventory tracking, so I dont know if that affects things. I want my PDF and Printed PICK LISTS to show the Quantity Available to Pick. I have

• Blueprint Not Triggering When Lead Status Is Updated by Workflow (IndiaMART Integration)

  I have set up a blueprint that triggers when a lead’s status is “New Lead.” Our CRM is integrated with IndiaMART, and when leads are created from IndiaMART, their Lead Status is initially set to None. To handle this, I created a workflow that automatically

• Le cauchemar de PEPPOL avec Zoho Books

  Après de longues hésitations — car je défends toujours les produits Zoho malgré leurs imperfections —, je me suis décidé à poster cet avis sur ce forum. En effet, depuis plus de 5 mois, les nombreux soucis relatifs à la facturation par PEPPOL semblent

• Next Page