Work object 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, "work_object_mention".	Required
entity_id	String	The ID of the Work Object entity.	Required
app_id	String	The ID of the app associated with the Work Object.	Required
text	String	The display text for the Work Object reference.	Required
url	String	The URL of the Work Object.	Required
icon_url	String	Optional product icon URL for the Work Object.	Optional
full_size_preview_enabled	Boolean	Whether the Work Object supports full size preview.	Optional
product_name	String	The product name for the Work Object. Used to determine per-product click behavior preferences.	Optional
style	Object	An object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, unlink, and underline.	Optional

Example

JSON

{
    "blocks": [
        {
            "type": "rich_text",
            "elements": [
                {
                    "type": "rich_text_section",
                    "elements": [
                        {
                            "type": "work_object_mention",
                            "entity_id": "E123ABC456",
                            "app_id": "A123ABC456",
                            "text": "Work object",
                            "url": "https://example.com/work-object"
                        }
                    ]
                }
            ]
        }
    ]
}

View in Block Kit Builder