Accessing the Telegram Bot API

When creating a new workflow or editing an existing one, in the management console, under Create workflow / Edit workflow, select Constructor.

From the Integration steps section on the left side of the screen, drag the Telegram bot element to relevant workflow location in the constructor window.

You can drag and drop steps into areas marked by the dotted line in the workflow schema, such as Add a step, etc.

In the workflow schema window, click the new Telegram bot block to select it.

At the right of the window, on the Settings tab.

1. In the Step name field, enter a name for the workflow step.

2. Under Token, specify the bot token or Yandex Lockbox secret that token is stored in. Select:

   • Lockbox to store the bot token in a secret; in the Secret section, select the secret, its version, and the key used to store the bot token.

     If you do not have a Yandex Lockbox secret, click Create to create one.

   • Text to store the bot token in the specification as text; enter the bot token in the Value field.

     Warning

     It is not safe to store the bot token in the specification in plain text.

3. Under Action:

   1. In the Chat ID field, provide chat ID or channel name in @channelusername format.
   2. In the Text field, enter the text of the message.
   3. Optionally, in the Reply to field, provide the ID of the message to reply to.
   4. Optionally, in the Formatting mode field, select message formatting mode. For more information, see the Telegram Bot API documentation.

4. Optionally, in the Timeout, ms field, set the maximum execution time for the current step.

5. Optionally, to set a custom retry policy for a step, expand the Retry policy section and click Retry policy. In the form that appears:

   1. Optionally, in the Initial delay, ms field, set the initial value for a delay between step retries.

   2. Optionally, in the Backoff rate field, set the multiplication factor for delay before each step retry.

   3. Optionally, in the Maximum delay, ms field, set the value for a maximum delay between step retries.

   4. In the Errors field, select the errors for which the step will or will not be retried.

      For detailed information about possible errors, see this section.

   5. Optionally, in the Maximum number of retries field, set the maximum number of step retry attempts.

   6. In the Error selection mode field, select:

      • INCLUDE: Retry executing a step when errors specified in the Errors field occur.
      • EXCLUDE: To retry executing the step on any errors other than those specified in the Errors field.

   If you want to delete a retry policy you created for the step earlier, click and select Delete in the Retry policy row.

   If no custom retry policy is configured for a step, the retry policy set for the whole workflow will apply.

Optionally, navigate to the Input tab and set a jq template to filter the workflow state fed into the step.

Optionally, navigate to the Output tab and set a jq template to filter the step outputs added into the workflow state.

Optionally, add an error transition rule for the step you are creating to handle errors you may get during this step.