> For the complete documentation index, see [llms.txt](https://docs.blockbrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.blockbrain.ai/for-admins/web-components/website-web-component.md).

# Website Web Component

## Key Steps

### **Step 1: Choose Integration Mode**

<div><figure><img src="/files/02vDpZcdzPPsP8oM0VIb" alt=""><figcaption><p>Private Mode</p></figcaption></figure> <figure><img src="/files/JJ9pqSWqcoLclLVl8HfK" alt=""><figcaption><p>Public Mode</p></figcaption></figure></div>

* Decide between two integration modes:
  * **Public Mode**: No authentication required; all users can chat with the interface.
  * **Private Mode**: Requires user authentication; users must log in to access their conversation history.
* **Ping your Blockbrain Key Account Manager** that you want to add a webcomponent to your website.

&#x20;

### **Step 2: Prepare Your Website**

* **Add the necessary header script to your website.**

```
<script 
  type="module"
  src="https://assets.theblockbrain.io/scripts/blocky-chat/blocky-chat.bundle.js"
  async
></script>
```

* Ensure you have the following information ready:
  * **Organization ID**: Obtain from your Blockbrain key account or team member.
  * **Issuer URL**: This will be your company Blockbrain URL (e.g. <https://demo.kb.theblockbrain.ai/>).
  * **Webcomponent Bot UID**: The Id of a bot mapping created in the admin section of your Blockbrain. Needs to be added by an admin.

&#x20;

### **Step 3: Configure the Web Component**

<pre><code><strong>&#x3C;blockbrain-main 
</strong>  orgId="your-org-id"
  issuer="https://your-blockbrain-domain.com" 
  uid="your-webcomponent-bot-uid" 
  userUid="optional-user-id">
&#x3C;/blockbrain-main>
</code></pre>

* Set up the web component with the following parameters:
  * **Organization ID**: Insert your organization ID - retrieved from Blockbrain team.
  * **Issuer**: Insert the issuer URL - <https://your-blockbrain-domain.com>.
  * **UID**: Webcomponent Bot UID - e.g., CompanyGPT.
  * **User UID**: Not relevant for private and restricted bots, optional for public bots.

## Private Mode

### **Step 4: Setup Authentication**

<pre><code><strong>&#x3C;blockbrain-main 
</strong>  orgId="your-org-id"
  issuer="https://your-blockbrain-domain.com" 
  uid="your-webcomponent-bot-uid" 
&#x3C;/blockbrain-main>
</code></pre>

* If using private mode, **ensure the issuer is included** in the configuration.
* Remove the userUid, that is only for public mode.
* Test the login functionality:
  * Click the login button to trigger the OAuth authentication.
  * Verify that you can access your conversation history.

&#x20;

## Public Mode

### **Step 5: Use Public Mode**

<pre><code><strong>&#x3C;blockbrain-main 
</strong>  orgId="your-org-id"
  uid="your-webcomponent-bot-uid" 
  userUid="optional-user-id">
&#x3C;/blockbrain-main>
</code></pre>

* To switch to public mode, **remove the issuer from the configuration**.
* Ensure the organization ID and company UID are still included.
* Remove the userUid if not needed, it can be used to distinguish users.
* Test the public chat functionality to confirm it works without authentication.

## Video

{% embed url="<https://drive.google.com/file/d/17ShFDF5fo68n6PTK7lRI25jkmszpI8G-/view?usp=sharing>" %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.blockbrain.ai/for-admins/web-components/website-web-component.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.