Invoke APIs

Invoke APIs

Below are some extra APIs that you can use in your extension. 

  1. ROUTE_TO
  2. INSERT
  3. MODAL_CLOSE
  4. RESIZE

ROUTE_TO

This command navigates between the multiple subtabs on the ticket detail page. Listed below are the different routes supported:

  1. ticket.suggestedArticles
  2. ticket.timeline
  3. ticket.attachments
  4. ticket.history
  5. ticket.resolution
  6. ticket.approval
  7. ticket.task
  8. ticket.timeEntry
  9. ticket.conversation
  10. ticket.thread

Code format:
  1. ZOHODESK.invoke('ROUTE_TO','ticket.attachments')

Record Based Navigation
This API navigates to the detail view or edit form of the record whose ID is specified in the request:


Code format:
  1. ZOHODESK.invoke('ROUTE_TO',{entity: 'ticket', page:'edit', id: '271540000009314019'})

This API closes the modal that is currently opened.  

Code format:
  1. ZOHODESK.invoke('MODAL_CLOSE') 

RESIZE

This API resizes the widget.
  1. For all Right Panel widgets only the height gets resized according to the content and it has default max height.
  2. For desk.extension.telephony location, only the width gets resized with the specified width.
  3. For modal box widget, the width and height gets resized with the specified width and height.
  4. width and heignt in px also supported.

Code format: (without width and height specified)
  1. ZOHODESK.invoke('RESIZE') 

Code format:
  1. ZOHODESK.invoke('RESIZE', {width: '40%', height: '50%'})


    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 CRM Training
      Redefine the way you work
      with Zoho Workplace

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

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                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.




                                    Manage your brands on social media

                                      Zoho Desk Resources

                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                        Zoho Marketing Automation

                                          Zoho Sheet Resources

                                           

                                              Zoho Forms Resources


                                                Secure your business
                                                communication with Zoho Mail


                                                Mail on the move with
                                                Zoho Mail mobile application

                                                  Stay on top of your schedule
                                                  at all times


                                                  Carry your calendar with you
                                                  Anytime, anywhere




                                                        Zoho Sign Resources

                                                          Sign, Paperless!

                                                          Sign and send business documents on the go!

                                                          Get Started Now




                                                                  Zoho TeamInbox Resources



                                                                          Zoho DataPrep Resources



                                                                            Zoho DataPrep Demo

                                                                            Get a personalized demo or POC

                                                                            REGISTER NOW


                                                                              Design. Discuss. Deliver.

                                                                              Create visually engaging stories with Zoho Show.

                                                                              Get Started Now







                                                                                            You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

                                                                                            You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.



                                                                                                  • Related Articles

                                                                                                  • Desk Invoke API

                                                                                                    Desk's invoke API acts as a proxy between the extension and the External Services or Desk for calling the APIs. With Desk Invoke API, Can access the Zoho Desk's APIs Can access the External Services's APIs Can access the Extension Data Specific APIs ...
                                                                                                  • Invoke Connector Task

                                                                                                    This guide will help you with the following:       1. Syntax       2. Example After a connector is published and associated with an extension or vertical solution, it can be invoked whenever necessary. You can invoke a connector using a custom ...
                                                                                                  • 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 ...
                                                                                                  • 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 ...
                                                                                                  • 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 ...
                                                                                                    Wherever you are is as good as
                                                                                                    your workplace

                                                                                                      Resources

                                                                                                      Videos

                                                                                                      Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                      eBooks

                                                                                                      Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                      Webinars

                                                                                                      Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                      CRM Tips

                                                                                                      Make the most of Zoho CRM with these useful tips.



                                                                                                        Zoho Show Resources