Push Reply from Desk

Push Reply from Desk

When an agent replies from the desk for a ticket or thread created by channel integration, the reply is pushed to the Resources.channel.sync.push endpoint of the app which needs to be delivered to the external service so that the reply will be processed further. The push endpoint given in the manifest is responsible for handling the desk reply, delivering it to the external service and submit the status & response of the processed reply to the desk back.
The Progress of an agent reply from the desk for a ticket or thread created via channel integration are,
  1. Agent reply is added in the desk with status PENDING.
  2. Reply is pushed to the push_endpoint of the app.
Tip : To send the received agent reply to other service, you may need to call other service's APIs. Use Desk Invoke API to call the external service's API, so that authentications are handled automatically (e.g Using connections).

PUSH REQUEST FORMAT:
URL             :     channel.sync.push
RequestMethod   :     POST
QueryParams     :     securityContext, orgId
Content-Type    :     application/json
RequestBody     :     JSONObject containing reply & configParams in #PUSH_REPLY_PAYLOAD_FORMAT format.                         
                            
PUSH REQUEST RESPONSE FORMAT:
ResponseCode    : 200
Content-Type    : application/json
Response        : Data to be updated in desk in #PUSH_REPLY_RESPONSE_OBJECT format.

#PUSH_REPLY_PAYLOAD_FORMAT


Sample of #PUSH_REPLY_PAYLOAD_FORMAT:
  1. {
  2.     "configParams" :{
  3.         "channelState" : "{\"my_last_fetch_time\":\"Jan 11\"}",
  4.         "myConfigParam1" : "My value for configParam",
  5.         "myConfigParam2" : "My value for configParam2",
  6.         "myConfigParam3" : "My value for configParam3"
  7.     },
  8.     "resource":{
  9.         "extParentId"             : "1276576533",
  10.         "replyToExtId"            : "3298dniuniu3",
  11.         "id"                      : 287189379819,
  12.         "content"                 : "Hi customer, thanks for writing to us",
  13.         "summary"                 : "Hi customer, thanks for writing to us",
  14.         "contentType"             : "text/plain",
  15.         "hasAttach"               : false,
  16.         "attachments"             : [],
  17.         "author"                  : {
  18.             "name"      : "John Snow",
  19.             "email"     : "john.snow@example.com",
  20.             "type"      : "AGENT",
  21.             "photoURL"  : "https://desk.zoho.com/api/v1/agents/387829/photo?orgId=28732"
  22.          }
  23.     }
  24. }

#DESK_REPLY_THREAD_OBJECT


#PUSH_REPLY_RESPONSE_OBJECT



    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









                                                                                                      • Related Articles

                                                                                                      • Push-Data to Desk

                                                                                                        Whenever you need to manually push tickets & threads to the desk, you can use the following API. This API expects the payload in the #SYNC_RESPONSE_OBJECT format. To call desk's "channels/import" API, orgId and securityContext params are mandatory. ...
                                                                                                      • Pull Request from Desk

                                                                                                        Desk periodically invokes a request to the endpoint specified in the extension manifest's channel.sync.pull property. Pull requests are made every 4 minutes from the desk. You can send the new/ updated data of tickets and threads that needs to be ...
                                                                                                      • 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 ...
                                                                                                      • Quickstart to Zoho Desk Extensions

                                                                                                        At Zoho Desk, we believe in delivering good user experiences and making already good experiences better. In that vein, stepping into Zoho Marketplace is an effort towards achieving the latter goal. Zoho Marketplace is an online store where users can ...
                                                                                                      • Configuration

                                                                                                        Introduction Channel Integration lets you to sync data such as tickets, threads and contacts between Zoho Desk and External Services. It also lets the agents to send replies to the queries on external platforms directly from the desk. Channel ...
                                                                                                        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