Easily integrate custom Telegram notifications into your CircleCI projects.
Learn more about Orbs.
Example config:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
build:
docker:
- image: <docker image>
steps:
- telegram/<command>
Notify a Telegram channel with a custom message at any point in a job with this custom step.
Parameter | Type | Default | Description |
---|---|---|---|
message |
string |
Message from CircleCI. | Enter a custom message. |
telegram-bot-token |
env_var_name |
TELEGRAM_BOT_TOKEN | Name of environment variable storing your Telegram bot token |
telegram-chat-id |
env_var_name |
TELEGRAM_CHAT_ID | Name of environment variable storing your Telegram chat id |
parse_mode |
string |
none | Use Markdown or HTML , if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
disable_notification |
boolean |
none | Sends the message silently. Users will receive a notification with no sound. |
Example:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
build:
docker:
- image: <docker image>
steps:
- telegram/notify:
message: "Notification from CircleCI!"
A simple method for testing your bot's auth token. Returns basic information about the bot in form of a User object.
Parameter | Type | Default | Description |
---|---|---|---|
telegram-bot-token |
env_var_name |
TELEGRAM_BOT_TOKEN | Name of environment variable storing your Telegram bot token |
Example:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
build:
docker:
- image: <docker image>
steps:
- telegram/getme
A command which sends an animated image to the specified Telegram chat.
Parameter | Type | Default | Description |
---|---|---|---|
telegram-bot-token |
env_var_name |
TELEGRAM_BOT_TOKEN | Name of environment variable storing your Telegram bot token |
telegram-chat-id |
env_var_name |
TELEGRAM_CHAT_ID | Name of environment variable storing your Telegram chat id |
gif-url |
string |
Enter the image's URL |
Example:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
build:
docker:
- image: <docker image>
steps:
- telegram/sendgif:
- gif-url: "https://www.example.com/img.gif"
A command which sends an image to the specified Telegram chat.
Parameter | Type | Default | Description |
---|---|---|---|
telegram-bot-token |
env_var_name |
TELEGRAM_BOT_TOKEN | Name of environment variable storing your Telegram bot token |
telegram-chat-id |
env_var_name |
TELEGRAM_CHAT_ID | Name of environment variable storing your Telegram chat id |
image-url |
string |
Enter the image's URL |
Example:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
build:
docker:
- image: <docker image>
steps:
- telegram/sendphoto:
- image-url: "https://www.example.com/img.jpg"
Notify a Telegram channel.
Parameter | Type | Default | Description |
---|---|---|---|
message |
string |
Job Message from CircleCI! | Enter a custom message. |
telegram-bot-token |
env_var_name |
TELEGRAM_BOT_TOKEN | Name of environment variable storing your Telegram bot token |
telegram-chat-id |
env_var_name |
TELEGRAM_CHAT_ID | Name of environment variable storing your Telegram chat id |
parse_mode |
string |
none | Use Markdown or HTML , if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
disable_notification |
boolean |
none | Sends the message silently. Users will receive a notification with no sound. |
Example:
version: 2.1
orbs:
telegram: woltsu/[email protected]
jobs:
- telegram/notify:
message: "Notification from CircleCI!"
https://core.telegram.org/bots
https://stackoverflow.com/questions/32423837/telegram-bot-how-to-get-a-group-chat-id
In the settings page for your project on CircleCI, click Environment Variables
. There you need to add 2 variables: TELEGRAM_BOT_TOKEN
and TELEGRAM_CHAT_ID
.