Skip to content

set_webhook

Use this method to specify a URL and receive incoming updates via an outgoing webhook.

Parameters

  • url (str): HTTPS URL to send updates to. Use an empty string to remove webhook integration, defaults to None
  • certificate (Path or bytes or str) (optional): Upload your public key certificate so that the root certificate in use can be checked, defaults to None
  • ip_address (str) (optional): The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS, defaults to None
  • max_connections (int) (optional): The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput, defaults to None
  • allowed_updates (List of str) (optional): **A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.

Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. Defaults to None - drop_pending_updates (bool) (optional): Pass True to drop all pending updates, defaults to None - secret_token (str) (optional): A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. Defaults to None**

Returns

bool

Examples

  • Required Parameters
await bot.set_webhook(
    url=your_url_here
)
  • All Parameters
await bot.set_webhook(
    url=your_url_here,
    certificate=your_certificate_here,
    ip_address=your_ip_address_here,
    max_connections=your_max_connections_here,
    allowed_updates=your_allowed_updates_here,
    drop_pending_updates=your_drop_pending_updates_here,
    secret_token=your_secret_token_here
)