getWebhookInfo

This page describes the getWebhookInfo() function in zalo-bot-js, used to retrieve the current webhook configuration for the bot.

It is useful for checking whether the bot is currently configured for webhook delivery and for debugging deployment state.

Function signature

getWebhookInfo(): Promise<WebhookInfo | undefined>

When to use it

• check if webhook is configured
• verify the current webhook URL
• debug production deployment state

Return value

Returns Promise<WebhookInfo | undefined>.

interface WebhookInfo {
  url: string;
  updatedAt?: string;
  raw?: JsonObject;
}

Example

const info = await bot.getWebhookInfo();
console.log(info?.url);

Compatibility alias

The SDK still keeps this alias:

const info = await bot.getWebHookInfo();

If you are starting a new project, prefer getWebhookInfo().

Next

• See setWebhook to register a webhook.
• See deleteWebhook to remove the current one.

Last updated: April 5, 2026