Return types in Widgets

Return types in Widgets

Widgets in Zoho SalesIQ help you display different categories of essential information required for operators right inside their live chat window. These widgets can be built either using Deluge or using Webhooks. There are 5 different widget return types and they are listed below. 

The response of the Detail Handler must always be of the type widget_detail and based on this response, the widget will be rendered. This contains the entire structure of the widget. 

Parameters:
  1. type - Type of response 
  2. sections - List of sections 

The return type of the action handler has to be section_navigate if the action type was navigate when the action handler was invoked. 

Parameters:
  1. type - Type of response - should be section_navigate
  2. section - Section that has to be shown upon navigation
  3. failure_banner - Text to be displayed on the banner if the action was a failure
  4. refresh_section - If true, the action handler will be invoked with the action type as navigate_back while navigating back, otherwise the initial data will be shown.

It is one of the response types of the action handler. This response type contains a list of existing sections that have to be edited. This can have a success/failure banner.

Parameters:
  1. type - Type of response 
  2. sections - List of sections that has to be updated in the widget
  3. success_banner - Text to be displayed on the banner if the action was a success
  4. failure_banner - Text to be displayed on the banner if the action was a failure

It is one of the return types of the action handler. This return type can be used to display a success/failure banner based on whether the action performed was successful or a failure. There will be no changes to the widget in this case.

Parameters:
  1. type - Type of response
  2. status - Status of the action performed (success/failure)
  3. text - Text to be displayed in the banner

It is one of the return types of the action handler. If there is a need to collect data from the person accessing the widget (i.e, operators in SalesIQ), this return type can be used. The data collected in the form will be controlled by the form controllers. Learn more.

Parameters:
  1. name - Name of the form.
  2. action - Details of the action that was performed.  
  3. type - Type of action that has to be performed
  4. hint - Hint that will be displayed in the form near the form title
  5. trigger_on_cancel - Whether to invoke the form's submit handler when the form is cancelled without submission
  6. inputs - List of inputs to be displayed in the form to collect data
  7. mandatory
  8. placeholder
  9. button_label - If the "Submit" text of the form is to be replaced with a custom text, this can be used
  10. title - The title of the form that is displayed in the form's header

Related Posts:
To learn more about Widgets, check out our Help Documentation.

Regards,
Michelle





                            Zoho Desk Resources

                            • Desk Community Learning Series


                            • Digest


                            • Functions


                            • Meetups


                            • Kbase


                            • Resources


                            • Glossary


                            • Desk Marketplace


                            • MVP Corner


                            • Word of the Day



                                Zoho Marketing Automation


                                        Manage your brands on social media



                                              Zoho TeamInbox Resources

                                                Zoho DataPrep Resources



                                                  Zoho CRM Plus Resources

                                                    Zoho Books Resources


                                                      Zoho Subscriptions Resources

                                                        Zoho Projects Resources


                                                          Zoho Sprints Resources


                                                            Qntrl Resources


                                                              Zoho Creator Resources


                                                                Zoho WorkDrive Resources



                                                                  Zoho Campaigns Resources

                                                                    Zoho CRM Resources

                                                                    • CRM Community Learning Series

                                                                      CRM Community Learning Series


                                                                    • Tips

                                                                      Tips

                                                                    • Functions

                                                                      Functions

                                                                    • Meetups

                                                                      Meetups

                                                                    • Kbase

                                                                      Kbase

                                                                    • Resources

                                                                      Resources

                                                                    • Digest

                                                                      Digest

                                                                    • CRM Marketplace

                                                                      CRM Marketplace

                                                                    • MVP Corner

                                                                      MVP Corner

                                                                    





                                                                    




                                                                        Design. Discuss. Deliver.

                                                                        Create visually engaging stories with Zoho Show.

                                                                        Get Started Now