Customizing the Script widget for Zoom Virtual Agent

Last Updated:

Zoom Virtual Agent admins can add and edit the Script widget. The Script widget allows the bot to build actions using Javascript so that you don't need to rely on the UI to build flows. You can look for IDs, names, details on the site, or in an API. The results can be set in variables that can be stated back to the user.

Prerequisites for customizing the Script widget

  • Account owner or admin privileges; or relevant role/privilege
  • Basic, Pro, Business, Education, or Enterprise account
  • Zoom Virtual Agent license
  • Advanced knowledge of Javascript
  • Bot Flow created

How to edit the Script widget

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click AI Management and then Virtual Agents.
  3. Click the display name of an existing chatbot.
  4. Click the Bot Flows tab.
  5. Click the display name of an existing bot flow.
  6. In the left-side widgets panel, click and drag Script onto the preferred location in the flow.
  7. Select the Script widget.
  8. (Optional) In the right-side panel, click Rename to change the display name of the widget.
  9. In the Settings tab, click Add Script to add a new script to the widget, then specify these options:
    • Name: Enter an internal display name to help identify the script.
    • Language: Select the scripting language.
  10. Click Add.
  11. Enter your JavaScript code.
  12. To test your code locally, on the right side, use the Input Parameters panel to input parameters for the script in JSON format. Make sure to include the appropriate key/value pairs as required by your JavaScript code. When testing your code locally, you will need to provide all expected key/value pairs as Input Parameters.
  13. Click Run.
    The result will appear in the Results section.
  14. Click Close.
  15. (Optional) In the Settings tab, click these options:
    • Pencil icon : Edit the script.
    • Trash bin icon : Delete the script.
  16. Select a variable in the script_return_variable drop-down menu.
  17. Click the Exits tab.
  18. In the drop-down menu, select the destination widget.

Zoom Community

Join the 100K+ other members in the Zoom Community! Login with your Zoom account credentials and start collaborating.