Web events

When interacting with HTML5 games, websites of payment gateways and bot mini apps, Telegram apps should expose APIs to allow receiving data and events from the websites.

Event APIs

Games, payment gateways and bot mini apps can generate events that are meant to be received by the Telegram apps. Typically events are generated by using the postEvent method of the GamingCommunication library, or by the bot mini apps library.
The postEvent function will try sending the event to the Telegram app in a number of different ways.

WebviewProxy

In mobile apps, the event receiver API should be typically exposed as a window.TelegramWebviewProxy object with a postEvent method.

window.TelegramWebviewProxy.postEvent(eventType, eventData)

window.external

Alternatively, a window.external.notify method can be exposed, accepting a string JSON payload with the event type and payload:

window.external.notify(JSON.stringify({eventType: eventType, eventData: eventData}));

postMessage API

Finally, web MTProto clients that need to open a game, open a bot mini app or process a payment in an iframe can use the postMessage API to receive events from iframes.
The GamingCommunication and bot mini apps libraries by default will use '*' as targetOrigin, sending messages to parent pages regardless of the origin of the embedder.

window.parent.postMessage(JSON.stringify({eventType: eventType, eventData: eventData}), targetOrigin);

Event types

eventType is a simple string indicating the event type, and eventData is a payload with an object that will be parsed by the Telegram app.

web_app_close

No event payload, OR a JSON object with the following fields (which should be properly validated by the client).

  • return_back - If true, if the web app was opened through a deep link in another app (i.e. not through a deep link in a Telegram client), the Telegram client should return to the app that opened the link, not to the main page of the Telegram client. (boolean, optional)

Emitted by bot mini apps when the mini app webview should be closed.

web_app_open_popup

Event data: a JSON object with the following fields (which should be properly validated by the client).

  • title - Title for the popup (optional string, max 64 characters)
  • message - Message of the popup (string, max 256 characters)
  • buttons - An array of the following objects (array of 1-3 objects)
    • type - Button type (string, one of ok, close, cancel, default, destructive (in this case, the button must be red))
    • text - Button text (string, optional for ok, close and cancel types)
    • id - Button ID (unique string)

Emitted by bot mini apps to open a native pop-up over the webview.

By default, buttons should be displayed on one row.
If the mini app provides two buttons that can't fit horizontally on one row, display each button on a separate row.
If the mini app provides three buttons, always display each button on a separate row.

  • If the user presses any of the buttons, call window.Telegram.WebView.receiveEvent("popup_closed", {"button_id": "<button id>"})
  • If the user cancels the interaction without pressing any of the specified buttons, call window.Telegram.WebView.receiveEvent("popup_closed", {})

Disable handling of this event if a popup is already being displayed, re-enable handling only after the popup_closed response event is emitted.
While handling is enabled, maximum 3 consecutive valid events of this type can be handled in a timespan of 3 seconds, ignore excess events.

web_app_request_write_access

Event data: null

Emitted by bot mini apps to ask permission from the user to send them messages.

Upon receiving this event, clients should first invoke bots.canSendMessage, to check whether they have already granted the bot permission to write them in some way.

web_app_request_phone

Event data: null

Emitted by bot mini apps to ask the user to share their phone number as a contact.

Upon receiving this event, clients should show a prompt to the user, indicating that the bot is asking them to share their phone number (optionally also asking the user to unblock the bot, if it's currently blocked).

If they accept, the user's phone number should be shared by sending a contact to the bot (unblocking it first, if it's currently blocked by the user); if all RPC queries (to unblock the bot, to send the message) succeed, a phone_requested event » should be sent with {"status": "sent"}.

If the user refuses or any intermdiate method call fails, a phone_requested event » should be sent with {"status": "cancelled"}.

web_app_biometry_get_info

Event data: null

Emitted by bot mini apps to ask the client to initialize the biometric authentication manager object for the current bot, emitting a biometry_info_received event » on completion.

This request should just initialize the client-side state, i.e. by checking if biometric authentication is even available or not, it should not ask the user anything.

web_app_biometry_request_access

Event data: a JSON object, with an optional reason string field (1-128 chars, used in the prompt), containing the reason why the bot is asking to use biometric authentication.

Emitted by bot mini apps to ask the user permission to use biometric authentication, emitting a biometry_info_received event » on completion.

This request should not actually prompt biometric authentication, it should just ask the user permission to use it through a popup that should be shown only once (for this bot): no popup must be shown if the user has already previously allowed, denied or cancelled a biometry permission popup from this bot.

