Telegram

{{< details >}}

• Tier: Free, Premium, Ultimate
• Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduced in GitLab 16.1.

{{< /history >}}

You can configure GitLab to send notifications to a Telegram chat or channel. To set up the Telegram integration, you must:

1. Create a Telegram bot.
2. Configure the Telegram bot.
3. Set up the Telegram integration in GitLab.

Create a Telegram bot

To create a bot in Telegram:

1. Start a new chat with @BotFather.
2. Create a new bot as described in the Telegram documentation.

When you create a bot, BotFather provides you with an API token. Keep this token secure as you need it to authenticate the bot in Telegram.

Configure the Telegram bot

To configure the bot in Telegram:

1. Add the bot as an administrator to a new or existing channel.
2. Assign the bot Post Messages rights to receive events.
3. Create an identifier for the channel.
   • For public channels, enter a public link and copy the channel identifier (for example, https:/t.me/MY_IDENTIFIER).
   • For private channels, use the getUpdates method with your API token and copy the channel identifier (for example, -2241293890657).

Set up the Telegram integration in GitLab

{{< history >}}

• Message thread ID introduced in GitLab 16.11.
• Hostname introduced in GitLab 17.1.

{{< /history >}}

Prerequisites:

• Administrator access for instance enablement.
• The Owner role for group enablement.
• The Maintainer or Owner role for project enablement.

After you invite the bot to a Telegram channel, you can configure GitLab to send notifications:

1. To enable the integration:
   • For your group or project:
     1. In the top bar, select Search or go to and find your project or group.
     2. Select Settings > Integrations.
   • For your instance:
     1. In the upper-right corner, select Admin.
     2. Select Settings > Integrations.
2. Select Telegram.
3. Under Enable integration, select the Active checkbox.
4. Optional. In Hostname, enter the hostname of your local bot API server.
5. In Token, paste the token value from the Telegram bot.
6. In the Trigger section, select the checkboxes for the GitLab events you want to receive in Telegram.
7. In the Notification settings section:
   • In Channel identifier, paste the Telegram channel identifier.
   • Optional. In Message thread ID, paste the unique identifier for the target message thread (topic in a forum supergroup).
   • Optional. Select the Notify only broken pipelines checkbox to receive notifications for failed pipelines only.
   • Optional. Select the Notify only when status changes checkbox to receive notifications only when the pipeline status for the ref changes.
   • Optional. From the Branches for which notifications are to be sent dropdown list, select the branches you want to receive notifications for.
8. Optional. Select Test settings.
9. Select Save changes.

The Telegram channel can now receive all selected GitLab events.