> For the complete documentation index, see [llms.txt](https://docs.kickbot.com/dashboard/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kickbot.com/dashboard/api/reference/chat_alerts.md).

# Chat alerts

KickBot API and MCP reference for Chat alerts. Messages KickBot posts in chat for subs, gifts, follows, and Kicks.

Messages KickBot posts in chat for subs, gifts, follows, and Kicks. MCP area name: `chat_alerts`.

| Tool                                                        | REST                          | Access |
| ----------------------------------------------------------- | ----------------------------- | ------ |
| [`get_chat_alert_settings`](#get-chat-alert-settings)       | `GET /chat-alerts/settings`   | Read   |
| [`update_chat_alert_settings`](#update-chat-alert-settings) | `PATCH /chat-alerts/settings` | Write  |

## get\_chat\_alert\_settings

**Get the chat alert settings.** Read the chat messages KickBot posts for subs, gifted subs, follows, and KICKs: on/off, text, and minimum amounts.

`GET /api/v1/chat-alerts/settings`

No input fields.

## update\_chat\_alert\_settings

**Update the chat alert settings.** Change some chat alert settings. Only the fields you send change. Requires a verified account.

`PATCH /api/v1/chat-alerts/settings`

Needs a read and write key or connection.

| Field                         | Type    | Required | Description                                                                                                                               |
| ----------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `sub_alert_enabled`           | boolean | No       | Post a chat message for new subscriptions and resubs.                                                                                     |
| `sub_alert_text`              | string  | No       | Message for subs. Variables: {{username}}, {{months}}. Default "@{{username}} has subbed for {{months}}!". 15-300 characters.             |
| `gifted_sub_alert_enabled`    | boolean | No       | Post a chat message for gifted subs.                                                                                                      |
| `gifted_sub_alert_text`       | string  | No       | Message for gifted subs. Variables: {{username}}, {{sub\_count}}. Default "@{{username}} just gifted {{sub\_count}}!". 15-300 characters. |
| `gifted_sub_alert_min_amount` | integer | No       | Gifted subs: number of subs in one gift. Minimum before the alert is posted. 0 (default) posts every time.                                |
| `follow_alert_enabled`        | boolean | No       | Post a chat message for new followers.                                                                                                    |
| `follow_alert_text`           | string  | No       | Message for follows. Variable: {{username}}. Default "Thanks for the follow @{{username}}". 15-300 characters.                            |
| `kicks_alert_enabled`         | boolean | No       | Post a chat message when someone gifts KICKs.                                                                                             |
| `kicks_alert_text`            | string  | No       | Message for KICKs. Variables: {{username}}, {{amount}}. Default "@{{username}} just gifted {{amount}} KICKs!". 15-300 characters.         |
| `kicks_alert_min_amount`      | integer | No       | KICKs: number of KICKs in one gift. Minimum before the alert is posted. 0 (default) posts every time.                                     |

## Need help?

Email <support@kickbot.com> or ask in the `#support` channel on [Discord](https://discord.gg/MAg3gBbc89).


---

# 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.kickbot.com/dashboard/api/reference/chat_alerts.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.