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 look at what install actions are and when to use them, and then we'll walk through a real-world example where users are notified whenever a topping is installed or uninstalled.

What are install actions?

Install actions are important features of a topping that let you execute custom logic during installation and uninstallation events.

Instead of treating installation and uninstallation as silent background events, the Bigin Developer Console allows you to run your own logic the moment a user installs your topping, updates it, or decides to uninstall it. This logic can be implemented as Deluge functions that are executed automatically based on the installation action.

Primarily, install actions are executed in the following scenarios:

1. On Installation: This action is triggered when the topping is installed for the first time or when the topping is upgraded. (A topping upgrade refers to a new version of the topping being installed by the organization user.) In both cases, the On Installation action runs to perform the required logic.
   
2. On Uninstallation: This action is triggered when the topping is uninstalled or removed from an organization.
   

Let's look at each of these in detail.

On Installation

The On Installation action is triggered immediately after a topping is successfully installed or updated in a Bigin organization. Conceptually, this is the topping's first run and the right place to perform one-time setup tasks that you don't want users to handle manually.

Note: You can write only one On Installation script per topping. This script is executed only during two key events of the topping: the topping being installed for the first time and an updated version of the topping being installed after publishing changes.

This means the On Installation script is not executed repeatedly. It runs only when the topping is installed or updated, ensuring that setup logic is executed only when it's actually required.

To create an On Installation script, access the Bigin Developer Console, navigate to the Install Actions section in the left panel, and choose Toppings.

You'll be redirected to the Deluge editor where you can write the script for the On Installation action.

In the right panel of the Deluge editor, you'll be able to find the installParamMap which contains important contextual details such as the organizationId, installerId, previousVersion, and other details that are provided by the install action script itself. These keys can be used within your script to perform custom logic based on the installation context.

For more information about the keys that you can use inside the installation script, refer to the install actions documentation.

On Uninstallation

The uninstallation process of a topping will be handled by the On Uninstallation action. This function runs when a topping is removed from an organization.

To create an On Uninstallation script, navigate to Install Actions in the left panel, choose Toppings, and write the script in the On Uninstallation section of the Deluge editor.

In the On Uninstallation action, the installParamMap provides the keys organizationId and installerId. These values indicate which organization the topping is being removed from and which user initiated the uninstallation.

Now that we've explored how both of the install actions work, let's move on to creating a topping using these actions in a real-world scenario.

Let's create a topping with install actions

To understand how install actions work in a real-world scenario, we’ll build a Compliance Notification Topping.

The purpose of the topping is to keep organization administrators of the Bigin account informed about the lifecycle of the topping—specifically when it becomes active and when it's removed from their Bigin account.

In many business environments, it's important for admins to be aware of compliance-related changes and system-level additions. Using install actions in the topping ensures that such notifications are handled automatically, without requiring any manual effort from the user.

To achieve this functionality, we'll rely on both of the install actions:

1. When a user installs the topping, the On Installation action is triggered, through which an email notification is sent to all active admin users in the organization, informing them that the Compliance Notification Topping has been successfully enabled. Along with this, a compliance checklist document stored in Zoho WorkDrive is also attached to the email.
   
2. When the topping is uninstalled, the On Uninstallation action is triggered, sending an email notification to all active admin users in the organization to inform them that the Compliance Notification Topping has been successfully enabled. A compliance checklist document stored in WorkDrive is also attached to the email.
   

Let's learn how to do this.

Setting up the topping

First, create a topping in the Bigin Developer Center. For detailed instructions on creating a topping, refer to this post on how to create a topping.

After creating a topping and accessing it in the Bigin Developer Console, the next step is to create the required service connections.

A connection for Bigin will be used to fetch admin users from the organization into the topping. In this connection we'll use the scope ZohoBigin.org.ALL, as we need to retrieve the org details of the Bigin account where the topping is installed.

Next, we need a WorkDrive connection because we need to download the compliance checklist file stored in WorkDrive and attach it to the notification email. For the WorkDrive connection, we'll be using the scopes WorkDrive.files.READ and ZohoFiles.files.READ.

For a detailed explanation of creating the default connections, refer to this post.

Once the connections are created, we can write the install action scripts.

Implementing the scripts

When the topping is installed, we need to send an email to all the active admin users with the installation details and the WorkDrive checklist as an attachment.

To begin, navigate to the Install Actions section in the left panel and select Toppings. Under the On Installation tab, we’ll write the Deluge script that needs to be executed when the user installs the extension.

Writing the On Installation script

In our topping, the On Installation script performs the following actions:

1. Fetches all the active admin users in the organization
   
2. Downloads the checklist file from WorkDrive
   
3. Sends an email notification to the admin users with the installation details and the checklist file.
   

1. topping_name = "Compliance Notification Topping";
2. // 1) Fetch admin users
   
