-
Notifications
You must be signed in to change notification settings - Fork 621
MM Blocks Documentation #9013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
MM Blocks Documentation #9013
Changes from all commits
ed6cdfb
0dc201a
e125609
5154279
0d690d9
06075f3
fd769ea
dac9ec4
9546117
8fc2fcc
ae2f314
38d1110
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -147,6 +147,8 @@ Integrations | |
| +-----------------------------------------------------------------------------------------------------------------+-------------+-------------+-----------------+ | ||
| | `Outgoing webhooks <https://developers.mattermost.com/integrate/webhooks/outgoing/>`_ | |checkmark| | |checkmark| | |checkmark| | | ||
| +-----------------------------------------------------------------------------------------------------------------+-------------+-------------+-----------------+ | ||
| | `MM Blocks <https://developers.mattermost.com/integrate/reference/mm-blocks/>`_ [1]_ | Conditional | Conditional | Conditional | | ||
| +-----------------------------------------------------------------------------------------------------------------+-------------+-------------+-----------------+ | ||
| | `Message attachments <https://developers.mattermost.com/integrate/reference/message-attachments/>`_ | |checkmark| | |checkmark| | |checkmark| | | ||
| +-----------------------------------------------------------------------------------------------------------------+-------------+-------------+-----------------+ | ||
| | `Message buttons <https://developers.mattermost.com/integrate/plugins/interactive-messages/#message-buttons>`_ | |checkmark| | |checkmark| | |checkmark| | | ||
|
|
@@ -158,6 +160,8 @@ Integrations | |
| | `Right-hand sidebar <https://developers.mattermost.com/integrate/reference/server/server-reference/>`_ | |checkmark| | |checkmark| | | | ||
| +-----------------------------------------------------------------------------------------------------------------+-------------+-------------+-----------------+ | ||
|
|
||
| .. [1] Requires ``MM_FEATUREFLAGS_MMBLOCKSENABLED`` to be enabled on the Mattermost server (defaults to ``true``). When set to ``false``, clients do not render native MM Blocks payloads and the server rejects MM Blocks action requests. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably unnecessary given this is more about client availability. |
||
|
|
||
| Authentication | ||
| ~~~~~~~~~~~~~~ | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,7 +48,18 @@ What are attachments? | |
|
|
||
| When "attachments" are mentioned in Mattermost integrations documentation, it refers to Slack's message attachments functionality. These "attachments" can be optionally added as an array in the data sent by an integration, and are used to customize the formatting of the message. | ||
|
|
||
| Mattermost doesn't currently support the ability to attach files to a post made via webhook. You can use the API to attach files to a message if needed. | ||
| Mattermost doesn't currently support the ability to attach files to a post made via webhook. You can use the API to attach files to a message if needed. | ||
|
|
||
| What are MM Blocks? | ||
| -------------------- | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Propose move the content from mm-blocks.rst to here to give docs readers an understanding of what blocks are, but it links them to dev docs for full technical details. Also include that they are a replacement for message attachments starting in Mattermost vx.xx and if there's any need to know info for migrating? |
||
|
|
||
| MM Blocks are Mattermost's structured format for rich, interactive integration posts. Integrations can extend messages with text, images, buttons, menus, collapsible sections, and different layout options. | ||
|
|
||
| Starting in Mattermost v11.10, MM Blocks are the recommended replacement for `message attachments <https://developers.mattermost.com/integrate/reference/message-attachments/>`_. They are the preferred way to create interactive messages for integrations such as :doc:`incoming webhooks </integrations-guide/incoming-webhooks>`, plugins, and bot accounts. | ||
|
|
||
| Legacy message attachments and other interactive message formats continue to work; clients translate them into the MM Blocks format at render time. We encourage new and updated integrations to use MM Blocks instead. | ||
|
|
||
| For payload structure, block types, action handling, migration guidance, and troubleshooting, see the `MM Blocks reference <https://developers.mattermost.com/integrate/reference/mm-blocks/>`_ in the developer documentation. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When will this page be live?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here is the PR: mattermost/mattermost-developer-documentation#1508 Not sure if you want to review it before we merge. I was waiting for both to be ready before merging. |
||
|
|
||
| Where can I find existing integrations? | ||
| --------------------------------------- | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is "MM Blocks" the external facing / marketing name for this feature?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we had a "external facing / marketing naming" discussion. It is what I have gravitated to. Happy to update it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest discussing with Keith Casey (@caseysoftware) so we can land on a product name for this functionality.