telegram sink Telegram Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

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-chatid: 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:

Property Name Description Type Default Example

authorizationToken *

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
Fields marked with (*) 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
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: telegram-sink-binding
spec:
  source:
    ref:
      kind: Channel
      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 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:

kubectl apply -f telegram-sink-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:jackson

  • camel:kamelet

  • camel:telegram

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind channel:mychannel telegram-sink -p "sink.authorizationToken=The Token"

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Sink

The telegram-sink Kamelet can be used as Kafka sink by binding it to a Kafka topic.

telegram-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: telegram-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: telegram-sink
    properties:
      authorizationToken: "The Token"

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have 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:

kubectl apply -f telegram-sink-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic telegram-sink -p "sink.authorizationToken=The Token"

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

https://github.com/apache/camel-kamelets/blob/main/telegram-sink.kamelet.yaml

Back to top