SetWebhookRequest

data class SetWebhookRequest(url: String, certificate: Any?, ip_address: String?, max_connections: Long?, allowed_updates: List<String>?, drop_pending_updates: Boolean?) : TelegramRequest

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.

Notes
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for Webhooks: 443, 80, 88, 8443.

NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks.

Constructors

SetWebhookRequest
Link copied to clipboard
fun SetWebhookRequest(url: String, certificate: Any? = null, ip_address: String? = null, max_connections: Long? = null, allowed_updates: List<String>? = null, drop_pending_updates: Boolean? = null)

Properties

allowed_updates
Link copied to clipboard
val allowed_updates: List<String>? = null
A JSON-serialized list of the update types you want your bot to receive.
certificate
Link copied to clipboard
val certificate: Any? = null
Upload your public key certificate so that the root certificate in use can be checked.
drop_pending_updates
Link copied to clipboard
val drop_pending_updates: Boolean? = null
Pass True to drop all pending updates
ip_address
Link copied to clipboard
val ip_address: String? = null
The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
max_connections
Link copied to clipboard
val max_connections: Long? = null
Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100.
url
Link copied to clipboard
val url: String
HTTPS url to send updates to.