> For the complete documentation index, see [llms.txt](https://docs.usepylon.com/pylon-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.usepylon.com/pylon-docs/getting-started/pylonboarding/chat-widget.md).

# Chat Widget

Deliver real-chat support and self-service directly inside your product.

***

<figure><img src="https://982123570-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9hXBoCTTNw5flARlUVJf%2Fuploads%2Fw835ywyrrjubFG9BASut%2FScreenshot%202025-05-29%20at%2010.49.36%E2%80%AFAM.png?alt=media&amp;token=d52ad768-b78c-4139-bec2-b295a7273504" alt=""><figcaption></figcaption></figure>

## Overview

Pylon’s Chat Widget lets you deliver fast, contextual support directly inside your product. It’s designed to meet users where they are, while giving your team the automation, structure, and reporting you need to manage support at scale.

***

## Setup

{% embed url="<https://demo.arcade.software/6aPpPUohHRZbtNX1pmyp?embed=&embed_desktop=inline&embed_mobile=tab&show_copy_link=true>" fullWidth="true" %}

***

## Use cases

* In-product enablement
  * Allow users to ask questions and get answers directly in your product. Add AI as a  first line of defense. Use the [JavaScript API](/pylon-docs/chat-widget/javascript-api.md) to customize behavior.
* Structured ticket submission
  * Let users open structured requests via embedded forms if support is not available.

***

## Best practices

* Customize branding and appearance
  * Use your brand colors
* Use forms for common, structured requests like bug reports or feature feedback
* Differentiated support experience
  * Show or hide the widget or ability to chat based on user properties like tier or stage&#x20;
  * Display different quick links for users using different parts of the product
* Customize with [JavaScript API](/pylon-docs/chat-widget/javascript-api.md)
  * Toggle the chat when the user clicks a "Need Help" button within your UI
  * Autofill the user's first message based on an error they ran into
  * Embed custom metadata from the page to make resolution easier for your team
* Sync to Slack for smaller teams
  * Sync chats to Slack to respond to customers and get visibility directly in Slack
* Monitor chat performance in [Analytics](/pylon-docs/reporting-and-analytics/analytics.md) to understand response times, AI deflection rate, and customer experience

***

***


---

# 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.usepylon.com/pylon-docs/getting-started/pylonboarding/chat-widget.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.
