Skip to main content

Workflow 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

FieldTypeDescriptionRequired?
typeStringThe type of object; in this case, "workflow_mention".Required
workflow_idStringThe ID of the workflow to link to.Required
function_trigger_idStringThe ID of the function trigger for the workflow.Required
textStringThe display text for the workflow link.Required
urlStringURL of the workflow.Optional
channel_idStringThe encoded channel ID where this workflow mention lives.Optional
tsStringThe encoded message timestamp where this workflow mention lives.Optional
styleObjectAn object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, unlink, and underline.Optional

Example

{
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "workflow_mention",
"workflow_id": "Wf123ABC456",
"function_trigger_id": "Ft123ABC456",
"text": "Run workflow"
}
]
}
]
}
]
}

View in Block Kit Builder