Struct telbot_types::webhook::SetWebhook

pub struct SetWebhook {
    pub url: String,
    pub certificate: Option<InputFile>,
    pub ip_address: Option<String>,
    pub max_connections: Option<u32>,
    pub allowed_updates: Option<Vec<String>>,
    pub drop_pending_updates: Option<bool>,
}

Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

If you’d like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot’s token, you can be pretty sure it’s us.

Fields

url: String

HTTPS url to send updates to. Use an empty string to remove webhook integration

certificate: Option<InputFile>

Upload your public key certificate so that the root certificate in use can be checked. See Telegram’s self-signed guide for details.

ip_address: Option<String>

The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

max_connections: Option<u32>

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.

allowed_updates: Option<Vec<String>>

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 getUpdates, so unwanted updates may be received for a short period of time.

drop_pending_updates: Option<bool>

Pass True to drop all pending updates

Implementations

impl SetWebhook

pub fn new(url: String) -> Self

Create a new setWebhook request that sets the webhook url.

pub fn remove_previous() -> Self

Create a new setWebhook request that removes previous webhook.

pub fn with_certificate(self, cert: InputFile) -> Self

Set custom certificate for the webhook

pub fn with_ip_address(self, ip_address: impl Into<String>) -> Self

Set ip address to be used to send webhook request

pub fn with_max_connections(self, max_connections: u32) -> Self

Set maximum simultaneous webhook request count

pub fn drop_pending_updates(self) -> Self

Drop all pending updates

Trait Implementations

impl FileMethod for SetWebhook

fn files(&self) -> Option<HashMap<&str, &InputFile>>

impl Serialize for SetWebhook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TelegramMethod for SetWebhook

type Response = bool

fn name() -> &'static str