Skip to main content

​
Properties

​
Adapter
required
The adapter that received this event
​
string
required
The callback ID specified when creating the modal
​
string
The private metadata string set when the modal was created. Use this to pass arbitrary context (e.g., JSON) through the modal lifecycle.
​
unknown
required
Raw platform-specific payload
​
Channel<Record<string, unknown>, TRawMessage>
Type: ChannelThe channel where the modal was originally triggered from. Available when the modal was opened via SlashCommandEvent.openModal().
​
SentMessage<TRawMessage>
Type: SentMessageThe message that contained the action which opened the modal. Available when the modal was opened from a message action via ActionEvent.openModal(). This is a SentMessage with edit/delete capabilities.
​
Thread<Record<string, unknown>, TRawMessage>
Type: ThreadThe thread where the modal was originally triggered from. Available when the modal was opened via ActionEvent.openModal().
​
Author
required
The user who submitted the modal
​
Record<string, string>
required
Form field values keyed by input ID
​
string
required
Platform-specific view/dialog ID