Creating a Telegram trigger that invokes a function from Cloud Functions
Create a Telegram trigger that invokes a function from Cloud Functions when your Telegram bot receives an update.
Getting started
To create a trigger, you will need:
-
Telegram bot and its token. If you do not have a bot, create one using @BotFather
and copy the issued token. -
Function the trigger will invoke. If you do not have a function:
-
Optionally, a dead-letter queue where to redirect the messages the function failed to process. If you do not have a queue, create one.
-
Service accounts with the following permissions:
- To invoke a function.
- Optionally, to write to a dead-letter queue.
You can use the same service account or different ones. If you do not have a service account, create one.
Creating a trigger
Note
The trigger is initiated within five minutes after it is created.
-
In the management console
, select the folder where you want to create your trigger. -
Navigate
to Cloud Functions. -
In the left-hand panel, select
Triggers. -
Click Create trigger.
-
Under Basic settings:
-
Optionally, enter a trigger name and description.
-
In the Labels field, click Add label and specify the labels in
key: valueformat. -
In the Type field, select
Telegram.
-
-
Under Telegram settings, specify the Telegram bot token you received from @BotFather
. -
Under Batch message settings, specify the following:
- Waiting time, s. The values may range from 1 to 60 seconds. The default value is 1 second.
- Batch size. The values may range from 1 to 1,000. The default value is 1.
The trigger groups events within the specified wait time and sends them to the target. The number of events cannot exceed the specified batch size.
-
Under Targets:
-
In the Target type field, select
Function. -
Under Function settings, select a function and specify:
- Function version tag.
- Service account to use for invoking the function.
-
Optionally, under Repeat request settings:
- In the Interval field, specify how long to wait before retrying the function if it fails. The values may range from 10 to 60 seconds. The default value is 10 seconds.
- In the Number of attempts field, specify the number of function retries before the trigger sends a message to the dead letter queue. The values may range from 1 to 5. The default value is 1.
-
Optionally, under Dead Letter Queue settings, select a dead-letter queue and a service account with write permissions for that queue.
-
Optionally, in the Filter field, specify a jq template to filter events sent to the target. If no filter is specified, all events are sent to the target.
-
Optionally, in the Transformation template field, specify a
jqtemplate to transform events before sending them to the target. If no template is specified, no transformations apply to the events.
-
-
Click Create trigger.
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the guides on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.
To create a Telegram trigger that invokes a function:
-
Describe the trigger in the configuration file:
resource "yandex_serverless_triggers" "my_trigger" { name = "<trigger_name>" source { telegram_message { bot_token = "<Telegram_bot_token>" allowed_updates = [ "<update_type>", "<update_type>" ] force = true } } action { invoke_function { function_id = "<function_ID>" function_tag = "<function_version_tag>" service_account_id = "<service_account_ID>" } filter { jq = ".message.text | startswith(\"/\")" } transformer { jq = ".message" } retry_policy { retry_attempts = "<number_of_retries>" interval = "<interval_between_retries>" } dead_letter { dead_letter_queue { queue_arn = "<Dead_Letter_Queue_ARN>" service_account_id = "<service_account_ID>" } } } }Where:
-
name: Trigger name. The name format is as follows:- Length: between 3 and 63 characters.
- It can only contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
description: Trigger description. This is an optional parameter. -
labels: Trigger labels inkey:valueformat. This is an optional parameter.
-
source: Event source settings:-
telegram_message: Telegram bot settings:bot_token: Telegram bot token received from @BotFather . The value is only provided when creating or updating a trigger. Terraform does not return the value in its output. When the token changes, the webhook is re-registered.allowed_updates: List of Telegram update types the bot subscribes to. This is an optional setting. The default value is[ "message" ].force: Reinstalling the webhook if the bot already has a webhook configured for another URL. Without this setting, creating a trigger will fail with an error. If the webhook already points to the trigger, this setting has no effect. This is an optional parameter.
-
-
action: Target settings. You can specify this section multiple times so that the trigger calls multiple resources, including those of different types. There are limits on the maximum number of resources.-
invoke_function: Function settings:function_id: Function ID.function_tag: Function version tag. This is an optional parameter. If it is not specified, the latest version of the function is called.service_account_id: ID of the service account with permissions to invoke the function.
-
filter: Filtering events before sending them to the target. This is an optional section.jq: jq template to filter events sent to the target. It not specified, all events reach the target.
-
transformer: Transforming events before sending them to the target. This is an optional section.jq: jq template to transform events before sending them to the target. It omitted, no transformations apply to the events.
-
retry_policy: Repeated request settings. This is an optional section.interval: Time interval before a retry attempt to send the event if the current attempt fails.retry_attempts: Number of retry attempts before the trigger moves the event to the dead-letter queue.
-
dead_letter: Dead-letter queue settings. This is an optional section.-
dead_letter_queue: Queue settings:queue_arn: Queue ARN.service_account_id: ID of the service account with permissions to write to the queue.message_attributes: Attributes to add to each message in the queue, inkey:valueformat. This is an optional parameter.
-
-
For more on the properties of the
yandex_serverless_triggersresource, see this provider guide. -
-
Create the resources:
-
In the terminal, navigate to the configuration file directory.
-
Make sure the configuration is correct using this command:
terraform validateIf the configuration is valid, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.
-
Apply the configuration changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
Terraform will create all the required resources. You can check the new resources using the management console
or this CLI command:yc serverless trigger list -
Checking the result
Check that the trigger works correctly. To do this, view function logs that show information on invocations.