> For the complete documentation index, see [llms.txt](https://docs.guestway.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.guestway.io/inbox-and-messaging/how-to-add-the-chat-widget-to-your-website.md).

# How to add the chat widget to your website

This guide shows you how to put the Guestway chat on your website, so visitors can write to you and their messages arrive in the inbox.

{% hint style="info" %}
**Before you start**

* You need a default branding profile. The widget takes your company name and colour from it. See [Branding](https://docs.guestway.io/guest-experience/branding.md).
* You need access to the code of your website, or someone who can change it.
  {% endhint %}

## Set up the widget

{% stepper %}
{% step %}

### Open the chat widget settings

Go to **Settings** → **Chat Widget**.
{% endstep %}

{% step %}

### Choose the name and colour

By default, the widget uses the company name and the main colour of your default branding.

If the widget needs another name or colour, select **Override default branding**. Enter the **Company Name** and the **Theme Color**.
{% endstep %}

{% step %}

### Choose the language

In **Language**, select **Auto-detect** to show the widget in the language of the visitor's browser. To always use one language, select **Fixed language** and pick it.

The widget is available in Deutsch, English, Español, Français, Italiano, Nederlands, Português and Русский.
{% endstep %}

{% step %}

### Check the preview

**Live preview** shows the widget on a sample website. Check the name, the colour and the chat button.
{% endstep %}
{% endstepper %}

## Add the code to your website

{% stepper %}
{% step %}

### Copy the code

In **Install code**, click **Copy code**.

If you change the name, colour or language later, copy the code again and replace it on your website.
{% endstep %}

{% step %}

### Paste it in your website

Paste the code in the `<head>` tag of your website, on every page where the chat should show. Publish the change.

{% hint style="warning" %}
Do not reset the **API Key** after you install the widget. The code on your website then stops working, and you must install the new code.
{% endhint %}
{% endstep %}

{% step %}

### Test the chat

Open your website and send a message in the chat. It arrives in the **Inbox** as a **Website Chat** conversation.

If you cannot answer it, check that **Website Chat** is on in **Settings** → **Inbox** → **Allowed Message Mediums**. See [Inbox](https://docs.guestway.io/inbox-and-messaging/inbox.md).
{% endstep %}
{% endstepper %}

## Related

* [Unified AI inbox](https://docs.guestway.io/inbox-and-messaging/unified-ai-inbox.md): website chat conversations and the **Website chat** filter
* [Inbox](https://docs.guestway.io/inbox-and-messaging/inbox.md)
* [Branding](https://docs.guestway.io/guest-experience/branding.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.guestway.io/inbox-and-messaging/how-to-add-the-chat-widget-to-your-website.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
