Skip to content

navig-me/telert-notifier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Telert CI Notifier - Deployable Template

GitHub Stars PyPI version Downloads License Marketplace

Deploy on Railway Deploy to Render

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:

  • Deploy on Railway
  • Deploy to Render

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

  1. Install CLI:
    curl -L https://fly.io/install.sh | sh
  2. Authenticate:
    fly auth signup
    fly auth login
  3. Launch:
    fly launch
    fly deploy

πŸ’‘ VPS Credits for Your Projects


❀️ Support This Project


πŸ“‹ 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! βœ…

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published