Skip to main content

Module blocks

Module blocks 

Source
Expand description

Slack Block Kit types (blocks, elements, composition objects), plus message attachments, views and message metadata.

Structs§

ActionCell
A cell holding a button (data table blocks only). https://docs.slack.dev/reference/block-kit/blocks/data-table-block
ActionsBlock
A block that holds interactive elements. https://docs.slack.dev/reference/block-kit/blocks/actions-block
AlertBlock
A block that shows an alert, warning or informational message (modals only). https://docs.slack.dev/reference/block-kit/blocks/alert-block
AreaChart
An area chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
Attachment
A legacy secondary message attachment (can also hold blocks). https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments
AttachmentField
A field shown in a table inside an attachment. https://docs.slack.dev/legacy/legacy-messaging/legacy-secondary-message-attachments
AttachmentMentionElement
A reference to an app attachment or entity. https://docs.slack.dev/reference/block-kit/block-elements/attachment-mention-element
AxisConfig
X-axis categories and axis labels. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
BarChart
A bar chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
BroadcastElement
A broadcast mention (@here, @channel or @everyone). https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element
ButtonElement
A button. https://docs.slack.dev/reference/block-kit/block-elements/button-element
CanvasElement
A link to a canvas. https://docs.slack.dev/reference/block-kit/block-elements/canvas-element
CanvasMessageUnfurlElement
An inline preview of a message inside a canvas. https://docs.slack.dev/reference/block-kit/block-elements/canvas-message-unfurl-element
CanvasUserMentionElement
A user mention inside canvas content. https://docs.slack.dev/reference/block-kit/block-elements/canvas-user-mention-element
CardBlock
A card. https://docs.slack.dev/reference/block-kit/blocks/card-block
CarouselBlock
A horizontally scrolling row of cards. https://docs.slack.dev/reference/block-kit/blocks/carousel-block
ChannelElement
A channel mention. https://docs.slack.dev/reference/block-kit/block-elements/channel-element
ChannelsSelectElement
A select menu of public channels. https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element
CheckboxesElement
A group of checkboxes. https://docs.slack.dev/reference/block-kit/block-elements/checkboxes-element
CitationElement
An AI citation. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
ColorElement
A color swatch. https://docs.slack.dev/reference/block-kit/block-elements/color-element
ColumnSetting
Settings for a table column (use None for a column that keeps the defaults, sent as null). https://docs.slack.dev/reference/block-kit/blocks/table-block
ConfirmationDialog
A confirmation dialog. https://docs.slack.dev/reference/block-kit/composition-objects/confirmation-dialog-object
ContainerBlock
A container that groups child blocks. https://docs.slack.dev/reference/block-kit/blocks/container-block
ContextActionsBlock
A block that shows feedback buttons and icon buttons as contextual actions. https://docs.slack.dev/reference/block-kit/blocks/context-actions-block
ContextBlock
A block that shows supplementary info in small text and images. https://docs.slack.dev/reference/block-kit/blocks/context-block
ConversationFilter
A filter for conversation select menus. https://docs.slack.dev/reference/block-kit/composition-objects/conversation-filter-object
ConversationsSelectElement
A select menu of conversations. https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element
DataPoint
One data point in a series. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
DataSeries
A data series in a chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
DataTableBlock
A table with pagination, sorting and filtering. https://docs.slack.dev/reference/block-kit/blocks/data-table-block
DataVisualizationBlock
A chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
DateElement
A date formatted for the viewer’s locale and time zone. https://docs.slack.dev/reference/block-kit/block-elements/date-element
DatePickerElement
A date picker. https://docs.slack.dev/reference/block-kit/block-elements/date-picker-element
DatetimePickerElement
A date and time picker. https://docs.slack.dev/reference/block-kit/block-elements/datetime-picker-element
DispatchActionConfig
Configures when typing in an input dispatches a block_actions payload. https://docs.slack.dev/reference/block-kit/composition-objects/dispatch-action-configuration-object
DividerBlock
A divider line. https://docs.slack.dev/reference/block-kit/blocks/divider-block
EmailInputElement
An email input. https://docs.slack.dev/reference/block-kit/block-elements/email-input-element
EmojiElement
An emoji. https://docs.slack.dev/reference/block-kit/block-elements/emoji-element
ExternalCitation
An external app citation source. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
ExternalSelectElement
A select menu that loads options from an external data source. https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element
FeedbackButton
One of the feedback buttons. https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element
FeedbackButtonsElement
Positive and negative feedback buttons. https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element
FileBlock
A remote file (only appears in retrieved messages). https://docs.slack.dev/reference/block-kit/blocks/file-block
FileCitation
A file citation source. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
FileElement
A link to a Slack file. https://docs.slack.dev/reference/block-kit/block-elements/file-element
FileInputElement
A file upload input. https://docs.slack.dev/reference/block-kit/block-elements/file-input-element
HeaderBlock
A header. https://docs.slack.dev/reference/block-kit/blocks/header-block
IconButtonElement
An icon button. https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element
ImageBlock
An image block (either image_url or slack_file). https://docs.slack.dev/reference/block-kit/blocks/image-block
ImageElement
An image element (either image_url or slack_file). https://docs.slack.dev/reference/block-kit/block-elements/image-element
InputBlock
An input field. https://docs.slack.dev/reference/block-kit/blocks/input-block
InputParameter
An input parameter passed to a trigger. https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object
LineChart
A line chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
LinkElement
A hyperlink. https://docs.slack.dev/reference/block-kit/block-elements/link-element
ListRecordElement
A link to a Slack list record. https://docs.slack.dev/reference/block-kit/block-elements/list-record-element
MarkdownBlock
A block that renders standard Markdown. https://docs.slack.dev/reference/block-kit/blocks/markdown-block
MemoryCitation
A memory citation source. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
MessageCitation
A message citation source. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
MessageMentionElement
A link to a Slack message. https://docs.slack.dev/reference/block-kit/block-elements/message-mention-element
MessageMetadata
Metadata attached to a message. https://docs.slack.dev/messaging/message-metadata
Mrkdwn
A mrkdwn text object. https://docs.slack.dev/reference/block-kit/composition-objects/text-object
MultiChannelsSelectElement
A multi-select menu of public channels. https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element
MultiConversationsSelectElement
A multi-select menu of conversations. https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element
MultiExternalSelectElement
A multi-select menu that loads options from an external data source. https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element
MultiStaticSelectElement
A multi-select menu with static options (either options or option_groups). https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element
MultiUsersSelectElement
A multi-select menu of users. https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element
NumberInputElement
A number input. https://docs.slack.dev/reference/block-kit/block-elements/number-input-element
OptionGroup
A group of options. https://docs.slack.dev/reference/block-kit/composition-objects/option-group-object
OptionObject
An option. https://docs.slack.dev/reference/block-kit/composition-objects/option-object
OverflowElement
An overflow menu. https://docs.slack.dev/reference/block-kit/block-elements/overflow-menu-element
PieChart
A pie chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
PlainText
A plain_text text object. https://docs.slack.dev/reference/block-kit/composition-objects/text-object
PlainTextInputElement
A plain-text input. https://docs.slack.dev/reference/block-kit/block-elements/plain-text-input-element
PlanBlock
A collection of related tasks. https://docs.slack.dev/reference/block-kit/blocks/plan-block
PlanTask
A task inside a plan block (has no type). https://docs.slack.dev/reference/block-kit/blocks/plan-block
RadioButtonsElement
A radio button group. https://docs.slack.dev/reference/block-kit/block-elements/radio-button-group-element
RawNumberCell
A numeric cell. https://docs.slack.dev/reference/block-kit/blocks/data-table-block
RawTextCell
A plain text cell. https://docs.slack.dev/reference/block-kit/blocks/data-table-block
RichTextBlock
A rich text block. https://docs.slack.dev/reference/block-kit/blocks/rich-text-block
RichTextInputElement
A rich text input. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-input-element
RichTextList
A rich text list. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-list-element
RichTextPreformatted
A rich text preformatted (code) block. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element
RichTextQuote
A rich text quote. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-quote-element
RichTextSection
A rich text section. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-section-element
RichTextStyle
Styling for a rich text element. https://docs.slack.dev/reference/block-kit/block-elements/text-element
SalesforceDataFieldElement
A reference to a Salesforce data field. https://docs.slack.dev/reference/block-kit/block-elements/salesforce-data-field-element
SectionBlock
The basic block for text, optionally alongside an element. https://docs.slack.dev/reference/block-kit/blocks/section-block
Segment
One slice of a pie chart. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
SlackFile
A Slack file used as an image (either url or id). https://docs.slack.dev/reference/block-kit/composition-objects/slack-file-object
SlackIcon
A built-in Slack icon. https://docs.slack.dev/reference/block-kit/composition-objects/slack-icon-object
StaticSelectElement
A select menu with static options (either options or option_groups). https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element
TableBlock
A table. https://docs.slack.dev/reference/block-kit/blocks/table-block
TagElement
A colored tag. https://docs.slack.dev/reference/block-kit/block-elements/tag-element
TaskCardBlock
A single task. https://docs.slack.dev/reference/block-kit/blocks/task-card-block
TeamElement
A workspace (team) mention. https://docs.slack.dev/reference/block-kit/block-elements/team-element
TextElement
Text. https://docs.slack.dev/reference/block-kit/block-elements/text-element
TimePickerElement
A time picker. https://docs.slack.dev/reference/block-kit/block-elements/time-picker-element
Trigger
A workflow link trigger. https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object
UrlInputElement
A URL input. https://docs.slack.dev/reference/block-kit/block-elements/url-input-element
UrlSourceElement
A URL source shown in a task card block. https://docs.slack.dev/reference/block-kit/block-elements/url-source-element
UserElement
A user mention. https://docs.slack.dev/reference/block-kit/block-elements/user-element
UsergroupElement
A user group mention. https://docs.slack.dev/reference/block-kit/block-elements/usergroup-element
UsersSelectElement
A select menu of users. https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element
VideoBlock
An embedded video. https://docs.slack.dev/reference/block-kit/blocks/video-block
View
A view for views.open / publish / update / push (the later fields are only returned by Slack). https://docs.slack.dev/reference/views
ViewState
Current input values (block_id -> action_id -> value). Kept as raw JSON because the shape differs by element type.
WebCitation
A web page citation source. https://docs.slack.dev/reference/block-kit/block-elements/citation-element
WorkObjectMentionElement
A reference to a Work Object. https://docs.slack.dev/reference/block-kit/block-elements/work-object-mention-element
Workflow
The workflow run by a workflow button. https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object
WorkflowButtonElement
A button that runs a workflow. https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element
WorkflowMentionElement
A link to a workflow. https://docs.slack.dev/reference/block-kit/block-elements/workflow-mention-element