3. resp = invokeurl
4. [
5. url :"https://www.bigin.com/developer/docs/apis/v2/get-users.html"
6. type :GET
7. connection:"biginplus__biginnewconnection"
8. ];
9. // 2) recipient list
10. stakeholders = List();
11. usersList = resp.get("users");
12. if(usersList != null)
13. {
14. for each user in usersList
15. {
16. email = user.get("email");
17. status = user.get("status");
18. if(email != null && (status == null || status.toLowerCase() == "active"))
19. {
20. stakeholders.add(email);
21. }
22. }
23. }
24. // 3) Download WorkDrive file via Download API
25. header = Map();
26. header.put("Accept","application/vnd.api+json");
27. resource_id = "khw4zbab917b7f4774260a06636089ef0074f";
28. fileResp = invokeurl
29. [
30. url :"https://download.zoho.com/v1/workdrive/download/" + resource_id
31. type :GET
32. headers:header
33. connection:"biginplus__zohoworkdriveconnection"
34. ];
35. // 4) constructing email
36. org_id = installParamMap.get("organizationId");
37. installer_id = installParamMap.get("installerId");
38. current_time = zoho.currenttime;
39. subject = "Bigin Topping Enabled: " + topping_name;
40. message = "";
41. message = message + "<b>" + topping_name + "</b> was <b>Installed</b>.<br/><br/>";
42. message = message + "<b>Organization ID:</b> " + org_id + "<br/>";
43. message = message + "<b>Installed by (User ID):</b> " + installer_id + "<br/>";
44. message = message + "<b>Time:</b> " + current_time + "<br/><br/>";
45. message = message + "<b>Business impact:</b> This topping is now active for the organization.<br/>";
46. //sending the email
47. if(!stakeholders.isEmpty())
48. {
49. sendmail
50. [
51. from :zoho.adminuserid
52. to :stakeholders
53. subject :subject
54. message :message
55. Attachments :file:fileResp
56. ]
57. }

For details about the API endpoints and request formats used in this code, refer to the Bigin and WorkDrive API documentation. For the syntax to send emails via a Deluge task, you can refer to this documentation.

Writing the On Uninstallation script

When a user decides to remove the topping, we'll send an email notification to ensure the admins stay informed.