web_app_biometry_update_token

Event data: a JSON object with the following fields:

  • token - The new token (string, 0-1024 chars), or an empty string to remove it.
  • reason - Optional string field, containing the reason why the bot is asking to authenticate using biometrics (1-128 chars, used in the prompt).

Emitted by bot mini apps to authenticate using biometrics and store the biometric token securely stored on-device, emitting a biometry_token_updated event » on completion.

This token (which may be for example the private key of a cryptocurrency wallet, or some other data the app must keep safe) must be safely stored by the Telegram client, associating it to the bot that owns the mini app.

For example, the token may be directly stored in the on-device secure storage, accessible only after biometric authentication, or it may be stored to normal, non-secure storage, but in encrypted form, encrypted using the key returned from the device's secure storage after biometric authentication (for example on Android, using the CryptoObject returned by the biometric prompt authentication result).

If the user has previously disallowed the bot from using biometric authentication, this request should immediately fail, emitting an appropriate biometry_token_updated event ».

web_app_biometry_request_auth

Event data: a JSON object, with an optional reason string field, containing the reason why the bot is asking to authenticate using biometrics (1-128 chars, used in the prompt).

Emitted by bot mini apps to authenticate using biometrics and fetch the previously stored secure token, emitting a biometry_auth_requested event » on completion, containing either an error, or the decrypted biometric token » (or an empty string if no token was configured yet).

Should only be used if the token_saved field of the biometry_info_received object » is equal to true, otherwise set a new token first using web_app_biometry_update_token ».

If the user has previously disallowed the bot from using biometric authentication, this request should immediately fail, emitting an appropriate biometry_auth_requested event ».

web_app_biometry_open_settings

Event data: null

Emitted by bot mini apps to open the biometric authentication settings page for bots, useful when the app needs to request permission to use biometrics from users who have previously denied it.

Note that this event should only be handled in response to user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button), and it must be handled at most once a second.

web_app_invoke_custom_method

Event data: a JSON object with the following fields:

  • req_id - A string with the ID of the current request
  • method - A string, containing the name of the called custom method
  • params - An object containing the parameters of the method call

Emitted by bot mini apps to make custom method calls to Telegram's servers on behalf of the user.

This event should trigger a bots.invokeWebViewCustomMethod request, passing the method to custom_method, and the params to params.

Upon receiving a reply, a custom_method_invoked event » should be emitted, with the following fields:

  • req_id - The req_id from the web_app_invoke_custom_method object
  • result - The JSON data contained in the response of the bots.invokeWebViewCustomMethod method, if the method call succeeded
  • error - The text of the RPC error, if the method call failed

web_app_read_text_from_clipboard

Event data: a JSON object with the following fields:

  • req_id - A string with the ID of the current request

Emitted by bot mini apps to obtain the contents of the system clipboard.

Only for Mini Apps owned by bots added to the attachment menu, regardles of how the Mini App itself was launched, this event should trigger a clipboard_text_received event » with the following payload:

  • req_id - The req_id from the web_app_read_text_from_clipboard request
  • data - A string with the clipboard contents

Note that this method can be called only in response to a user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main or settings button).
Note that user interactions must have a TTL of 10 seconds: events of this type must be ignored and a clipboard_text_received event » with the correct req_id and no data field must be sent if the last Mini App user interaction (as described above) happened more than 10 seconds ago.

A clipboard_text_received event » with the correct req_id and no data field must also be sent if the bot is not installed in the attachment menu.

web_app_open_scan_qr_popup

Event data: a JSON object with the following fields:

  • text - Optional string, containing the text to be displayed under the 'Scan QR' heading, 0-64 characters.

Emitted by bot mini apps to prompt the client to open the native QR code scanner and start continuously scanning for QR codes.

A qr_text_received event » should be emitted every time a new QR code is scanned, until the user closes the popup via the UI or the Mini App closes the popup with a web_app_close_scan_qr_popup event.

Closing the popup should emit a scan_qr_popup_closed event »; the same event should be emitted if the scan QR code popup cannot be opened due to permission issues.

web_app_close_scan_qr_popup

Event data: null

Emitted by bot mini apps to prompt the client to close the native QR code scanner opened using web_app_open_scan_qr_popup.

The scan_qr_popup_closed event » event should not be emitted if the QR code popup is closed using this event.

