Skip to content

feat(docs): add guide for setting up Telegram bot notifications #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fassko merged 2 commits into from
Jan 9, 2025
Merged

feat(docs): add guide for setting up Telegram bot notifications #483

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be0511e
feat(docs): add guide for setting up Telegram bot notifications
fassko Jan 9, 2025
55a52da
fix(docs): format JSON example for Telegram bot configuration
fassko Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/fassets/guides/7-telegram-bot-notifications.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 6
slug: telegram-bot-notifications
title: Telegram Bot Notifications
description: Set up a Telegram bot to receive notifications
tags: [intermediate, fassets, bitcoin, dogecoin]
authors: [fassko]
keywords: [fassets, xrp, btc, doge flare-network, flare-network]
---

1. Get the API key from the [FAssets Telegram Bot](http://t.me/FlareFAssetsSongbirdBot) by sending `/events` and selecting `Subscribe to Events`.
2. Add the following configuration to the `apiNotifierConfigs` list in the `config.json` file, replacing `API_KEY` with the key obtained from the bot.

```json
{
"apiKey": "API_KEY",
"apiUrl": "https://fasset-tg-bot-songbird.flare.network",
"level": "danger"
}
```

:::info
Please note that notifications will only be sent out for **danger** and **critical** levels, regardless of the configured level. This is enforced by the Telegram bot, which ignores other events to prevent unnecessary HTTP requests.
:::
Loading