Installing and configuring the Copilot widget

Copilot is an AI chat assistant for your website. It answers visitors questions about your listings, searches your properties, explains how buying and renting work, collects contact details from interested visitors and emails your team a transcript of every conversation.

This article explains how to add the widget to your website and every configuration option. For controlling the chat from your own code, see Copilot JavaScript API and events. For what happens during and after a conversation, see How Copilot conversations work.

---

Installation

Add the following code to every page where the chat should appear, just before the closing </body> tag. Replace YOUR_WIDGET_TOKEN with the token you received from Estatebud.

<script>
  window.EstatebudCopilot = {
    token: 'YOUR_WIDGET_TOKEN'
  };
</script>
<script src="https://dev-widget.estatebud.com/embed.js" async></script>

The configuration object must be defined before embed.js loads. The script only creates the widget once per page, so including it twice does no harm.

Allowed domains

For security, the widget only loads on websites that have been registered for your token. Send Estatebud every hostname the widget should run on, for example example.com and www.example.com: hostnames only, without https:// or a path. If a domain is missing, the widget does not appear and the browser console shows:

[Copilot] Invalid domain: "www.example.com". Your domain name must be added to the list of allowed domains.

Single-page websites

Websites that change pages without a full reload (React, Vue, Next.js and similar) are supported automatically. The widget follows pushState, replaceState and the browser's back and forward buttons, so it always knows which page the visitor is on.

---

Configuration options

All options go in the window.EstatebudCopilot object.

Full example

<script>
  window.EstatebudCopilot = {
    token: 'YOUR_WIDGET_TOKEN',
    position: 'bottom_left',
    locale: 'en',
    i18n: {
      home_title: 'Welcome to Sunshine Estates! 👋',
      home_text: 'Ask us anything about our properties.'
    },
    inviteMessage: {
      text: '👋 Hi! Looking for a home in Paphos? I can help.',
      delay: 5000
    }
  };
</script>
<script src="https://dev-widget.estatebud.com/embed.js" async></script>

---

Invite message

An invite message is a short greeting that pops up next to the chat button to start a conversation. It is shown only when the visitor has no open conversation and the chat is closed. When the visitor opens the chat, the invite appears as the first message from the assistant.

You can also show an invite later from your own code, for example on a specific page or after the visitor scrolls. See the inviteMessage command in Copilot JavaScript API and events.

---

Languages and translation overrides

Interface languages

The widget interface (buttons, labels, placeholders and disclaimers) is available in 14 languages:

How the interface language is chosen:

1. The locale option, if it is set to one of the codes above.

2. Otherwise the visitor's browser language, if it is one of the codes above.

3. Otherwise English.

The conversation itself is not limited to these languages. The assistant always replies in the language the visitor writes in, whatever the interface language is.

Translation overrides

You can replace these interface texts with your own wording through the i18n option. Overrides apply in every language, so if your site has several languages, set them per page language.

Other keys are ignored. Example for a multilingual site:

<script>
  var lang = document.documentElement.lang || 'en';
  window.EstatebudCopilot = {
    token: 'YOUR_WIDGET_TOKEN',
    locale: lang,
    i18n: lang === 'el'
      ? { home_title: 'Καλώς ήρθατε! 👋', home_text: 'Πώς μπορούμε να σας βοηθήσουμε;' }
      : { home_title: 'Welcome! 👋', home_text: 'How can we help you today?' }
  };
</script>

---

Widget settings

These settings are stored with your widget by Estatebud, not in the embed code. Contact Estatebud to change them.

Approach

---

Troubleshooting