Skip to main content

Module wire

Module wire 

Source
Expand description

The JSONL wire protocol shared by the bot-side transport and the botkit-cli driver binary.

Inbound lines (driver -> bot) are Inbound events. Outbound lines (bot -> driver) are Outbound actions. One JSON object per line, on stdin/stdout or a unix-socket connection.

Structs§

InboundButton
An inline-button press.
InboundCommand
A /name args invocation.
InboundEdited
A message whose text was edited.
InboundMessage
A plain or media message.
InboundReaction
Reactions added and removed on a message.
OutboundAck
An injected event was accepted for dispatch.
OutboundAction
A chat action indicator (typing and friends).
OutboundDelete
A message the bot deleted.
OutboundEdit
A message the bot edited.
OutboundError
An inbound line failed to parse or an event could not be delivered.
OutboundFile
A file the bot sent. path stays a local reference — the platform does not copy bytes — while in-memory payloads travel base64’d in data.
OutboundMessage
A text message the bot sent.
OutboundPin
A message the bot pinned or unpinned.
OutboundReaction
Reaction(s) the bot set on a message.
WireButton
One inline-keyboard button.
WireFile
A file attached to an inbound message.
WireReplyRef
The message an inbound message replies to.
WireSticker
A sticker attached to an inbound message.
WireUser
A user attached to an inbound event.

Enums§

Inbound
An event a driver injects into the bot.
Outbound
An action the bot performed, streamed to subscribers.