Customizing the Connector widget in Zoom Virtual Agent

The Connector widget offers another way to connect with third-party APIs, alongside the HTTPCall and Script widgets. Key benefits include:

Stronger authentication: Supports OAuth and other methods not available in HTTPCall or easily implemented in Script.

Seamless integration: Works across multiple Zoom products through the Zoom App Marketplace.

While the Connector widget simplifies custom development with a low/no-code approach, it still requires a deep understanding of your use case, the third-party system you’re integrating with, and its API capabilities.

Requirements for customizing the Connector widget in Zoom Virtual Agent

Zoom Virtual Agent license

Account owner or admin privileges

Custom Connector app configured with at least one connector and route

How to add or edit the Connector widget

In the navigation menu, click AI Studio then Virtual Agents.

Click the display name of the chatbot you want to edit.

Click the Bot flows tab.

Click a flow's display name to edit it.

In the left-side widgets panel, click and drag Connector onto the preferred location in the flow.

Select the Connector widget.

(Optional) Click Rename to change the display name of the widget.

In the Setup tab, select the custom connector to use from the Connector Name dropdown.

Alternatively, click Create Connector to create a new marketplace connector in the Zoom App Marketplace.
After selecting the marketplace app, the system will display the available endpoints based on those configured for your app.

In the Route dropdown, select the appropriate endpoint to use within the selected custom connector.

Customize the associated settings and exits.

Connector widget settings

Once you've selected an endpoint, configure the required input and response parameters. Use global, custom, or local variables to define these parameters. You can capture values dynamically, such as:

Using the consumer’s ANI (Automatic Number Identification) in a voice flow.

Collecting user input to set variable values.

Mapping Input & Output

Input Mapping: Under Map input to, select a variable to pass data to the connector. This allows the connector to receive and process the data you pass into it.
When using a custom API endpoint where the marketplace connector can handle the response, the connector widget will automatically break down the response into separate fields. These fields can then be mapped to variables without needing a script module.

Output Mapping: Under Map output to, select a variable to store the response from the connector. This variable will hold the processed data and can be used later in the flow.

Connector widget exits

Customize how the flow handles different outcomes by clicking the Exits tab and configuring the following:

Success: Select the destination widget if the connection succeeds.

Fail: Select the destination widget if the connection fails.

This article applies to Zoom Virtual Agent classic chatbot. If you are using other Zoom Virtual Agent types, such as chat agent or voice agent, refer to their respective documentation for setup and channel deployment instructions.