diff --git a/source/_integrations/telegram_bot.markdown b/source/_integrations/telegram_bot.markdown index ddc32795e78..30b0a6d1953 100644 --- a/source/_integrations/telegram_bot.markdown +++ b/source/_integrations/telegram_bot.markdown @@ -23,250 +23,250 @@ Available services: `send_message`, `send_photo`, `send_video`, `send_animation` Send a notification. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message` | no | Message body of the notification. | -| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | -| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | +| Service data attribute | Optional | Description | +| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message` | no | Message body of the notification. | +| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| `reply_to_message_id` | yes | Mark the message as a reply to a previous message. In `telegram_callback` handling, for example, you can use {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %} | ### Service `telegram_bot.send_photo` Send a photo. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to an image. | -| `file` | no | Local path to an image. | -| `caption` | yes | The title of the image. | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to an image. | +| `file` | no | Local path to an image. | +| `caption` | yes | The title of the image. | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_video` Send a video. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to a video. | -| `file` | no | Local path to a video. | -| `caption` | yes | The title of the video. | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to a video. | +| `file` | no | Local path to a video. | +| `caption` | yes | The title of the video. | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | ### Service `telegram_bot.send_animation` Send an animation. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. | -| `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. | -| `caption` | yes | The title of the animation. | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to a GIF or H.264/MPEG-4 AVC video without sound. | +| `file` | no | Local path to a GIF or H.264/MPEG-4 AVC video without sound. | +| `caption` | yes | The title of the animation. | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending video in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_voice` Send a voice message. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to a voice message. | -| `file` | no | Local path to a voice message. | -| `caption` | yes | The title of the voice message. | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending voice in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to a voice message. | +| `file` | no | Local path to a voice message. | +| `caption` | yes | The title of the voice message. | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `disable_notification` | yes | True/false to send the message silently. iOS users and web users will not receive a notification. Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending voice in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_sticker` Send a sticker. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to a static .webp or animated .tgs sticker. | -| `file` | no | Local path to a static .webp or animated .tgs sticker. | -| `sticker_id` | no | ID of a sticker that exists on telegram servers. The ID can be found by sending a sticker to your bot and querying the telegram-api method [getUpdates](https://core.telegram.org/bots/api#getting-updates) or by using the [@idstickerbot](https://t.me/idstickerbot) | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to a static .webp or animated .tgs sticker. | +| `file` | no | Local path to a static .webp or animated .tgs sticker. | +| `sticker_id` | no | ID of a sticker that exists on telegram servers. The ID can be found by sending a sticker to your bot and querying the telegram-api method [getUpdates](https://core.telegram.org/bots/api#getting-updates) or by using the [@idstickerbot](https://t.me/idstickerbot) | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending photo in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_document` Send a document. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `url` | no | Remote path to a document. | -| `file` | no | Local path to a document. | -| `caption` | yes | The title of the document. | -| `username` | yes | Username for a URL which requires HTTP authentication. | -| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | -| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | -| `timeout` | yes | Timeout for sending document in seconds. Will help with timeout errors (poor internet connection, etc) | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | no | Remote path to a document. | +| `file` | no | Local path to a document. | +| `caption` | yes | The title of the document. | +| `username` | yes | Username for a URL which requires HTTP authentication. | +| `password` | yes | Password (or bearer token) for a URL which require HTTP authentication. | +| `authentication` | yes | Define which authentication method to use. Set to `digest` to use HTTP digest authentication, or `bearer_token` for OAuth 2.0 bearer token authentication. Defaults to `basic`. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `verify_ssl` | yes | True/false for checking the SSL certificate of the server for HTTPS URLs. Defaults to True. | +| `timeout` | yes | Timeout for sending document in seconds. Will help with timeout errors (poor internet connection, etc) | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_location` Send a location. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `latitude` | no | The latitude to send. | -| `longitude` | no | The longitude to send. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | -| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | -| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | -| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `latitude` | no | The latitude to send. | +| `longitude` | no | The longitude to send. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `resize_keyboard` | yes | True/false for resizing the keyboard vertically for optimal fit. Defaults to False. | +| `one_time_keyboard` | yes | True/false for hiding the keyboard as soon as it’s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to False. | +| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. `[]` to reset to no custom keyboard. Example: `["/command1, /command2", "/command3"]` | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | +| `message_tag` | yes | Tag for sent message. In `telegram_sent` event data: {% raw %}`{{trigger.event.data.message_tag}}`{% endraw %} | ### Service `telegram_bot.send_poll` Send a poll. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `question` | no | Poll question, 1-300 characters. | -| `options` | no | List of answer options, 2-10 strings 1-100 characters each. | -| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. | -| `is_anonymous` | yes | True/false for if the poll needs to be anonymous, defaults to True. | -| `allows_multiple_answers` | yes | True/false for if the poll allows multiple answers, defaults to False. | -| `open_period` | yes | Amount of time in seconds the poll will be active after creation, 5-600. | -| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | -| `timeout` | yes | Timeout for sending voice in seconds. Will help with timeout errors (poor internet connection, etc) | +| Service data attribute | Optional | Description | +| ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `question` | no | Poll question, 1-300 characters. | +| `options` | no | List of answer options, 2-10 strings 1-100 characters each. | +| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. | +| `is_anonymous` | yes | True/false for if the poll needs to be anonymous, defaults to True. | +| `allows_multiple_answers` | yes | True/false for if the poll allows multiple answers, defaults to False. | +| `open_period` | yes | Amount of time in seconds the poll will be active after creation, 5-600. | +| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. | +| `timeout` | yes | Timeout for sending voice in seconds. Will help with timeout errors (poor internet connection, etc) | ### Service `telegram_bot.edit_message` Edit a previously sent message in a conversation. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | -| `chat_id` | no | The chat_id where to edit the message. | -| `message` | no | Message body of the notification. | -| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | -| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | -| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | +| Service data attribute | Optional | Description | +| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | +| `chat_id` | no | The chat_id where to edit the message. | +| `message` | no | Message body of the notification. | +| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. | +| `parse_mode` | yes | Parser for the message text: `markdownv2`, `html` or `markdown`. | +| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | ### Service `telegram_bot.edit_caption` Edit the caption of a previously sent message. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | -| `chat_id` | no | The chat_id where to edit the caption. | -| `caption` | no | Message body of the notification. | -| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | +| Service data attribute | Optional | Description | +| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | +| `chat_id` | no | The chat_id where to edit the caption. | +| `caption` | no | Message body of the notification. | +| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | ### Service `telegram_bot.edit_replymarkup` Edit the inline keyboard of a previously sent message. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | -| `chat_id` | no | The chat_id where to edit the reply_markup. | -| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. | -| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` | +| Service data attribute | Optional | Description | +| -------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | +| `chat_id` | no | The chat_id where to edit the reply_markup. | +| `disable_web_page_preview` | yes | True/false for disable link previews for links in the message. | +| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data or external URL (https-only). Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Google link", "https://google.com"]]]` | ### Service `telegram_bot.answer_callback_query` Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message` | no | Unformatted text message body of the notification. | -| `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} | -| `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `message` | no | Unformatted text message body of the notification. | +| `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} | +| `show_alert` | yes | True/false for show a permanent notification. Defaults to False. | ### Service `telegram_bot.delete_message` Delete a previously sent message in a conversation. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | -| `chat_id` | no | The chat_id where to delete the message. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. | +| `chat_id` | no | The chat_id where to delete the message. | ### Service `telegram_bot.leave_chat` Remove the bot from the chat group where it was added. -| Service data attribute | Optional | Description | -|---------------------------|----------|--------------------------------------------------| -| `chat_id` | no | The chat_id from where to remove the bot. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------------------------------------- | +| `chat_id` | no | The chat_id from where to remove the bot. | ## Telegram notification platform