Canvas user mention element

This is a rich text element, compatible only with the rich_text block. It must be used within the rich_text_list, rich_text_quote, or rich_text_section block element within the rich_text block's elements array.

Fields

Field	Type	Description	Required?
type	String	The type of object; in this case, "canvas_user_mention".	Required
user_id	String	The ID of the user to mention within canvas content.	Required
thread_id	String	The ID of the thread.	Optional
style	Object	An object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, underline, and unlink.	Optional

Example

JSON

{
    "blocks": [
        {
            "type": "rich_text",
            "elements": [
                {
                    "type": "rich_text_section",
                    "elements": [
                        {
                            "type": "canvas_user_mention",
                            "user_id": "U123ABC456"
                        }
                    ]
                }
            ]
        }
    ]
}

View in Block Kit Builder