Skip to main content

Salesforce data field 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, "salesforce_data_field".Required
salesforce_record_idStringThe ID of the Salesforce record to reference.Required
salesforce_field_labelStringThe Salesforce field label.Optional
salesforce_field_api_nameStringThe Salesforce field API name.Optional
salesforce_include_field_labelBooleanWhen true, display the field label before the field value.Optional
styleObjectAn object of optional boolean properties that dictate style: bold, italic, strike, highlight, client_highlight, underline, and unlink.Optional

Example

{
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "salesforce_data_field",
"salesforce_record_id": "001ABC456DEF789"
}
]
}
]
}
]
}

View in Block Kit Builder