tgbotapi.core/dev.inmo.tgbotapi.requests.webhook/SetWebhook

SetWebhook

@Serializable

data class SetWebhook : SetWebhookRequest, DataRequest<Boolean>

Represents a request for setting a webhook in Telegram's Bot API. A webhook allows Telegram to send updates directly to the bot via an HTTPS POST request to the provided URL, enabling real-time interaction.

Throws

IllegalArgumentException

if the provided maxAllowedConnections value is outside the permitted range (both allowedConnectionsLength and allowedConnectionsWithLocalServerLength)

Properties

allowedUpdates

@SerialName(value = "allowed_updates")

val allowedUpdates: List<String>?

A list of update types the bot will receive. Defaults to all update types.

certificateFile

@SerialName(value = "certificate")

val certificateFile: String? = null

An optional path to a public certificate file for webhook verification. Use only if a self-signed certificate is applied.

dropPendingUpdates

@SerialName(value = "drop_pending_updates")

val dropPendingUpdates: Boolean? = null

If true, all pending updates will be dropped when the webhook is changed.

ipAddress

@SerialName(value = "ip_address")

val ipAddress: String? = null

The fixed IP address for incoming webhook connections.

maxAllowedConnections

@SerialName(value = "max_connections")

val maxAllowedConnections: Int? = null

The maximum number of simultaneous HTTPS connections allowed to the webhook for delivering updates. You may use value outside of allowedConnectionsLength, but be sure that it is in allowedConnectionsWithLocalServerLength and you are using local bot api url

requestSerializer

open override val requestSerializer: SerializationStrategy<*>

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<Boolean>

secretToken

@SerialName(value = "secret_token")

val secretToken: String? = null

An optional arbitrary secret key to ensure the webhook updates are coming from Telegram.

url

@SerialName(value = "url")

val url: String

The HTTPS URL to which updates will be posted. Must be valid and accessible.

Functions

method

open override fun method(): String