Testing and publishing Bigin toppings

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 follow-up management in Bigin and ensure that follow-up calls are systematically created based on certain conditions, helping users improve the efficiency of their sales cycles and stay on top of their tasks.

Setting up the topping

We'll start with a custom field and workflow by creating a topping in the Bigin Developer Center.

Inside the created topping's Developer Console, add a new field by navigating to the Components section under the Build category and clicking the New Custom Field button. Create a custom field named "Follow-up Needed" in the Tasks module. This field should be a picklist with two values: "Yes," which will trigger a follow-up, and "No," which indicates that no follow-up is needed.


Creating a default Bigin connection

Next, create a default Bigin connection and authorize it to securely access your Bigin data. This connection allows authorized interaction between the topping and Bigin's modules.

For a more detailed explanation, refer to our post on creating Bigin connections


Creating a workflow rule

To create a workflow rule to schedule follow-up calls, go to the Automate section and select Workflow, then click the Create Rule button. From the Module dropdown, choose Tasks and enter "Schedule Follow-Up Call" as the rule name. Once done, click the Next button.



On this screen, we'll define the workflow rule. Set Record action as the criteria for the workflow rule execution. Then, select the Create or Edit option to specify which operation should trigger the rule.

Note: To ensure the workflow runs every time the task is updated, check the option Repeat the workflow whenever a task is edited, and click on the Next button to continue.



Next, you can define conditions that determine when the workflow should be triggered. To automate a follow-up call, apply these conditions:
  1. The status of the task is updated to completed.
  2. The Follow-up Needed field is set to "Yes."
Once the conditions are set, navigate to the Instant Actions section and select Function from the list of available actions. Provide a function name and display name, then click the Create Function button. This will redirect you to the Deluge editor, where you can write the logic for the function.



When the workflow criteria and conditions for a task are met, the function (which is created in the Deluge editor and linked to the workflow) will be executed automatically.

Let's look at how the logic is handled within the function in the Deluge editor.
  1. // Fetch the details of the task that's triggered by the workflow
  2. taskDetails = zoho.bigin.getRecordById("Tasks",task.get("Tasks.ID"),Map(),"taskscheduler__connectbigin");
  3. //Initialize a map to store call details
  4. callDetails = Map();
  5. callDetails.put("Call_Duration", null);
  6. callDetails.put("Call_Start_Time", "2025-03-04T18:00:00");
  7. callDetails.put("Call_Type", "Outbound");
  8. //Retrieve task data from the fetched task details
  9. taskData = taskDetails.get("data").get(0);
  10. //Extract task owner details
  11. ownerMap = Map();
  12. taskId = taskData.get("id");
  13. ownerMap.put("id", taskData.get("Owner").get("id"));
  14. //Assign owner details to the call record
  15. callDetails.put("Owner", ownerMap);
  16. //Assign contact details to the call record
  17. callDetails.put("Related_To",taskData.get("Related_To"));
  18. // Create a call record in Bigin
  19. response = zoho.bigin.createRecord("Calls", callDetails, Map(), "taskscheduler__connectbigin");

