From 20e3940bb2ecad27484894aef2455bae3a280296 Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:40:39 +0000 Subject: [PATCH] Update wiki Home page for telegram-sink --- Home.md | 47 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..e5aabee 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,40 @@ -# Deploy the Project on CamelX Platform +# Telegram Sink -Deploy on CamelX Platform in three steps +Send a message to a Telegram chat by using your Telegram bot as sender. -## Step 1: Create a release -From the project space, click on **"Create a release"** +To create a bot, use your Telegram app to contact the @botfather account. -The new version is automatically available in the list +This sink supports the following message types: -## Step 2: Deploy -Click on **"Deploy"** +- Standard text messages +- PNG images (`Content-Type` must be set to `image/png`) +- JPEG images (`Content-Type` must be set to `image/jpeg`) -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +This sink also supports the following message headers: -## Step 3: Expose -Enable **"Expose"** +- `text` / `ce-text`: when sending an image, the image caption +- `chat-id` / `ce-chatid`: overrides the default chat where messages are sent to -Choose an **API Gateway** (Internal, Public, etc.) +## Metadata + +| Property | Value | +|----------|-------| +| Type | sink | +| Group | Telegram | +| Namespace | Social | +| Support Level | Stable | +| Provider | Apache Software Foundation | + +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `authorizationToken` | string | ✓ | | The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather. | +| `chatId` | string | | | The Chat ID to where you want to send messages by default. Whilst the Chat ID is not a required Configuration Option it must be provided for every message; either as a Configuration Option or a `chat-id` / `ce-chatid` header. | + +## Dependencies + +- `camel:core` +- `camel:jackson` +- `camel:kamelet` +- `camel:telegram`