Skip to main content
The telegram-bot addon sends instant push notifications to a Telegram chat whenever key payment events occur. This is faster than email and ideal for operators who want real-time alerts on their phone.
You need a Telegram Bot API token and a target chat ID before configuring this addon. Both are free to obtain.

​
Prerequisites

  1. Open Telegram and message @BotFather
  2. Send /newbot and follow the prompts to create your bot
  3. Copy the Bot API Token BotFather gives you
  4. Add your bot to a group or channel, or start a direct chat with it
  5. Send a message in that chat, then visit https://api.telegram.org/bot<TOKEN>/getUpdates to find your chat ID

​
Install and configure

1
Install the telegram-bot addon. See Addons for installation instructions.
2
Go to System > Addons, find Telegram Bot, and click Settings.
3
Enter your Bot API Token and Chat ID in the fields provided.
4
Toggle Active and select which brands should send Telegram notifications.
5
Click Save. A test message is sent to confirm the connection.

​
Supported events

The Telegram bot sends notifications for these events:
  • payment.completed - Payment received successfully
  • payment.failed - Payment attempt failed
  • refund.issued - Refund processed
Each notification includes the transaction amount, currency, gateway name, customer email (partial), and a link to the transaction in the admin panel.
Transaction amounts and partial customer identifiers are visible in Telegram messages. Only add the bot to private chats or trusted team groups. Avoid public channels.

​
Troubleshooting

  • Addons - Install and manage addons including telegram-bot
  • Email Notifications - Alternative notification channel via SMTP
  • Companion App - Android app for SMS-based verification and notifications
Last modified on August 25, 2026

Related topics

Email NotificationsAddonsIntegration Plugin DevelopmentAcknowledge Push NotificationsList Companion App Notifications