Skip to main content

Properties

string
required
The action ID from the button (matches Button’s id prop)
required
The adapter that received the event
string
required
The message ID containing the card
unknown
required
Platform-specific raw event data
Thread<TRawMessage, unknown> | null
required
Type: ThreadThe thread where the action occurred (null for view-based actions like home tab buttons)
string
required
The thread ID
string
Trigger ID for opening modals (required by some platforms, may expire quickly)
required
User who clicked the button
string
Optional value/payload from the button

Methods

openModal()

Open a modal/dialog form in response to this action.

Parameters

The modal element to display (JSX or ModalElement)

Returns

Promise<{ viewId: string } | undefined> The view/dialog ID, or undefined if modals are not supported