Skip to main content

Telegram

The telegram trigger delivers container update alerts directly to Telegram chats, groups, or channels via Telegram Bot API.

⚙️ Configuration Variables​

WUD_TRIGGER_TELEGRAM_{trigger_name}_BOTTOKEN
Requiredstring

Telegram Bot API HTTP access token

Allowed values:Bot token from `@BotFather`
WUD_TRIGGER_TELEGRAM_{trigger_name}_CHATID
Requiredstring

Target Telegram chat ID or channel username

Allowed values:Numeric chat ID (e.g. `987654321`) or `@channelusername`
WUD_TRIGGER_TELEGRAM_{trigger_name}_DISABLETITLE
Optionalbooleandefault: false

Disable the default title heading to allow full custom message formatting

WUD_TRIGGER_TELEGRAM_{trigger_name}_MESSAGEFORMAT
Optionalenumdefault: Markdown

Message formatting parse mode

Allowed values:`Markdown`, `HTML`
WUD_TRIGGER_TELEGRAM_{trigger_name}_PROXY
Optionalurl

Route Telegram API calls through a dedicated SOCKS5/HTTP proxy

Allowed values:`socks5://user:pass@host:1080`, `http://user:pass@host:8118`
info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

🚀 Examples​

Basic Telegram Notification​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_TELEGRAM_LOCAL_BOTTOKEN=123456789:AApFzFLD0g0NVg8l0bZf55ex3sajC4Aw84Q
      - WUD_TRIGGER_TELEGRAM_LOCAL_CHATID=987654321

📖 Setup Guide​

1. Create a Bot & Obtain a Bot Token​

  1. Open Telegram and start a chat with @BotFather.
  2. Send /newbot and follow the prompts to choose a bot name and username.
  3. Copy the HTTP API token provided by BotFather into WUD_TRIGGER_TELEGRAM_{trigger_name}_BOTTOKEN.

2. Find Your Chat ID​

  1. Send a message to your newly created bot or add it to your target group.
  2. Start a chat with @userinfobot or @GetIDsBot to see your numeric Chat ID.
  3. Set your Chat ID as WUD_TRIGGER_TELEGRAM_{trigger_name}_CHATID.