Enums§

ActionCellFallback
The cell shown instead of the button on clients that do not support action cells. https://docs.slack.dev/reference/block-kit/blocks/data-table-block
ActionsElement
An element allowed in an actions block. https://docs.slack.dev/reference/block-kit/blocks/actions-block
AlertLevel
The level of an alert block. Unknown values go to Other.
AttachmentTs
The ts of an attachment. Sent as a number, but returned as a string (e.g. "1503435956.000247") in places such as message unfurls.
Block
A layout block. https://docs.slack.dev/reference/block-kit/blocks
BroadcastRange
The range of a broadcast mention. Unknown values go to Other.
ButtonStyle
The color scheme of a button. Unknown values go to Other.
Chart
The chart payload for each chart type. https://docs.slack.dev/reference/block-kit/blocks/data-visualization-block
CitationDetails
Details of a citation source (the kind is set by citation_type). https://docs.slack.dev/reference/block-kit/block-elements/citation-element
ColumnAlign
Column alignment. Unknown values go to Other.
ContainerWidth
The width of a container block. Unknown values go to Other.
ContextActionsElement
An element allowed in a context actions block. https://docs.slack.dev/reference/block-kit/blocks/context-actions-block
ContextElement
An element allowed in a context block (images and text). https://docs.slack.dev/reference/block-kit/blocks/context-block
ConversationType
A conversation type. Unknown values go to Other.
DataTableCell
A cell in a data table block. https://docs.slack.dev/reference/block-kit/blocks/data-table-block
InputElement
An element allowed in an input block. https://docs.slack.dev/reference/block-kit/blocks/input-block
PreformattedElement
An element allowed in a preformatted block (text and links). https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element
RichTextElement
An inline rich text element used in sections, lists and quotes. https://docs.slack.dev/reference/block-kit/block-elements/rich-text-section-element
RichTextListStyle
The style of a rich text list. Unknown values go to Other.
RichTextObject
A top-level element of a rich text block. https://docs.slack.dev/reference/block-kit/blocks/rich-text-block
SectionAccessory
An element allowed as the accessory of a section block. https://docs.slack.dev/reference/block-kit/blocks/section-block
TableCell
A cell in a table block. https://docs.slack.dev/reference/block-kit/blocks/table-block
TagColor
The color of a tag. Unknown values go to Other.
TaskStatus
The status of a task. Unknown values go to Other.
TextObject
A text object (plain_text or mrkdwn). https://docs.slack.dev/reference/block-kit/composition-objects/text-object
TriggerAction
An event that dispatches a block_actions payload. Unknown values go to Other.
ViewType
The type of a view. Unknown values go to Other.