appleboy/telegram-action is tracked by TopGit as an automation project, with 1.0k stars on GitHub, written primarily in Dockerfile. GitHub Action that sends a Telegram message.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Remove the message input to send the default message, which looks like:
appleboy/telegram-action/telegram message triggered by appleboy (push)
@v1 follows the latest v1.x release. Pin an exact version such as
appleboy/[email protected] if you want fully reproducible builds.
Setup
1. Create a Telegram bot
Talk to @BotFather in Telegram, send /newbot, and
follow the prompts. BotFather replies with the bot token — this is your
TELEGRAM_TOKEN secret. See the Telegram Bot API
for details.
2. Get the chat ID
First send any message to your bot (for a group or channel, add the bot as a
member and post a message there), then call:
Read the chat ID from result[].message.chat.id — this is your TELEGRAM_TO
secret.
A private chat ID is a positive number, e.g. 65382999.
A group / supergroup / channel ID is negative and usually starts with
-100, e.g. -1001234567890. Use the numeric ID; usernames like
@channelname are not supported.
If getUpdates returns an empty result, send a fresh message in the chat
and call it again.
Note: the "Error: Chat not found" error means the chat ID is wrong or the
bot has never been added to that chat. See also this
StackOverflow answer.
Send a message to a specific forum topic (thread):
- name: send message to forum topic
uses: appleboy/telegram-action@v1
with:
to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }}
message_thread_id: 42
message: Hello from GitHub Actions!
Send message using a custom proxy (supports http, https, and socks5),
like socks5://127.0.0.1:1080 or http://222.124.154.19:23500:
- name: send message using socks5 proxy URL
uses: appleboy/telegram-action@v1
with:
to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }}
socks5: "http://222.124.154.19:23500"
message: Send message from socks5 proxy URL.
Message formatting
With format: markdown the message is sent using Telegram's legacy
Markdown style.
Underscores are escaped automatically, but unbalanced *, `, or [
characters (for example in a commit message) make the Telegram API reject the
whole message with a "can't parse entities" error. For messages with
unpredictable content, prefer format: html or plain text (no format).
Template variables
The message and message_file inputs are rendered as templates: {{ ... }}
placeholders are replaced with values taken from the environment.
- name: send message with template variables
uses: appleboy/telegram-action@v1
with:
to: ${{ secrets.TELEGRAM_TO }}
token: ${{ secrets.TELEGRAM_TOKEN }}
message: |
Commit {{ commit.sha }} on {{ commit.ref }}
triggered by {{ repo.namespace }}
How active is development on appleboy/telegram-action?
The most recent commit recorded on appleboy/telegram-action was 16 days ago, based on the GitHub push timestamp. The repository has 129 forks — one of the better signals of community interest.
How many stars does appleboy/telegram-action have?
appleboy/telegram-action has 1.0k GitHub stars — refresh the page for the live number, or check github.com/appleboy/telegram-action. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is appleboy/telegram-action open source?
Yes — appleboy/telegram-action ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/appleboy/telegram-action.
What else is in the Automation space?
appleboy/telegram-action is tracked by TopGit under the Automation category, alongside 3 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What topics is appleboy/telegram-action associated with?
GitHub's repository topics for appleboy/telegram-action: "github-actions", "telegram", "telegram-bot". TopGit's editorial category is Automation.
Where can I see appleboy/telegram-action in action?
The project maintains a homepage at https://github.com/marketplace/actions/telegram-message-notify. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about appleboy/telegram-action?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/appleboy/telegram-action is the definitive source.
Read full README in the tab above.
Curious whether telegram-action is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about telegram-action.