1. topping_name = "Compliance Notification Topping";
2. // Fetch admin users
3. resp = invokeurl
4. [
5. url :"https://www.zohoapis.com/bigin/v2/users?type=AdminUsers"
6. type :GET
7. connection:"biginplus__biginnewconnection"
8. ];
9. stakeholders = List();
10. usersList = resp.get("users");
11. if(usersList != null)
12. {
13. for each user in usersList
14. {
15. email = user.get("email");
16. status = user.get("status");
17. if(email != null && (status == null || status.toLowerCase() == "active"))
18. {
19. stakeholders.add(email);
20. }
21. }
22. }
23. org_id = installParamMap.get("organizationId");
24. uninstaller_id = installParamMap.get("installerId");
25. current_time = zoho.currenttime;
26. subject = "Bigin Topping Disabled: " + topping_name;
27. message = "";
28. message = message + "<b>" + topping_name + "</b> was <b>Uninstalled</b>.<br/><br/>";
29. message = message + "<b>Organization ID:</b> " + org_id + "<br/>";
30. message = message + "<b>Uninstalled by (User ID):</b> " + uninstaller_id + "<br/>";
31. message = message + "<b>Time:</b> " + current_time + "<br/><br/>";
32. message = message + "<b>Business impact:</b> This topping is no longer available from now on.<br/>";
33. if(!stakeholders.isEmpty())
34. {
    
35. //Send email
36. sendmail
37. [
38. from :zoho.adminuserid
39. to :stakeholders
40. subject :subject
41. message :message
42. ]

Once we've configured both the On Installation and On Uninstallation scripts, we can test and publish the topping. When the user installs the topping, the install actions will be triggered automatically based on the topping's lifecycle events.

Let's walk through what happens at runtime.

What happens when the topping is installed or uninstalled

Upon installation, the user receives an email notification along with the topping checklist attachment as shown below.

When the topping is uninstalled, the user receives an email indicating that the topping has been disabled as shown below:

In this post, we've explored how install actions and uninstall actions give us control over the toppings. We'll cover more features of the Bigin Developer Console in our upcoming posts.

Stay tuned!

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

• Actual vs Minimum

  Hi all, I am sure I am not the only one having this need. We are implementing billing on a 30-minute increment, with a minimum of 30 minutes per ticket. My question is, is there a way to create a formula or function to track both the minimum bill vs the

• Generate leads from instagram

  hello i have question. If connect instagram using zoho social, it is possible to get lead from instagram? example if someone send me direct message or comment on my post and then they generate to lead

• Kaizen #234 - Automating Deal Handoff with Zia Assistant API, Workflow, Deluge, and Widget in Zoho CRM

  Hello all! Welcome back to a fresh Kaizen week. In this post, we will explore how to automate the deal handoff process in Zoho CRM using Zia Assistant API + Workflow + Deluge + Widgets. Here’s how the final output looks when a deal is reassigned 1. Deal

• Warranty Service and Repair in Zoho FSM

  Hi There, We are a retail store that sells products and also performs installations and repairs. Our field technicians handle this work. Some repairs are covered by manufacturers, who reimburse us for both parts and labour. In these cases, we perform

• How do you print a refund check to customer?

  Maybe this is a dumb question, but how does anyone print a refund check to a customer? We cant find anywhere to either just print a check and pick a customer, or where to do so from a credit note.

• Ability to assign Invoice Ownership through Deluge in FSM

  Hi, As part of our process, when a service appointment is completed, we automated the creation of the invoice based on a specific business logic using Deluge. When we do that, the "Owner" of the invoice in Zoho FSM is defaulted to the SuperAdmin. This

• All new Address Field in Zoho CRM: maintain structured and accurate address inputs

  Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. Latest

• Enhancement to ICR’s field prompting: Preferred data extraction using advanced field prompting

  Dear Customers, We hope you’re well A quick background Intelligent Character Recognition (ICR) comes as part of Zia’s optical recognition capability called Zia Vision. When we introduced it last April, the data extraction was training-based and was applicable

• See a list of all records enrolled in a cadence?

  I am looking for a way to see a list of all leads or contact currently enrolled in a cadence. I do not see any way to do this through the cadence UI.

• Limitation in chart of accounts

  There is a limitation of 4000 accounts in chart of accounts  Zoho needs to remove this limit

• How do I change the account bank charges are charged to?

  I want bank charges charged to my Credit Card Fees account. Is there a way to do this?

• Real signature in Zoho Expense PDF report ?

  Hello ! Is there a way to put a real signature on the signature line when a PDF report is generated in Zoho Expense? Through Zoho Sign or another way? Can't seem to make it work.

• Copy paste settings

  Hello all i have 2 organizations running in ZOHO books in one organization i have customised Tax rates, codes and customized templates instead of manually doing again in org 2 can i have some shortcut to copy paste or export and import??

• Custom TDS on Vendor Credits via API

  Hi, We are using Zoho Books APIs for posting Bills and vendor credits. We are unable to post custom TDS amount posting vendor credits. Can you please share the API spec and Payload that need to be sent for Custom TDS for Vendor Credits.

• "Unlink" Advance from Bill without Deleting the Payment Record

  I am writing to highlight a significant workflow issue in Zoho Books (India Edition) regarding Vendor Advances and Bills. The Scenario: I recorded an Advance Payment to a vendor. I matched/reconciled this payment in the Banking module. I received a Bill

• Advance Payment Record Removed When Deleting Applied Credit from Bill

  Hello, So while working with vendor advance payments, I noticed that removing the applied credit from a bill also removes the corresponding entry from the Payments Made section. What I did : Recorded an advance payment to a vendor through Payments Made.

• What is the best way to convert MSG file to Word format?

  The best way to convert MSG files to Word format is by using a reliable and professional tool Aryson MSG file Converter. Manual methods are often time-consuming and may not preserve email formatting, attachments, or metadata accurately. In contrast, Aryson

• Address Typeahead Extension for Zoho Books

  I installed the Address Typeahead extension for zoho books but when I went to configure it, it said that that version was deprecated. Is there a newer version somewhere?

• How to create a new Batch and update Stock via Inventory?

  Hi everyone, We are building an automation where a user enters batch details (Batch Number, Mfg Date, Expiry, and Quantity) into a Custom Module. I need this to trigger an API call to Zoho Inventory to: Create the new batch for the item. Increase the

• Zoho Projects : Task should auto-update to 'In Progress' if timer started

  Namaskaram. Right now, if a Task's timer is started, the Task stays in 'Not Started' status. One has to manually update it to 'In Progress'. From a #uxdesign standpoint, it is an unnecessarily two step process to start working on a task. It would be better that, if I start the timer on a task, it should automatically change to 'In Progress' status. Crafted with ❤️ Zoho Gurus | Zoho One Practice Team @ CubeYogi Zoho Authorised Partner | 7+ Yrs | 200+ Projects | 100+ Customers

• Invoice template with sales tax totals

  Hi everyone,  I am trying to edit my invoice template so that only the total sales tax collected for my tax group shows up. Right now, under by sub total, each individual tax shows up and that takes up a lot of unnessary space, so I just want the one

• Zoho Delayed Posting & Loss of Article Thumbnails on BlueSky

  Hello! I am wondering if anyone else has had the either of the following issues when posting to socials via Zoho and if there is a fix? 1. Post says it is scheduled or it is live when sent off via Zoho but it doesn't show up on socials till some time

• Connection Not Secure (Certificate Mismatch) Error

  Hi, Just a fyi, when you go to https://bigin.zohocloud.ca/bigin/Home you get a "Your Connection Is Not private" error. (Certificate mismatch to domain.) I get to that page after I have signed up and signed in as a customer and select the Access Bigin

• Recording the Investment

  Hello, - One Investor Invested to our company, So how do we record investment which we received in our bank in the Zoho books ? - How do we record if we provide shares to the investor in the Zoho books? Thanks

• Export Invoices to XML file

  Namaste! ZOHO suite of Apps is awesome and we as Partner, would like to use and implement the app´s from the Financial suite like ZOHO Invoice, but, in Portugal, we can only use certified Invoice Software and for this reason, we need to develop/customize on top of ZOHO Invoice to create an XML file with specific information and after this, go to the government and certified the software. As soon as we have for example, ZOHO CRM integrated with ZOHO Invoice up and running, our business opportunities

• Client and Vendor portal at the same time

  We have companies that serve both as clients and vendors and they are linked. However, we have a problem giving them access to the vendor/client portal. If they accept the invitation from the client portal, when we try to invite them to the vendor portal

• Integrate Multiple ZohoBooks organization with zoho projects

  We have successfully connected our Zoho Books with Zoho Projects for synronizing timesheet data. Our Business specialty is, that the staff of the Main company (A) is working on several projects, but the Clients are sometimes contracted and paying to a

• ZOHO CRM Button Integration

  Hi Team, I’m currently working with Zoho CRM along with a custom application where I fetch deal details from the CRM and use them based on my requirements for each deal. Now, I want to enhance this setup. I plan to create a button on the Deal Detail page

• Ways to calculate the difference form two years or months

  Hi to everyone I have this request: I need to show the difference or variation from two periods (years or months) whether using a Pivot View or a graph, in this is case is better in a Pivot view. In the pivot view I will have the amount or results from

• Zoho CRM strips whitespace in text fields

  When editing field text with multiple spaces: CRM - both UI and API trim / compress the whitespace to a single space when saving: Is this known / expected / documented behaviour?

• Career site URL - Suggestion to modify URL of non-english job posting

  Hi, I would like to suggest making a few modification to career sites that are not in english. Currently, the URL are a mix of different languages and are very long. It makes for very unprofessional looking URLs... Here is an example of one of our URL

• Uplifted homepage experience

  Editions: All editions. Availability update: 17th February 2026: All editions in the CA and SA DC | JP DC (Free, Standard and Professional editions) 23 February 2026: JP (All Editions) | AU, CN (Free, Standard, Professional editions) 27 February 2026:

• 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

• How to update "Lead Status" to more than 100 records

  Hello Zoho CRM, How do I update "Lead Status" to more than 100 records at once? To give you a background, these leads were uploaded or Imported at once but the lead status record was incorrectly chosen. So since there was a way to quickly add records in the system no matter how many they are, we are also wondering if there is a quicker way to update these records to the correct "Lead Status". I hope our concern makes sense and that there will be a fix for it. All the best, Jonathan

• Introducing Contract Settings & Backdated Contracts in Zoho Contracts

  We are rolling out updates that give you more control over how contracts are created and managed in Zoho Contracts. From defining default workflows with Contract Settings to aligning agreements with real timelines using Backdated Contracts, these enhancements

• Celebrating our customers on International Client's Day

  Hi everyone, Every customer is part of our Zoho Desk family, and we wouldn’t want to miss celebrating you on this special day. This International Client's Day, we’d like to take a moment to appreciate every customer who has helped us grow and build meaningful

• Zoho Books | Product updates | February 2026

  Hello users, We’ve rolled out new features and enhancements in Zoho Books. From Advanced Reporting Tags to the ability to mark projects as completed, explore the latest updates designed to improve your bookkeeping experience. Introducing Advanced Reporting

• Faster Ticket Response with use of Snippets in comments

  Hello everyone, Responding to tickets often involves repeating the same messages, whether it is sharing updates with customers or leaving notes for internal collaboration. To make this easier and more consistent, we are allowing agents to use snippets

• Improving Zoho Creator's email deliverability

  Hi all, We're pleased to announce updates to email handling in Zoho Creator to improve the deliverability of the emails sent from the Creator platform. These updates have been designed keeping in mind the fact that emails from domains with strong sender

• What's New in Zoho Billing | February 2026

  February brings a powerful set of updates to Zoho Billing, from smarter subscription management and flexible payment options to better reporting and more control over your hosted pages. Here's everything that's new this February. Create Subscriptions

• Next Page