Skip to main content
A widget key is the unique identifier that connects the embed code on your website to a specific VozAgent assistant. Each assistant can have one widget key at a time. This article covers how to view your existing keys, understand their properties, and manage them when you need to make changes.

​
What Is a Widget Key?

A widget key is a public identifier (a long string of characters) that VozAgent generates when you create a widget. It’s embedded in the JavaScript snippet you place on your website. When a visitor opens the widget, the key tells VozAgent which assistant to connect them to and what mode (Chat, Voice, or Chat & Voice) to use. Widget keys are designed to be public — they’re visible in your website’s source code, and that’s fine. They only grant access to start a conversation with your assistant; they don’t expose any private account information.

​
Viewing Your Widget Keys

To see all your widget keys, navigate to Widgets in the dashboard sidebar. The Widgets page shows a card for each of your active assistants. For assistants that have a widget key, the card displays:
  • Mode badge — Shows whether the widget is set to Chat, Voice, or Chat & Voice.
  • Key preview — The first 12 characters of the public key, for quick identification.
To see the full key, click on the assistant’s card to open the widget detail view. The complete key is shown at the bottom of the Tracking Code tab.

​
Widget Key Properties

Each widget key has the following properties:
PropertyDescription
Public KeyThe unique identifier used in the embed code. This is what connects your website to your assistant.
ModeChat, Voice, or Chat & Voice. Determines how visitors interact with the widget.
Display NameThe name shown in the widget header (defaults to the assistant’s name).
Accent ColorThe theme color used for the widget header, buttons, and message bubbles.
Greeting MessageThe first message visitors see when they open the widget.
Primary GoalLead Capture & Qualification, or Customer Support & FAQs.
Inbox ModeFront Desk (lead capture) or Support Desk (customer support).
Booking EnabledWhether the assistant can schedule appointments through the widget.
Intake FieldsWhich information the assistant collects from visitors.
AvatarA custom image displayed in the widget header.
Active StatusWhether the key is currently active.
Created DateWhen the key was generated.
Last UsedWhen the key was last used for a conversation.
Most of these properties can be edited from the widget detail view. See Installing and Customizing Your Widget for details on each setting.

​
One Key Per Assistant

Each assistant can have only one widget key at a time. This keeps things simple — there’s a direct one-to-one relationship between an assistant and its widget. If you need different configurations for the same assistant (for example, different greeting messages for different pages), you would need to create separate assistants for each configuration.

​
Creating a Widget Key

If an assistant doesn’t have a widget key yet, its card on the Widgets page will show a Create button. Only admin users on the Growth plan or above can create widget keys.
  1. Click Create on the assistant’s card.
  2. VozAgent generates a key in Chat & Voice mode by default.
  3. The key is available immediately.
For detailed instructions, see Creating a Widget.

​
Updating Widget Settings

To update a widget key’s settings:
  1. Click on the assistant’s card on the Widgets page to open the widget detail view.
  2. Navigate to the appropriate tab (Appearance, Greeting & Behavior, Intake Questions, or Tracking Code).
  3. Make your changes.
  4. Click Save Changes.
Changes take effect immediately. You don’t need to update the embed code on your website — the same code will reflect the new settings.

​
Deleting a Widget Key

If you need to remove a widget entirely:
  1. Open the widget detail view by clicking on the assistant’s card.
  2. Click the trash icon in the top-right corner.
  3. A confirmation dialog will appear, warning that the embed code will stop working immediately.
  4. Click Delete to confirm.
What happens when you delete a key:
  • The embed code on your website immediately stops working. Visitors will no longer see the widget.
  • All widget settings (display name, accent color, greeting, intake fields, etc.) are removed.
  • Conversation history from the widget is not deleted — it remains in your inbox.
  • You can create a new widget key for the same assistant at any time, but it will be a fresh key with default settings.
Tip: Make sure to remove the embed code from your website after deleting a key. Leaving dead code on your site won’t cause errors, but it’s cleaner to remove it.

​
When to Delete and Recreate a Key

There are a few situations where deleting and recreating a key makes sense:
  • Switching modes — If you want to change from Chat to Voice mode (or vice versa), delete the existing key and create a new one.
  • Security concerns — If you believe your key has been compromised or is being used by unauthorized parties, deleting it immediately stops all access. Create a new key and update your embed code.
  • Starting fresh — If you’ve made many changes and want a clean slate with default settings.

​
Troubleshooting

The widget isn’t showing on my website. Make sure the embed code is placed before the closing </body> tag and that the widget key hasn’t been deleted. Check the browser’s developer console for any JavaScript errors. I updated the widget settings but visitors see the old version. Changes take effect immediately, but visitors with an active session may see cached settings. New visitors will always get the latest configuration. The Create button is missing. Only admin users can create widget keys. If you’re a standard user, ask your organization admin. If you’re an admin but still don’t see it, check that your plan includes widgets (Growth plan or above).