Skip to main content
Defined in: core/Bot.ts:118 Events the bot emits, by name, with their payload type. Listen with bot.on(name, listener), e.g. bot.on('ready', () => …) or bot.on('error', (err) => …).

​
Properties

​
ready

Defined in: core/Bot.ts:120 Emitted once the provider’s connection state reaches 'ready'.

​
qr

Defined in: core/Bot.ts:122 Emitted with the provider’s auth artifact (QR string / pairing code / OAuth URL).

​
connection

Defined in: core/Bot.ts:124 Emitted on every provider connection-state transition.

​
message

Defined in: core/Bot.ts:126 Emitted after every dispatched inbound message finishes its pipeline.

​
error

Defined in: core/Bot.ts:128 Emitted for any internal/handler error.

​
error

​
ctx?

​
started

Defined in: core/Bot.ts:130 Emitted once start() finishes.

​
stopping

Defined in: core/Bot.ts:136 Emitted once per stop() of a running bot, right after inbound is closed and BEFORE the drain and the transport stop: cancel long work here (model calls, downloads) while the transport can still deliver what is in flight. A throwing listener is reported on 'error'.

​
stopped

Defined in: core/Bot.ts:138 Emitted once stop() finishes.

​
command:unknown

Defined in: core/Bot.ts:140 Emitted by the Dispatcher for an unrecognized /xyz command.

​
ctx

​
command

​
reaction

Defined in: core/Bot.ts:142 Forwarded provider event: someone reacted to a message.

​
poll

Defined in: core/Bot.ts:144 Forwarded provider event: a poll’s aggregated votes changed.

​
call

Defined in: core/Bot.ts:146 Forwarded provider event: a call notification.

​
group

Defined in: core/Bot.ts:148 Forwarded provider event: group participants changed.

​
presence

Defined in: core/Bot.ts:150 Forwarded provider event: a contact’s presence changed.

​
status

Defined in: core/Bot.ts:152 Forwarded provider event: outbound delivery/read receipt.

​
handoff

Defined in: core/Bot.ts:154 A chat was handed off to a human (bot.handoff() / ctx.handoff()).

​
resume

Defined in: core/Bot.ts:156 A handed-off chat was given back to the bot (bot.resume()).

​
conversation:started

Defined in: core/Bot.ts:158 A conversation/flow was entered (trigger match, bot.trigger(), dormant resume, c.goto()).

​
conversation:ended

Defined in: core/Bot.ts:160 A conversation/flow ended — completed, cancelled, timed out, out of retries or errored.

​
coordination:leader

Defined in: core/Bot.ts:162 Multi-replica (coordination): this replica was elected for a singleton (provider:<id>) and starts it.

​
name

​
fence

​
coordination:follower

Defined in: core/Bot.ts:164 Multi-replica: this replica lost (or gave up) a singleton leadership and stands by.

​
name

​
reason?

​
coordination:lease-lost

Defined in: core/Bot.ts:166 Multi-replica: a chat turn or leadership was lost before its release (pause, partition, backend down).

​
Type Declaration

reason

​
coordination:handover

Defined in: core/Bot.ts:171 Multi-replica (coordination.handover): a conversation another replica ran was taken over on this one — resumed, or handled by the hand-over fallback (see outcome).

​
durability:dead

Defined in: core/Bot.ts:176 Durability (BotConfig.durability): an inbound event or a send was dead-lettered after its retries (id is the inbox record id or the outbox key). Replay/retry it through bot.durability.

​
kind

​
id

​
chatId?

​
error

​
durability:ambiguous

Defined in: core/Bot.ts:181 Durability: a send’s outcome is unknown after a crash (the provider was called, the result was never recorded). Handled per durability.outbox.onAmbiguous.

​
key

​
chatId