| // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |
| = image:kamelets/telegram-sink.svg[] Telegram Sink |
| |
| *Provided by: "Apache Software Foundation"* |
| |
| Send a message to a Telegram chat using your Telegram bot as sender. |
| |
| To create a bot, contact the @botfather account using the Telegram app. |
| |
| This sink supports the following message types: |
| |
| - Standard text messages |
| - PNG images (`Content-Type` must be set to `image/png`) |
| - JPEG images (`Content-Type` must be set to `image/jpeg`) |
| |
| This following message headers are also supported: |
| |
| - `text` / `ce-text`: when sending an image, the image caption |
| - `chat-id` / `ce-chat-id`: to override the default chat where messages are sent to |
| |
| == Configuration Options |
| |
| The following table summarizes the configuration options available for the `telegram-sink` Kamelet: |
| [width="100%",cols="2,^2,3,^2,^2,^3",options="header"] |
| |=== |
| | Property| Name| Description| Type| Default| Example |
| | *authorizationToken {empty}* *| Token| The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather.| string| | |
| | chatId| Chat ID| The Chat ID where messages should be sent by default| string| | |
| |=== |
| |
| NOTE: Fields marked with ({empty}*) are mandatory. |
| |
| == Usage |
| |
| This section summarizes how the `telegram-sink` can be used in various contexts. |
| |
| === Knative Sink |
| |
| The `telegram-sink` Kamelet can be used as Knative sink by binding it to a Knative object. |
| |
| .telegram-sink-binding.yaml |
| [source,yaml] |
| ---- |
| apiVersion: camel.apache.org/v1alpha1 |
| kind: KameletBinding |
| metadata: |
| name: telegram-sink-binding |
| spec: |
| source: |
| ref: |
| kind: InMemoryChannel |
| apiVersion: messaging.knative.dev/v1 |
| name: mychannel |
| sink: |
| ref: |
| kind: Kamelet |
| apiVersion: camel.apache.org/v1alpha1 |
| name: telegram-sink |
| properties: |
| authorizationToken: "The Token" |
| |
| ---- |
| |
| Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to. |
| |
| Save the `telegram-sink-binding.yaml` file into your hard drive, then configure it according to your needs. |
| |
| You can run the sink using the following command: |
| |
| [source,shell] |
| ---- |
| kubectl apply -f telegram-sink-binding.yaml |
| ---- |
| // THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |