Integrations
Telegram
Send pipeline notifications, cron results, and health alerts to Telegram.
Telegram
The Telegram integration delivers real-time notifications from GridWork HQ to a Telegram chat or group. Pipeline completions, cron job results, and system health alerts arrive directly in your Telegram.
What It Does
- Sends pipeline completion notifications with output summaries
- Reports cron job results (success or failure) after each scheduled run
- Delivers morning briefing summaries from the Friday Update pipeline
- Alerts on system health issues detected by the ops monitor
Setup
1. Create a Telegram Bot
- Open Telegram and search for @BotFather
- Send
/newbotand follow the prompts to create a bot - Copy the bot token (e.g.,
123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11)
2. Get Your Chat ID
- Add your new bot to a group, or start a direct chat with it
- Send a message to the bot
- Visit
https://api.telegram.org/bot<YOUR_TOKEN>/getUpdatesin your browser - Find the
chat.idvalue in the response
3. Add Environment Variables
Add these to your .env file:
TELEGRAM_BOT_TOKEN=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
TELEGRAM_CHAT_ID=-10012345678904. Restart the Pipeline Server
cd pipeline-server && bun run build && bun run startNotifications will start flowing to your Telegram chat automatically.
What Gets Sent
| Event | Message Content |
|---|---|
| Pipeline complete | Pipeline name, client, duration, output summary |
| Pipeline error | Pipeline name, error message, timestamp |
| Cron job complete | Job name, result status, next run time |
| Cron job failure | Job name, error details, timestamp |
| Health alert | Service name, issue description |
Without It
GridWork HQ works normally without Telegram. Pipeline results and cron logs are always available in the dashboard. Telegram just adds push notifications so you do not have to keep the dashboard open.