Canvas 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".	Required
file_id	String	The ID of the canvas to link to.	Required
label	String	What the canvas is labeled.	Optional
hide_title	Boolean	Whether the title should be hidden.	Optional
section_id	String	The section ID.	Optional
style	Object	An object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, underline, and unlink.	Optional
text	String	Title of the canvas.	Optional
url	String	URL of the canvas.	Optional
is_skill_invocation	Boolean	True when this canvas element was inserted as a skill invocation.	Optional

Example

JSON

{
    "blocks": [
        {
            "type": "rich_text",
            "elements": [
                {
                    "type": "rich_text_section",
                    "elements": [
                        {
                            "type": "canvas",
                            "file_id": "F123ABC456"
                        }
                    ]
                }
            ]
        }
    ]
}

View in Block Kit Builder