diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 15:07:18 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-13 15:07:18 +0300 |
commit | c3eeb6a8d6a4b11f0bc5e5eb1ed43b0726f1ea26 (patch) | |
tree | 7283014bb12ce53b57d2703b229095ad58e6d820 /doc/user/project/integrations | |
parent | 10e15ac3c2798956ff6a43d7b36bdf86c68aa817 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project/integrations')
-rw-r--r-- | doc/user/project/integrations/index.md | 1 | ||||
-rw-r--r-- | doc/user/project/integrations/telegram.md | 55 | ||||
-rw-r--r-- | doc/user/project/integrations/webhook_events.md | 3 |
3 files changed, 58 insertions, 1 deletions
diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 3bdb6ada00e..abc274d814d 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -81,6 +81,7 @@ You can configure the following integrations. | [Slack notifications](slack.md) | Send notifications about project events to Slack. | **{dotted-circle}** No | | [Slack slash commands](slack_slash_commands.md) | Enable slash commands in a workspace. | **{dotted-circle}** No | | [Squash TM](squash_tm.md) | Update Squash TM requirements when GitLab issues are modified. | **{check-circle}** Yes | +| [Telegram](telegram.md) | Send notifications about project events to Telegram. | **{dotted-circle}** No | | [Unify Circuit](unify_circuit.md) | Send notifications about project events to Unify Circuit. | **{dotted-circle}** No | | [Webex Teams](webex_teams.md) | Receive events notifications. | **{dotted-circle}** No | | [YouTrack](youtrack.md) | Use YouTrack as the issue tracker. | **{dotted-circle}** No | diff --git a/doc/user/project/integrations/telegram.md b/doc/user/project/integrations/telegram.md new file mode 100644 index 00000000000..d2e402d0bd0 --- /dev/null +++ b/doc/user/project/integrations/telegram.md @@ -0,0 +1,55 @@ +--- +stage: Manage +group: Import and Integrate +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Telegram **(FREE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/122879) in GitLab 16.1. + +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](#create-a-telegram-bot). +1. [Configure the Telegram bot](#configure-the-telegram-bot). +1. [Set up the Telegram integration in GitLab](#set-up-the-telegram-integration-in-gitlab). + +## Create a Telegram bot + +To create a bot in Telegram: + +1. Start a new chat with `@BotFather`. +1. [Create a new bot](https://core.telegram.org/bots/features#creating-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. +1. Assign the bot `Post Messages` rights to receive events. +1. Create an identifier for the channel. + +## Set up the Telegram integration in GitLab + +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. On the top bar, select **Main menu** and find your group or project. + 1. on the left sidebar, select **Settings > Integrations**. + - **For your instance:** + 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, select **Settings > Integrations**. +1. Select **Telegram**. +1. In **Enable integration**, select the **Active** checkbox. +1. In **New token**, [paste the token value from the Telegram bot](#create-a-telegram-bot). +1. In the **Trigger** section, select the checkboxes for the GitLab events you want to receive in Telegram. +1. In **Channel identifier**, [paste the channel identifier from the Telegram channel](#configure-the-telegram-bot). + - To get a private channel ID, use the [`getUpdates`](https://core.telegram.org/bots/api#getupdates) method. +1. Optional. Select **Test settings**. +1. Select **Save changes**. + +The Telegram channel can now receive all selected GitLab events. diff --git a/doc/user/project/integrations/webhook_events.md b/doc/user/project/integrations/webhook_events.md index cdbea599a3f..abcbf6009af 100644 --- a/doc/user/project/integrations/webhook_events.md +++ b/doc/user/project/integrations/webhook_events.md @@ -1143,7 +1143,8 @@ Payload example: "key": "NESTOR_PROD_ENVIRONMENT", "value": "us-west-1" } - ] + ], + "url": "http://example.com/gitlab-org/gitlab-test/-/pipelines/31" }, "merge_request": { "id": 1, |