Extension Installation Handler
This handler is triggered after the installation of the extension. The main purpose of this handler is to let you (extension creator) handle certain processes, like configuring webhooks after a user installs the extension. Click Edit Code under Installation Handler to write the script. If this handler is not configured, the extension will be activated by default. You will get the following attributes when the installation handler is executed:
The installation handler can also be used to give a response message to the user upon successful activation of the extension or when the extension activation fails. The message can have the following attributes
Activation Success
The installed extension will be activated, only when the installation handler returns 200 as the status response. A sample extension activation success message and how it will be displayed to the user is shown below.
Activation Failure:
The installed extension will not be activated when the installation handler does not return 200. In this case, the extension status will be displayed as Installed. In cases where the extension is not activated, the user can click the Activate option when hovered over the extension name under installed extensions. A sample extension activation failed message is shown below:
Sample Code Snippet
- response = Map();
- success = true;
- if(success)
- {
- response.put("status","200");
- }
- else
- {
- response.put("status","500");
- response.put("title","Uh-oh!");
- response.put("message","We're sorry! The extension installation failed.");
- note = list();
- note.add("Installation failure might be due to the following reasons:");
- note.add("1. Your account is not in the premium plan.");
- note.add("2. You have not configured the webhook properly.");
- response.put("note",note);
- response.put("footer","Contact support@yourdomain.com for any related help / support.");
- }
- return response;
Note:
The above code snippet will return a success response by default.
User Scenario
Let us consider an extension integrating GitLab and Cliq.
- First, the installation validator is triggered to confirm if the user is a GitLab admin.
- Once the installation validator gives a success response, the installation handler is triggered to activate the extension successfully.
- //Extension's Incoming Webhook Endpoint
- https://cliq.zoho.com/api/v2/applications/"APP-ID"/incoming?appkey="APP-KEY"&zapikey=" +zapikey (generated for each user)
Note:
The extension token or the ZAPI can be created by each user through a token generation dialogue prompt. Refer this help guide on how to generate an extension token?
- response = Map();
- success = true;
- if(success)
- {
- response.put("status","200");
- response.put("title","Success!");
- response.put("message","We're glad you chose this extension!");
- note = list();
- note.add("1. Use the Gitlab bot to resolve issues quicker!");
- note.add("2. Use the slash commands and message actions to keep track for activities");
- }
- else
- {
- response.put("status","500");
- response.put("title","Uh-oh!");
- response.put("message","We're sorry! The extension installation failed.");
- note = list();
- note.add("Installation failure might be due to the following reasons:");
- note.add("1. Your account is not in the premium plan.");
- note.add("2. You have not configured the webhook properly.");
- response.put("note",note);
- response.put("footer","Contact support@yourdomain.com for any related help / support.");
- }
- return response;
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Extension Incoming Webhook Handler
Integration with external applications can be done with the help of incoming webhook APIs. An extension token or ZAPI key generated by each user interacting with the extension, should be used for handling incoming webhooks and messaging apis. You ...Extension Installation Validator
The installation validator is triggered to validate the user before installing the extension. The validator is not configured by default. If the installation validator is not configured, users will be allowed to install the extension without ...Extension Properties
What are extension properties? Extension properties are values associated with the extension. They are quite similar to regular data properties, wherein you map a key of type string with a value string. The main purpose is to store data ...Extension APIs
These APIs fetch or set information related to the extension. Get extension config variable: Fetch the installation parameters of the extension. In production mode, only those parameters that have the value of the secure key set to false are ...Updating the Extension
Updating the Extension to the Marketplace If you come up with new features, enhancements to existing features, or bug fixes, you can update your extension to improve its functionality and performance. Each update increments the version of the ...
New to Zoho LandingPage?
Zoho LandingPage Resources