Skip to content
Convor
Convor Docs
Widget

Embedding the Widget

Install the Convor widget with the production embed code from your dashboard.

Copy the production snippet from Settings → Widget → Installation and security and place it before the closing </body> tag on every page where chat should be available.

<script
  src="https://cdn.convor.io/widget.js"
  data-key="convor_wpk_..."
  async
></script>

data-key is the public widget key for the selected site. It is expected to be visible in browser code and is not a secret organization API key.

The hosted widget.js build already knows the production API, iframe, and realtime endpoints. Do not copy those service addresses into the embed tag or maintain them in your application configuration.

What the embed code controls

The embed code identifies which Convor site configuration to load. Appearance, visitor-facing content, availability, pre-chat fields, triggers, and other widget settings are managed in the Convor dashboard and loaded when the widget starts.

If you change a widget setting in the dashboard, you do not need to replace the embed code.

Browser API

The same script exposes window.Convor for application integrations such as prefilling visitor data, identifying a signed-in customer, synchronizing SPA routes, opening or closing chat, and listening for widget events.

await Convor.ready();

await Convor.setUser({
  name: currentUser.name,
  email: currentUser.email,
});

See the Widget JavaScript API for the supported browser methods. Endpoint configuration is not part of the production browser integration contract.

Allowed domains

The widget loads only on domains allowed for the selected site. Add every production hostname that will embed the widget. Add localhost only while you are testing a local copy of your own site.

Was this page helpful?

On this page