Customizing the Http Call widget

Last Updated:

Contact center admins can add and edit the Http Call widget. The Http Call widget allows you to request information from an external data source using HTTP. You can use standard HTTP request types (GET, POST, PUT, DELETE) and pass query parameters as part of HTTP request. Keys, secrets, and other credentials are hidden by default in Http Call widgets

Prerequisites for customizing the Http Call widget

Note: This feature requires knowledge of web development including HTTP requests. You also need access to a database that can accept HTTP requests. 

How to add and edit the Http Call widget

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click Contact Center Management then Flows.
  3. Click a flow's display name to edit it.
  4. In the left-side widgets panel, click and drag Http Call onto the preferred location in the flow.
  5. Select the Http Call widget.
  6. (Optional) Click Rename to change the display name of the widget.
  7. In the Settings tab, customize these settings.
    • URL: Specify request URL.
    • Method: Select a standard HTTP request type (GET, POST, PUT, PATCH, DELETE).
    • Allow retry request(s): Enable or disable HTTP retry attempts (1 to 3). For example, if you configured a GET request on an unstable or overloaded network. This setting specifies the number of times the GET request is attempted after failure. 
    • Content Type: Specify content type for request body (for example, JSON).
    • Body: Optional part of the HTTP request which is used to send additional data to the server.
    • Result: Specify variables that will be returned by the HTTP call. This field should be a semicolon separated list of top-level JSON keys returned by the API in the response body. The keys can then be referenced in subsequent text to speech prompts by referencing the widget name and the json key name that you configure in this field.
    • Custom Headers: Pass more information about the request so the server knows how to deal with the information. For example, you can pass an API key to connect to a database.
  8. Click the Exits tab to customize exit settings.
    • Success: Select the destination widget if the HTTP call succeeds.
    • Fail: Select the destination widget if the HTTP call fails.

Zoom Community

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