Overview of Code Logic

  1. Retrieve task details: The first step is to fetch the task details required for creating a follow-up call. (Note: We recommend using Bigin's Deluge functions to work with Bigin records.)
  2. Setup to create a call: A map is initialized to store call details.
  3. Create a new call record: Using the retrieved task details, which includes essential information like task owner details and related contact information, a new call record will be created in the Calls module in Bigin.
Once the function is created and saved, testing the topping ensures that any potential issues are identified and resolved before making it available to others.

Testing the topping in a sandbox

Thoroughly testing a topping is essential to make sure it's working as expected before it's submitted to the Marketplace team and listed in the Marketplace.

Before initiating the testing process, the developer must authorize the Bigin connection associated within the topping. For more details on connector authorization, please refer to the Connections guide.

This authorization enables secure data exchange between the topping and the connected Bigin account. Authorizing this connection is equally important when testing the topping using the sandbox environment, a virtual testing space that simulates the structure and behavior of a typical Bigin production account. The sandbox allows you to test your topping before deployment in an isolated environment where changes don't affect your live data.

To begin testing, navigate to the Test your Topping button located in the top right corner of the Bigin Developer Console. This will launch the virtual sandbox environment.



In the sandbox account, you can test the topping by creating a new task. Click on the Create New Record button and select Task from the options. Enter the necessary task details, ensuring that the Related To field is provided. This associates the task with the Bigin contact, enabling the follow-up call activity to be triggered for that specific contact when the workflow criteria is met. Next, set the Follow-up Needed field to Yes and save the task.

Navigate to the Activities module and go to the newly created task. Here, the automation happens based on two criteria specified in the workflow:
  1. The field value of Follow-up Needed is "Yes."
  2. The task is marked as completed.

Upon satisfying these two criteria, a follow-up call for the task will be created in the Calls module.



If the topping isn't working as intended, you can fix the issue instantly in the Developer Console and test in the sandbox environment.

Publishing the topping

Once you finish building and testing the topping, you can publish it two ways, depending on how you want to distribute it to users:
  1. Publish your topping privately.
  2. Submit it to the Bigin Marketplace.

Publishing a topping for private customers

If you're building a topping for a particular set of customers, you can choose private publishing. Choose the Publish option in the left panel of the Bigin Developer Console to do this.

After choosing the option, the Bigin Developer Console displays the customizations and components used in the topping.

Provide a release note for the topping and click the Confirm button. You'll get an installation URL for your topping. You can share this URL with customers so they can install the topping in their Bigin account.

You can also share the topping privately via email. Click the Share Privately option for a preconfigured email template. Enter the customer's email in the To field, then click the Share button to send the email.


Publishing publicly in Bigin Marketplace

If you want to share your topping with a wide audience, the Bigin Marketplace is your go-to platform. This platform lists Bigin toppings and makes them available to all users. If you want to list your topping in the Bigin Marketplace, you must follow a set of procedures:
  1. Submit the topping for review to the Marketplace team.
  2. Ensure the topping satisfies all the Marketplace standards.
To submit the topping to the Marketplace, navigate to the Bigin Developer Center, choose the topping you need to publish, and click on the Toppings details icon.



Under the Status section, click Submit to Marketplace.



Here, you need to provide details about your topping in the Marketplace Details window. Once the Bigin Marketplace team completes the review process, the topping will be listed in the Bigin Marketplace, allowing users to find and install it in their Bigin accounts.

From integrating components to submitting toppings for review, we've covered building and testing toppings.

In upcoming posts, we'll take a closer look at each feature with a detailed use case.

Stay tuned!

<<Previous                                                                                                                                                                                                                                                                            Next>>                                                                                                                                                                                                                                                                                                                   
      • Recent Topics

      • Upgraded sentiment analysis model for more accurate detection

        Hello everyone! Sentiment Analysis in Zia is being upgraded to a newer model to improve how customer sentiment is detected and interpreted. This transition is aimed at getting better contextual understanding across all supported channels. As part of this
      • Notebook Al

        Why was our organisation's Notebook AI disabled, even though our admin said it wasn't done on their side?
      • Dashboard Filtering with 2 query tables using one filter field

        Hi There, I have been using user filters on the dashboard and for the most part they are fine. However I have one issue I would like to see if there is a fix for it. I have a main query that most of my widgets use. Then I have a second query for another widget. The dashboard uses the field "brand" in the main query for the filter.  The second query uses the main_query.brand field alongside fields from a second table. I have set the widget to use main_query.brand as a filter, but when the dashboard
      • How to get static reports via Desk API

        Hello, we are hoping to use the Desk API to automatically export the default static reports in Zoho Desk, or reconstruct them via other API calls. What's the best way to do this? For example, if I want to recreate the Response Time static report via the
      • What's New in Zoho POS - April 2026

        Hello everyone, Welcome to Zoho POS’s monthly update, where we share our latest feature updates, enhancements, events, and more. Let’s take a look at how April went. Access and manage other web applications in Zoho POS with Web Tabs You can now access
      • Issue with adding “Roblox” as an answer option in Zoho SurveyО

        Hello Zoho Support Team, I’m experiencing an issue while editing a survey in Zoho Survey. For some reason, I’m unable to add “Roblox” as an answer option. The same issue occurs with any answer option that contains this exact combination of letters, regardless
      • How to import MBOX to Gmail?

        In order to import or restore MBOX file backup Gmail account you can go for Advik MBOX to Gmail Import utility. This utility will import MBOX to Gmail or G Suite account without any configuration. This tool is considered as the most easiest and simplest process to perform email migration. Key Feature of this tool Import MBOX to Gmail in Bulk Maintain folder struture Retain Key elements Single Panel Interface 100% accuracy rate Download source : http://www.adviksoft.com/mbox/gmail.html
      • Free webinar! Accelerate deals with Zoho Sign for Zoho CRM and Bigin by Zoho CRM

        Hello, Paperwork shouldn’t slow you down. Whether you’re growing a small business or running a large enterprise, manual approvals and slow document turnaround can cost you time and revenue. With Zoho Sign for Zoho CRM and Bigin by Zoho CRM, you can take
      • Sort or filter CRM report by count value

        Hi there, I'm trying to create a report that will show me high frequency bookings (leads) coming through within a time period for any particular account - this is so we can proactively reach out to these accounts. I have a report that shows the information
      • Automatically set the default VAT percentage on a quote

        Every time I create a quote, I have to manually adjust the VAT and activate the checkbox for 21%. But all of our quotes include 21% VAT. So now occasionally, it happens that the checkbox is forgotten, and the customer receives an incorrect quote (without
      • Don't understand INVALID_REQUEST_METHOD when I try to post up an attachment

        When I make the POST request (using python requests.post() for files): https://www.zohoapis.com/crm/v8/Calls/***************01/Attachments I get this response: r:{ "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type
      • Bigin & Booking. Associate the appointment with existing customers in bigin.

        I tried to change the stage of the pipeline associated to a existing contact after he book a appointment in Booking. I use flow to create a event in booking when a appointment is done. But.... How can I relate the appointment with the existing contact
      • Can Zoho Books support an Asset account as an item's purchase/COGS account? (Prepaid reseller use case)

        Hi everyone, I run a prepaid digital plan reseller business where I fund a vendor account upfront and draw it down as I make sales — essentially a float-based model, similar to a gift card or prepaid airtime reseller. The correct accounting treatment
      • Quotes - Freehand line items - zoho crm

        Hi, In the zoho crm quotes module is it possible to add line items that are freehand typed? We have a business need to use the quotes module but the product nams/description, quantity, price, etc. needs to be freely typed rather than from a defined list
      • TDS Payable report not Generating

        TDS Payable report for Last Quarter of FY 25-26 is not generating and giving error. Please get it rectified as soon as possble.
      • Remove Zoho Header from Portals

        I have a portal page with custom domain. But when I print directly from a webpage, the Zoho CRM header shows. It kind of kills the branding aspect. Is there a way to get rid of this?
      • Multi-column sorting

        Is multi-column sorting a planned feature for CRM? We are needing to sort by one column and then subsort by another column. I am just wondering if there is a planned feature that will allow this?
      • Clearing Fields using MACROS?

        How would I go about clearing a follow-up field date from my deals? Currently I cannot set the new value as an empty box.
      • Webinar Alert: Turn campaign leads into conversions with Zoho LandingPage and Zoho CRM

        Landing pages are great at capturing leads, but what happens after that is just as important. In this webinar, we’ll walk through how Zoho LandingPage and Zoho CRM work together to create a smooth flow from lead capture to follow-up and conversion. You’ll
      • Catch-All Address: A safety net for misdirected emails

        Email is often the first point of contact with an organization. In many cases, a simple typo in a recipient's address can quietly turn into a missed message—a customer query never reaches support, a partner’s reply goes unnoticed, and the sender has no
      • Need Assistance on Redirect URL or Button Based on Deal Stage

        Hello, I’ve developed a custom application and would like to achieve the following scenario: When a deal is moved to the Billing stage, an automatic trigger should execute and redirect to a URL that includes deal details such as Deal Name and Deal Owner.
      • Zoho IMAP Access to mail doesn't sync messages

        As stated in the topic - I have company account email address setup, and it has ( as in the picutre ) ActiveSync and Imap access enabled. However the messages does not show up while logged in in Zoho Mail however when I log in in thunderbird everything
      • Upload own Background Image and set Camera to 16:9

        Hi, in all known online meeting tools, I can set up a background image reflecting our corporate design. This doesn't work in Cliq. Additionally, Cliq detects our cameras as 4:3, showing black bars on the right and left sides during the meeting. Where
      • Using IMAP configuration for shared email inboxes

        Our customer service team utilizes shared email boxes to allow multiple people to view and handle incoming customer requests. For example, the customer sends an email to info@xxxx.com and multiple people can view it and handle the request. How can I configure
      • 【無料/オンライン】5/21(木)開催|Zoho ワークアウト ― ユーザー同士で作業・議論するもくもく会

        ユーザーの皆さま、こんにちは。 コミュニティグループの中野です。 5月開催の「Zoho ワークアウト」のご案内です。 本イベントは、Zohoユーザーが各自のテーマを持ち寄り、 作業を進めながら参加者同士で意見交換する「もくもく会」形式のオンラインイベントです。 「設定を進めたいけれど、一人だと手が止まってしまう」 「他社がどう活用しているのか知りたい」 「同じ課題を抱える仲間と話したい」 そんな方にぴったりのイベントです。 ▶︎ 参加登録はこちら(無料 / 残り3枠) URL:https://us02web.zoom.us/meeting/register/6ojuA778RqqWPOWzCaCU5Q
      • i keep see there is a connetion issue connecting 3rd party api on zoho when using zia

        hi there , i have set up open ai api to zoho zia (copied and pasted to zoho zia) but I keep getting notificaiton "there is a connetion issue connecting 3rd party api on zoho" when using zia on top when click zia and try to type in word there
      • Can't access google from toppings menu

        So... When I click the manage button in toppings, nothing happens. it won't let me access the settings.
      • Marketer's Space: Bookmarks by Zoho Campaigns

        Hello Marketers, In this week's Marketer's Space, we'll look at a simple yet powerful feature that makes a big difference in your workflow: Bookmarks. Bookmarks is a built-in feature in Zoho Campaigns that enables you to create a personalized library
      • Introducing the revamped What's New page

        Hello everyone! We're happy to announce that Zoho Campaigns' What's New page has undergone a complete revamp. We've bid the old page adieu after a long time and have introduced a new, sleeker-looking page. Without further ado, let's dive into the main
      • Cliq iOS can't see shared screen

        Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards
      • Tip #71 - Exploring Technician Console: Send Clipboard Keystrokes - 'Insider Insights'

        Hello Zoho Assist Community! Say you are helping a customer remotely and need to log into a system on their machine. You have the password ready on your end, but the moment you try to paste it into the login field, nothing happens. The remote screen just
      • Images not saved in notes

        Created noteboards and create a note, copy pasted the image, close the note and open again, image is not coming this same problem occurs in note on notebook I have attached the replication steps as video url to analyse it, and also attached the videos
      • New in Office Integrator: Apply conditional formatting to entire rows

        Hi users, We are pleased to introduce the ability to highlight entire rows based on a cell's value in Zoho Office Integrator's spreadsheet editor. For example, if your finance team tracks invoice payments in a spreadsheet, you can highlight overdue invoices
      • Zoho books - Project Module - Itemised expenses

        Hi All, I heavily use the projects function in Zoho books and can work for one client for successive weeks, providing labour and incurring the occasional general expenses.  As an example, during the one purchase, I purchase 10 widgets and of these 10, 
      • How to get REST API of extension function in CRM

        I create a an extension using ZOHO Sigma for integrate ZOHO CRM and XERO and established two way sync but when I public my extension it's standalone function are not provide any type of access so I can't get REST API Key of standalone functions without
      • A few Issues when using "Pay Bill via Check"

        We have quite a bit of issues with how paying for Bills via Check works. Would love some feedback from the Zoho team in case we are doing something incorrectly. 1. When we go from a vendor and select "Pay Bill via Check" option, we see ALL the outstanding
      • Show backordered items on packing slip

        Is it possible to show a column on the Packing Slip that shows number of backordered items when a PO is only partially filled? I would also like to see the Backordered column appear on POs after you receive items if you didn't get ALL of the items or partial amounts of items. And lastly, it would be nice to have the option of turning on the Backordered column for invoices if you only invoice for a partial order. -Tom
      • Elevate your Radar experience: Best practices part 1

        In the Spotlight: Zoho Desk's Radar app Think about RADAR (Radio Detection and Ranging)? The system used to track and identify aircraft, ships, and vehicles using electromagnetic waves. Imagine what a similar “Radar” experience looks like for customer
      • Mise à jour de Zoho Books – France

        Chers clients, Merci pour votre patience et votre soutien continu. Avec les évolutions réglementaires à venir en France nous introduisons de nouvelles fonctionnalités dans Zoho Books pour les clients français. Ces mises à jour ont été conçues pour répondre
      • Automation Series: Auto-update Budget When Time is Logged

        In Zoho Projects, Summary fields enable instant budget sync by capturing Actual Cost and showcases it at project-level when a time log is added. This allows real-time budget visibility and helps teams stay within financial thresholds. Consider an event
      • Next Page