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 returned. In development mode, all parameters are returned, irrespective of the value of the secure key.
Request:
- ZOHODESK.get("extension.config").then(function(response){
- // response returns the installation parameters of the extension
- }).catch(function(err){
- // error handling
- })
Response:
- {
- "extension.config": [
- {
- "name": "apikey",
- "mandatory": true,
- "type": "text",
- "value": "apikey",
- "userdefined": true,
- "secure": true,
- "default": "TestData"
- }
- ],
- "status": "success"
- }
Set value for extension config variable: Dynamically sets the value for a config variable defined in the plugin manifest file. New config variables cannot be defined using this API.
Request:
- ZOHODESK.set('extension.config', {name : 'test', value : "value"}).then(function(res){
- //response returns the value saved
- }).catch(function(err){
- })
Response:
- {
- extension.config: {
- "data": [
- {
- "userDefined": false,
- "name": "test",
- "options": "[]",
- "secure": false,
- "mandatory": false,
- "value": "value",
- "varId": "12345678901234567"
- }
- ]
- },
- status: "success"
- }
Get extension configured departments: This API fetches the departments configured for the extension on installation.
Request:
- ZOHODESK.get("extension.departments").then(function(response){
- // response returns the department configured of the extension
- }).catch(function(err){
- // error handling
- })
Response:
- {
- "extension.departments": [{
- "name": "departmentName",
- "id": "1234567"
- }],
- "status": "success"
- }
Get extension configured profiles: This API fetches the profiles configured for the extension on installation.
Request:
- ZOHODESK.get("extension.profiles").then(function(response){
- // response returns the profiles configured of the extension
- }).catch(function(err){
- // error handling
- })
Response:
- {
- "extension.profiles": [
- {
- "name": "Support Manager",
- "id": "1234567890"
- },
- {
- "name": "Newbie Agent",
- "id": "1234567890"
- },
- {
- "name": "Administrator",
- "id": "1234567890"
- },
- {
- "name": "Standard",
- "id": "1234567890"
- }
- ],
- "status": "success"
- }
Get extension configured users: This API fetches the users configured for the extension on installation.
Request:
- ZOHODESK.get("extension.users").then(function(response){
- // response returns the users configured of the extension
- }).catch(function(err){
- // error handling
- })
Response:
- {
- "extension.users": [
- "1234567890",
- "0987654321"
- ],
- "status": "success"
- }
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:
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 Log APIs
Extensions can make use of Log API to log the extension processes. Logs can be viewed on customer's support portal. Logs will expire after 3days. Path to Logs: Parent Logs: SubLogs List: During development, logs are loaded in the developer's portal. ...Invoke APIs
Below are some extra APIs that you can use in your extension. ROUTE_TO INSERT MODAL_CLOSE RESIZE ROUTE_TO This command navigates between the multiple subtabs on the ticket detail page. Listed below are the different routes supported: ...Data APIs
Zoho Desk provides a set of APIs that facilitate interaction between your extension and your help desk portal. The APIs available are listed below: Ticket Object Contact Object Account Object Current Call Object User Object Portal Object Department ...Event APIs
The following APIs help you incorporate custom functionalities in your extension when certain events occur in your help desk portal. Ticket Events You can configure extensions to receive information when an event, such as adding a comment to a ticket ...Data Storage APIs
Sometimes, the extensions you create might require data storage and retrieval capabilities. To help you in such cases, we provide a data store for extensions to set (store) and get (retrieve) data. The data can be deleted when it is no longer ...
New to Zoho LandingPage?
Zoho LandingPage Resources