webhookCallback

^{ref / core / webhookCallback}

Creates a callback function that you can pass to a web framework (such as express) if you want to run your bot via webhooks. Use it like this:

const app = express() // or whatever you're using
const bot = new Bot('<token>')

app.use(webhookCallback(bot, 'express'))

Confer the grammY documentation to read more about how to run your bot with webhooks.

// Overload 1
webhookCallback<C extends Context = Context, A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames>(
  bot: Bot<C>,
  adapter: A,
  webhookOptions?: WebhookOptions,
): (...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>;

// Overload 2
webhookCallback<C extends Context = Context, A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames>(
  bot: Bot<C>,
  adapter: A,
  onTimeout?: WebhookOptions["onTimeout"],
  timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"],
  secretToken?: WebhookOptions["secretToken"],
): (...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>;

Overload 1

^Source

Type Parameters

C

C extends Context = Context

A

A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames

Parameters

bot

bot: Bot<C>

The bot for which to create a callback

adapter

adapter: A

An optional string identifying the framework (default: ‘express’)

webhookOptions

webhookOptions?: WebhookOptions

Further options for the webhook setup

Return Type

(...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>

// Overload 1
webhookCallback<C extends Context = Context, A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames>(
  bot: Bot<C>,
  adapter: A,
  onTimeout?: WebhookOptions["onTimeout"],
  timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"],
  secretToken?: WebhookOptions["secretToken"],
): (...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>;

// Overload 2
webhookCallback<C extends Context = Context, A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames>(
  bot: Bot<C>,
  adapter: A,
  onTimeout?: WebhookOptions["onTimeout"],
  timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"],
  secretToken?: WebhookOptions["secretToken"],
): (...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>;

Overload 2

^Source

Type Parameters

C

C extends Context = Context

A

A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames

Parameters

bot

bot: Bot<C>

adapter

adapter: A

onTimeout

onTimeout?: WebhookOptions["onTimeout"]

timeoutMilliseconds

timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"]

secretToken

secretToken?: WebhookOptions["secretToken"]

Return Type

(...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>

// Overload 1
webhookCallback<C extends Context = Context>(
  bot: Bot<C>,
  adapter: FrameworkAdapter | AdapterNames,
  onTimeout?: WebhookOptions | WebhookOptions["onTimeout"],
  timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"],
  secretToken?: WebhookOptions["secretToken"],
);

// Overload 2
webhookCallback<C extends Context = Context, A extends FrameworkAdapter | AdapterNames = FrameworkAdapter | AdapterNames>(
  bot: Bot<C>,
  adapter: A,
  onTimeout?: WebhookOptions["onTimeout"],
  timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"],
  secretToken?: WebhookOptions["secretToken"],
): (...args: Parameters<ResolveName<A>>) => ReturnType<ResolveName<A>>["handlerReturn"] extends undefined ? Promise<void> : NonNullable<ReturnType<ResolveName<A>>["handlerReturn"]>;

Overload 3

^Source

Type Parameters

C

C extends Context = Context

Parameters

bot

bot: Bot<C>

adapter

adapter: FrameworkAdapter | AdapterNames

onTimeout

onTimeout?: WebhookOptions | WebhookOptions["onTimeout"]

timeoutMilliseconds

timeoutMilliseconds?: WebhookOptions["timeoutMilliseconds"]

secretToken

secretToken?: WebhookOptions["secretToken"]