๐ Telert CI Notifier - Deployable Template
April 29, 2025 ยท View on GitHub
Send instant notifications from your CI/CD pipelines to Telegram, Slack, Teams, Discord, Pushover, Desktop, or any custom HTTP endpoint using Telert.
๐ Features
- ๐ Send notifications on build completions, deployments, job status
- ๐ฌ Supports Telegram, Slack, Microsoft Teams, Discord, Pushover, Desktop, Audio alerts, and Custom Webhooks
- โก Lightweight and fast โ ideal for CI/CD workflows
- ๐ Easy deployment on Railway, Render, or Fly.io
โ๏ธ Quick Start
1. Deploy
Choose your platform:
or deploy manually using:
fly launch # For Fly.io
2. Configure
Set environment variables based on your provider:
Telegram
TELERT_PROVIDER=telegram
TELERT_TELEGRAM_TOKEN=your_bot_token
TELERT_TELEGRAM_CHAT_ID=your_chat_id
Slack
TELERT_PROVIDER=slack
TELERT_SLACK_WEBHOOK_URL=your_webhook_url
Microsoft Teams
TELERT_PROVIDER=teams
TELERT_TEAMS_WEBHOOK_URL=your_webhook_url
Discord
TELERT_PROVIDER=discord
TELERT_DISCORD_WEBHOOK_URL=your_webhook_url
TELERT_DISCORD_USERNAME=Custom Bot Name # (Optional)
TELERT_DISCORD_AVATAR_URL=https://example.com/avatar.png # (Optional)
Pushover
TELERT_PROVIDER=pushover
TELERT_PUSHOVER_TOKEN=your_app_token
TELERT_PUSHOVER_USER=your_user_key
Custom Endpoint
TELERT_PROVIDER=endpoint
TELERT_ENDPOINT_URL=https://your-webhook.url
TELERT_ENDPOINT_METHOD=POST # (Optional, default is POST)
TELERT_ENDPOINT_NAME=CustomName # (Optional)
TELERT_ENDPOINT_TIMEOUT=20 # (Optional, seconds)
3. Send a Notification
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "โ
Build completed!"}'
Specify a different provider for each message if needed:
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "โก Deployed!", "provider": "slack"}'
๐ CI/CD Integrations
GitHub Actions
- name: Notify on completion
run: |
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "โ
Build complete: ${{ github.repository }} (${{ github.sha }})"}'
Jenkins Pipeline
post {
success {
sh '''
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "โ
Jenkins build succeeded: ${JOB_NAME} #${BUILD_NUMBER}"}'
'''
}
failure {
sh '''
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "โ Jenkins build failed: ${JOB_NAME} #${BUILD_NUMBER}"}'
'''
}
}
CircleCI
- run:
name: "Notify on build complete"
command: |
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "๐ CircleCI build complete: ${CIRCLE_PROJECT_REPONAME} (${CIRCLE_SHA1})"}'
๐ฏ Advanced Usage
- Multiple Providers: Pre-configure multiple providers and choose dynamically when sending a notification.
- Form Data Support: Instead of JSON:
curl -X POST https://your-deployment-url/send \
-d "message=Build complete!&provider=telegram"
๐ Deploy Manually on Fly.io
- Install CLI:
curl -L https://fly.io/install.sh | sh - Authenticate:
fly auth signup fly auth login - Launch:
fly launch fly deploy
๐ก VPS Credits for Your Projects
โค๏ธ Support This Project
- โญ Star the GitHub Repo
- ๐ ๏ธ Open issues, contribute PRs
- โ Buy me a coffee
๐ Quick Visual Demo
curl -X POST https://your-deployment-url/send \
-H "Content-Type: application/json" \
-d '{"message": "๐ Your build is ready!"}'
โจ Happy Notifying with Telert!
๐ข
Would you also want me to prepare a version with small badges (like GitHub stars/downloads) if you want to make it even more eye-catching for Product Hunt or GitHub Marketplace?
(Only takes me another 2 minutes if you want!)
Would you like that as well? ๐
If yes, I'll send that next! โ