Skip to content
Convor
Convor Docs
API

Realtime Updates

Use Convor realtime through the hosted widget, dashboard, browser events, and outbound webhooks.

Convor's hosted widget and operator dashboard manage their realtime connections automatically. Customer integrations do not need to configure transport hosts, tokens, or subscription details.

Browser events

Use window.Convor when your application needs to react to widget activity on the same page.

Convor.on("open", () => {
  console.log("Chat opened");
});

Convor.on("unread:change", ({count}) => {
  updateUnreadBadge(count);
});

Convor.on("message:received", (message) => {
  console.log(message.id);
});

See the Widget JavaScript API for the supported event names and payloads.

Server-side events

If your backend needs to react to Convor events, configure an outbound webhook. Webhooks are the supported server-to-server event surface and can be independently authenticated, retried, and monitored.

Use the customer REST API when your backend needs to read or change Convor resources on demand.

Connection problems

If chat stops updating in one browser:

  1. Reload the page and confirm the standard widget.js embed is present only once.
  2. Check whether a browser extension, corporate proxy, firewall, or Content Security Policy is blocking Convor network requests.
  3. Confirm the current hostname is allowed for the selected site.
  4. Reproduce the problem in a clean browser profile before changing the embed.
  5. When contacting support, include the page URL, approximate time, browser, and any Convor correlation ID shown in an error response. Do not send API keys or identity secrets.

Do not work around a connection problem by adding API, iframe, or WebSocket addresses to the production widget tag. Those endpoints are owned by the hosted widget build.

Was this page helpful?

On this page