web_app_setup_closing_behavior

Event data: a JSON object with a boolean need_confirmation.

If equal to true, the client should require user confirmation with a "Changes that you made may not be saved." popup with "Cancel"/"Close anyway" buttons before closing the webview, to avoid accidentally aborting a sensitive operation; otherwise no confirmation should be requested.

web_app_set_background_color

Event data: a JSON object with a string color with a hex RGB color.

Used to set the mini app background and lower overscroll color.

web_app_set_header_color

Event data: a JSON object with the following fields:

  • color_key - A string with one of the following values:
  • color - A color in hex RGB format (#ffffff).

The two fields are mutually exclusive, if none of the two fields are provided the default header color is used.

Used to set the mini app header and upper overscroll color.

web_app_data_send

Event data: a JSON object with a string data field.

Used only by keyboard button mini apps to send back data to the bot as specified here ». The Mini App will be closed.

web_app_switch_inline_query

Event data: a JSON object with the following keys:

  • query - The inline query that will be inserted in the chat's input field, after the bot's username.
    May be an empty string, in which case just the bot's username will be inserted, triggering an empty inline query.
  • chat_types - An array of strings, containing a combination of users, bots, groups, channels.
    If non-empty, the client should prompt the user to choose a specific chat of the specified type(s), then open the chosen chat and inserts the bot's username and the specified inline query in the input field.
    The array values specify which types of chats the user will be able to choose from.
    If empty, the current chat is used.

Used by inline mode mini apps to send back data to the bot as specified here ». The Mini App will be closed.

web_app_trigger_haptic_feedback

Event data: a JSON object with the following fields:

  • type - One of the following values (string):
    • impact - An impact occurred.
    • notification - A task or action has succeeded, failed, or produced a warning.
    • selection_change - The user has changed a selection.
  • impact_style - Only for impact feedbacks, one of the following values (string):
    • light - Indicates a collision between small or lightweight UI objects
    • medium - Indicates a collision between medium-sized or medium-weight UI objects
    • heavy - Indicates a collision between large or heavyweight UI objects
    • rigid - Indicates a collision between hard or inflexible UI objects
    • soft - Indicates a collision between soft or flexible UI objects
  • notification_type - Only for notification feedbacks, one of the folowing values (string):
    • error - Indicates that a task or action has failed
    • success - Indicates that a task or action has completed successfully
    • warning - Indicates that a task or action produced a warning

Used to trigger haptic feedback for a user interaction in a webapp.

web_app_open_link

Event data: a JSON object with the following fields:

  • url - The URL to open
  • try_instant_view - Optional boolean, if set, equal to true and the scheme of the URL is either http or https, the link should be opened in Instant View mode if possible.
  • try_browser - Optional string, if set, must contain one of the following browser identifiers, and the client should attempt to open the link using the specified browser (if it's currently installed on the device):
    • google-chrome or chrome - Google Chrome
    • mozilla-firefox or firefox - Firefox
    • microsoft-edge or edge - Microsoft Edge
    • opera - Opera
    • opera-mini - Opera Mini
    • brave or brave-browser - Brave Browser
    • duckduckgo or duckduckgo-browser - Duckduckgo Browser
    • samsung or samsung-browser - Samsung Browser
    • vivaldi or vivaldi-browser - Vivaldi
    • kiwi or ĸiwi-browser - Kiwi
    • uc or uc-browser - UC browser
    • tor or tor-browser - TOR browser

Used to open a link in an external browser (or in a new tab for browser clients). The Mini App will not be closed.

Only URLs with the scheme equal to one of the schemes specified in web_app_allowed_protocols may be opened.

Note that this method can be called only in response to a user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main or settings button).
After opening the URL, further events of this type should be ignored until the user interacts again with the Mini App interface (as above).
Note that user interactions must have a TTL of 1 second: events of this type must be ignored if the last Mini App user interaction happened more than 1 second ago.

web_app_open_tg_link

Event data: a JSON object with a string path_full field, containing the path+query component of a t.me deep link (url = 'https://t.me' + path_full).

Used to open a t.me deep link. The Mini App must be closed.

web_app_open_invoice

Event data: a JSON object with a string slug field, containing an invoice deep link.

Used to initiate payment of an invoice », by opening an invoice popup over the Mini App: the Mini App itself must not be closed.

The payment status must be reported back to the mini app using invoice_closed.

web_app_expand

No event payload.

Expands the mini app to the maximum available height.
The mini app must also be expanded when the user swipes up on the webview.

This event must be ignored during a user swipe down, used to reduce the webview.

web_app_request_viewport

No event payload.

Used by mini apps to request information about the viewport, clients should emit a viewport_changed event.

web_app_request_theme

No event payload.

Used by mini apps to request information about the current theme, clients should emit a theme_changed event.

web_app_ready

No event payload.

Emitted by mini apps when they are fully loaded, signaling to client apps that the loading spinner placeholder can be removed.

Note that there is no guarantee that this event will be emitted when the mini app is fully loaded: clients should remove the loading spinner upon receiving this event or when the page finishes loading (native webview/iframe event), whichever event comes first.

web_app_setup_main_button

Event payload: JSON object with the following fields:

  • is_visible - Whether the main button is visible (boolean, false by default)
  • is_active - Whether the main button is active (boolean, true by default)
  • text - Button text (string, if trim(text) is empty the button must be hidden)
  • color - Button color in hex RGB format (string, defaults to the button_color theme parameter)
  • text_color - Button text color in hex RGB format (string, defaults to the button_text_color theme parameter)
  • is_progress_visible - Indicates whether the button should display a loading indicator (boolean, false by default)

Configures the main button, located immediately below the webview: when the user presses it a main_button_pressed event should be emitted by the client.

Some clients implement a horizontal media type tab bar located at the bottom of the screen, opened when the user clicks on the attachment menu button: this tab bar contains a horizontal list of buttons used to attach media of a certain type and to open installed attachment menu mini apps.
In clients that implements a tab bar, iff the user opens a mini app through a tab bar button and the mini app emits a web_app_setup_main_button with is_visible=true, the main button should be displayed (replacing the tab bar) only after the first tap inside of the webview, to prevent bots from immediately blocking the tab bar.

Otherwise, the main button can be displayed right away with no user interaction when receiving a web_app_setup_main_button event with is_visible=true.

web_app_setup_back_button

Event data: a JSON object with an is_visible boolean field.

Determines whether to show or hide the back button: when the user presses it a back_button_pressed event should be emitted by the client.
Note that on supported platforms, the OS back button can be used instead of a custom back button: in this case, if is_visible is true pressing the OS back button should emit a back_button_pressed event, otherwise the webview should be closed.

web_app_setup_settings_button

Event data: a JSON object with an is_visible boolean field.

Determines whether to show or hide the settings button: when the user presses it a settings_button_pressed event should be emitted by the client.

payment_form_submit

Event payload: JSON object with credentials and title fields.

  • title is the censored credit card title.
  • credentials is a service-specific JSON object with information about the payment credentials provided by the user to the payment system.

Neither Telegram, nor bots will have access to your credit card information.
Credit card details will be handled only by the payment system, see the payment documentation for more info ».

share_score

No event payload.

Will be called by games when the user explicitly clicks on the share score button to share the game, along with their score.
Typically done by using messages.forwardMessages on the game message with the with_my_score flag.

share_game

No event payload.

Will be called by games when the user explicitly clicks on the share game button to share the game, without sharing their score.
Typically done by using messages.forwardMessages on the game message without the with_my_score flag, or by sharing the game's deep link.

resize_frame

Event payload: JSON object with height field.

Called by supported pages inside of IV iframe embeds, indicates the new size of the embed frame.

web_app_allow_scroll

 

web_app_setup_swipe_behavior

 

web_app_set_bottom_bar_color

 

web_app_setup_secondary_button

 

web_app_share_to_story

 

web_app_request_fullscreen

 

web_app_exit_fullscreen

 

web_app_start_accelerometer

 

web_app_stop_accelerometer

 

web_app_start_gyroscope

 

web_app_stop_gyroscope

 

web_app_start_device_orientation

 

web_app_stop_device_orientation

 

web_app_add_to_home_screen

 

web_app_check_home_screen

 

web_app_set_emoji_status

 

web_app_request_emoji_status_access

 

web_app_request_safe_area

 

web_app_request_content_safe_area

 

web_app_request_location

 

web_app_check_location

 

web_app_open_location_settings

 

web_app_request_file_download

 

web_app_send_prepared_message

 

web_app_toggle_orientation_lock

 

loaded

 

height

 

credentials

 

title

 

Telegram
Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed.
About
Mobile Apps
Desktop Apps
Platform
About
Blog
Press
Moderation