--- title: "Deploy Railway Assistant" description: "Send Railway alerts to Telegram & Slack with a lightweight service" category: "Observability" url: https://railway.com/deploy/railway-assistant --- # Deploy Railway Assistant Send Railway alerts to Telegram & Slack with a lightweight service **[Deploy Railway Assistant on Railway](https://railway.com/template/railway-assistant)** - **Creator:** bzvstudio - **Category:** Observability - **Total deploys:** 28 ## Template content ### railway-assistant https://devicons.railway.com/i/railway-light.svg - **Source:** https://github.com/bzvstudio/railway-assistant - **Health check:** /health - **Public domain:** Yes ## Documentation # Deploy and Host Railway Assistant on Railway Railway Assistant is a lightweight webhook relay that sends Railway deployment and project events directly to Telegram and Slack. It turns Railway webhooks into clean, readable notifications so you can monitor builds, failures, and releases without constantly checking the dashboard. Built in Go with zero external dependencies, it’s designed to be fast to deploy, cheap to run, and easy to configure. ## About Hosting Railway Assistant Hosting Railway Assistant means deploying a small stateless HTTP service that listens for Railway webhook events and forwards them to your preferred messaging platforms. After deployment, you connect your Railway project’s webhook to the service endpoint. From then on, deployments, failures, and runtime events are automatically formatted and pushed to your Telegram chat or Slack channel . The service is fully environment-variable driven — no database, no setup scripts, and no persistent storage required. Railway handles scaling and availability while the assistant focuses solely on event processing and notification delivery. ## Common Use Cases - Deployment Alerts — Know immediately when a deploy succeeds or fails. - Team Notifications — Share production activity automatically in a group chat or channel. - Release Visibility — Track branches, commits, and authors during active development. ## Dependencies for Railway Assistant Hosting - A Railway project with Webhooks enabled - For Telegram: A Bot (via BotFather) and a Chat ID - For Slack: A Workspace and an App with Incoming Webhooks enabled ### Deployment Dependencies - Railway Webhooks: https://docs.railway.app/reference/webhooks - Telegram Bot API: https://core.telegram.org/bots/api - Slack Incoming Webhooks: https://api.slack.com/messaging/webhooks ## Environment Variables Railway Assistant is configured entirely through environment variables. Most users only need the required variables — everything else controls message detail. ### Required Variables Variable When to Use Description `PORT` Railway default HTTP server port (Railway usually injects this automatically). Default: 8080. `TELEGRAM_ENABLED` If using Telegram Set to true to enable Telegram notifications. `SLACK_ENABLED` If using Slack Set to true to enable Slack notifications. ### Provider Specific (Required if enabled) Variable Description `TELEGRAM_BOT_TOKEN` Token provided by BotFather for your Telegram bot. `TELEGRAM_CHAT_ID` Chat or group ID where alerts will be delivered. `SLACK_WEBHOOK_URL` The Webhook URL provided by your Slack App. ### Message Customization (Optional) These control how much context appears in each notification. All default to true. Variable Use When Description `INCLUDE_WORKSPACE` Multi-project setups Shows workspace/project hierarchy. `INCLUDE_STATUS` Always recommended Displays deployment status (SUCCESS, FAILED, etc.). `INCLUDE_BRANCH` Active development teams Includes Git branch name. `INCLUDE_COMMIT` Release tracking Shows commit message. `INCLUDE_AUTHOR` Team environments Displays commit author. Disable fields if you want shorter or less noisy alerts. Example: `INCLUDE_COMMIT`=false `INCLUDE_AUTHOR`=false Useful for high-frequency deployment environments. ### Minimal Example Configuration # Telegram Only `TELEGRAM_ENABLED=true` `TELEGRAM_BOT_TOKEN=your_bot_token` `TELEGRAM_CHAT_ID=123456789` # Slack Only `SLACK_ENABLED=true` `SLACK_WEBHOOK_URL= https://hooks.slack.com/services/XXX/YYY/ZZZ` ## Implementation Details (Optional) Railway Assistant exposes a single webhook endpoint: POST /railway/alerts Railway sends event payloads → the service parses them → formats messages (Markdown for Telegram, Block Kit for Slack) → sends notifications via the respective APIs. ### Design goals - zero external dependencies - instant startup - minimal memory usage - production-safe defaults ## Roadmap Railway Assistant is intentionally small today, but planned improvements include: - Discord integration - Additional messaging platforms - Usage and deployment reports - Smarter alert filtering and routing - Team-level notification policies The goal is to evolve from a simple notifier into a lightweight Railway operations companion. ## Why Deploy Railway Assistant on Railway? Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it. By deploying Railway Assistant on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway. ## Similar templates - [Pyroscope profiling](https://railway.com/deploy/pyroscope-profiling) — Protected continuous profiling with durable Pyroscope storage. - [SigOnly](https://railway.com/deploy/sigonly) — Deploy SigNoz with a working demo app & config in one click - [Unwrapped Spotify Music Stats](https://railway.com/deploy/wide-bold) — Unwrapped Spotify Music Stats, Estatísticas de músicas disponíveis Open this page in a browser: https://railway.com/deploy/railway-assistant