> ## Documentation Index
> Fetch the complete documentation index at: https://chatbase.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Button: send customers a link button in chat

> Send customers a clickable button that links to any page you choose, right inside the conversation

The Custom Button Action lets your AI agent send a clickable link button to the customer when they ask about a specific topic. You choose the button text and the URL it opens, and the AI agent decides when the button is worth showing. It works on the Chat Bubble, Help Page, and Center Stage, and the link opens in a new browser tab.

> [card] Best for:
>
> Pointing customers to a pricing page, a booking form, a downloadable guide, or any destination that answers a question better than text does.

**Common Use Cases:**

* "What are your pricing plans?"
* "Where can I download the app?"
* "How do I contact sales?"

## How to create the Action

**1. Navigate to Actions**

Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select your AI agent. Click **Build > Actions** in the left sidebar.

![The Actions page in the Chatbase dashboard](https://mintcdn.com/chatbase/DIWSTyTSabxfVW3B/user-guides/chatbot/images/actions/actions-7.png?fit=max\&auto=format\&n=DIWSTyTSabxfVW3B\&q=85\&s=489fa0822ca69163d6b9cea2287a83a6)

**2. Create the Action**

Click **Create Action**, scroll down, and select **Custom Button**.

![Selecting Custom Button from the Action list](https://mintcdn.com/chatbase/DIWSTyTSabxfVW3B/user-guides/chatbot/images/actions/actions-7.1.png?fit=max\&auto=format\&n=DIWSTyTSabxfVW3B\&q=85\&s=0d26a2ff472ba1b40612ff05e7d0d8b9)

**3. Configure General Settings**

**Action Name:** A descriptive name for the Action, such as `Pricing_Page_Button`. The AI agent sees this name and uses it, together with **When to use**, to decide when to send the button. Names can contain only letters, numbers, underscores, and hyphens, with no spaces.

![The Action Name field for the Custom Button Action](https://mintcdn.com/chatbase/EhvCUQ4ZmSlhciUK/user-guides/chatbot/images/actions/actions-8.png?fit=max\&auto=format\&n=EhvCUQ4ZmSlhciUK\&q=85\&s=a72b26f403312cf9c3e423cf1cf2a055)

**When to use:** A detailed description explaining when the AI agent should send the button. Include examples of the customer queries it should answer.

To restrict the Action to [Procedure](https://chatbase.co/docs/user-guides/chatbot/procedures/procedures-overview.md) steps only, turn on [**Only use in Procedures**](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md#only-use-in-procedures). When it's on, the **When to use** field is hidden, because the AI agent no longer decides when to call the Action.

![The When to use field for the Custom Button Action](https://mintcdn.com/chatbase/EhvCUQ4ZmSlhciUK/user-guides/chatbot/images/actions/actions-8.1.png?fit=max\&auto=format\&n=EhvCUQ4ZmSlhciUK\&q=85\&s=7a4bac23d91ea33f4f88c31e235a8672)

**4. Configure the button**

**Button text:** The text shown on the button the customer sees.

![The Button text field](https://mintcdn.com/chatbase/EhvCUQ4ZmSlhciUK/user-guides/chatbot/images/actions/actions-9.png?fit=max\&auto=format\&n=EhvCUQ4ZmSlhciUK\&q=85\&s=92d1a6d87d34e61edb942fa6b506c806)

**URL:** The destination the button opens, in a new tab. It must be a full, valid URL, and it's sent exactly as entered. Variables aren't supported, but you can include fixed UTM parameters, for example `https://www.example.com/pricing?utm_source=chatbase`.

![The URL field for the Custom Button Action](https://mintcdn.com/chatbase/EhvCUQ4ZmSlhciUK/user-guides/chatbot/images/actions/actions-9.2.png?fit=max\&auto=format\&n=EhvCUQ4ZmSlhciUK\&q=85\&s=cd298c7ca4ac2973e675024ea9810007)

**5. Choose Channels**

This Action is compatible with the **Chat Bubble**, **Help Page**, and **Center Stage** channels only. Every other channel is incompatible and can't be selected. Toggle it on or off for each configured channel. See [Channels](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md#channels) for what configured, unconfigured, and incompatible mean.

**6. Enable and Test**

Click **Enable** at the bottom of the page.

> [!TIP]
>
> Test the Action in the Playground before enabling it, to confirm the AI agent sends the button with the right URL when your instructions are met.

## Examples

A **When to use** description that tells the AI agent both what to say and when to attach the button:

```text theme={null}
Provide the user a button when they ask about the pricing plans, the difference
between any of Chatbase plans or the features available in each one. For example,
when the user asks about the number of AI agents in the Basic plan, you should
let them know that the plan offers 1 AI agent with up to 8 Actions and provide
the button of the pricing page.
```

![The AI agent sending a custom button in chat](https://mintcdn.com/chatbase/DIWSTyTSabxfVW3B/user-guides/chatbot/images/actions/actions-12.gif?s=8ed9cb55d268221d24a39be0d18813ce)

## How it works

* **The AI agent decides when to send it.** The Action has no inputs: when the AI agent calls it, the button appears below the reply with your **Button text**.
* **One button per Action.** The AI agent can call more than one Custom Button Action in a reply, and each shows its own button, but whether it does depends on your instructions.
* **Clicks aren't tracked.** The button is a plain link, and Chatbase doesn't record clicks. To measure them, add UTM parameters to the URL and track visits in your analytics tool.

## Best Practices

> [card] One Button, One Destination
>
> Each Action carries a single URL. If you need to link to several pages, create a separate Custom Button Action for each.

> [card] Answer First, Then Link
>
> Tell the AI agent to answer the question in text and attach the button as a next step, so the customer isn't sent away for information the AI agent already has.

> [card] Keep Button Text Short
>
> Use a few words that name the destination, such as **See pricing** or **Book a demo**.

> [card] Test Before Enabling
>
> Try the Action in the Playground and confirm the button appears for the queries you expect, and not for the ones you don't.

## Frequently asked questions

> [accordion] Does the button open in a new tab?
>
> Yes. The link always opens in a new browser tab, so the customer keeps the chat open.

> [accordion] Can the button URL include variables or UTM parameters?
>
> Fixed UTM parameters, yes: type them into the URL. Variables such as the customer's email aren't supported, because the URL is sent exactly as entered.

> [accordion] Does the Action name matter?
>
> Yes. The AI agent sees the Action name and uses it with **When to use** to decide when to send the button, so pick a name that describes the destination, such as `Pricing_Page_Button`.

> [accordion] Can I see how many customers clicked the button?
>
> No. Chatbase doesn't track button clicks. Add UTM parameters to the URL and measure visits in your own analytics.

> [accordion] Can I show the button on WhatsApp or Messenger?
>
> No. Custom Button works on the Chat Bubble, Help Page, and Center Stage only.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.