Comment on page

Standard Entities

This section lists the Structured Objects available for use in messages.

Standard Entities
Article
Field
Required
Format
Description
title
Yes
String
The headline of the article
subTitle
No
String
The subtitle of the article
blurb
No
String
A summary of the article to display
date
No
​Unix Epoch Timestamp​
Date of publication
publisher
No
String
Name of the publisher
author
No
String
Name of the author
thumbnail
No
URL (could be a data url)
Image to be displayed - 106x106px
id
Must provide either id or href, or both.
String
An identifier used by the application to deeplink to the article
href
Must provide either id or href, or both.
URL
URL to the article (opened in a new browser window)
Financial Objects
org.symphonyoss.fin.security
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to org.symphonyoss.fin.security.
id
Yes
Array of Objects
An array of one or more of the following objects: org.symphonyoss.fin.security.id.ticker org.symphonyoss.fin.security.id.isin org.symphonyoss.fin.security.id.cusip org.symphonyoss.fin.security.id.openfigi  More information about these objects is provided below.
org.symphonyoss.fin.security.id.ticker
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to org.symphonyoss.fin.security.id.ticker.
value
Yes
String
The name/ID of a ticker.
org.symphonyoss.fin.security.id.isin
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to org.symphonyoss.fin.security.id.isin.
value
Yes
String
The entity's ID.
org.symphonyoss.fin.security.id.cusip
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to org.symphonyoss.fin.security.id.cusip.
value
Yes
String
The entity's ID.
org.symphonyoss.fin.security.id.openfigi
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to org.symphonyoss.fin.security.id.openfigi.
value
Yes
String
The entity's ID.
FDC3 Action buttons
FDC3 action buttons allow chat bots to embed buttons in messages which, on click, will raise an intent. 
Action buttons are only displayed to users who have a Desktop Integration Platform (DIP) set up, such as Finsemble, Glue42 or OpenFin.
Learn more about Desktop Interop and intents here. 
MessageML (message property)
<messageML> This is a FDC3 action button: 
    <br/>
    <span class="entity" data-entity-id="0">View Chart 
        <span class="tempo-text-color--red" style="font-size: 10px">
            <i>(Action button: Desktop Integration Platform is not available.) </i>
        </span>
    </span>
</messageML>
Note: Please see above the default text that would be displayed to users who don't have a desktop integration platform set up.
EntityJSON part (data property)
{
"0":
    {
    "actionData":
        {
        "context":
            {
            "id":
                {
                "ticker": "TSLA"
                },
            "name": "Tesla, inc.",
            "type": "fdc3.instrument"
            },
        "intent": "ViewChart"
        },
    "label": "View a chart",
    "type": "fdc3.entity.action",
    "version": "1.2"
    }
}
Display in Symphony:
Users with a DIP
Users without a DIP
On click, Symphony will raise the embedded intent.
​
Image
Field
Required
Format
Description
type
Yes
String
The type of entity. Must be set to com.symphony.media.image.
version
Yes
String
The version.
format
Yes
String
The data format. Must be set to image.
url
Yes
String
The URL of the image.
Taxonomy (mention)
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to com.symphony.user.mention.
version
Yes
String
The object's version.
id
Yes
Array of objects
An array of one or more of the following objects: 
• com.symphony.user.userId
More information about these objects is provided below.
com.symphony.user.userId
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to com.symphony.user.userId.
value
Yes
String
The ID of a user.
Video
Field
Required
Format
Description
type
Yes
String
The type of object. Must be set to com.symphony.media.video.
version
Yes
String
The version.
format
Yes
String
The video's format. Must be set to youtube or vimeo.
url
Yes
String
The URL of the video.
id
Yes
String
The unique ID of the video (can be extracted from the video URL).
Go further...
Continue here to learn more about structured objects:
Custom Entities
​

Last modified 7mo ago

Field	Required	Format	Description
`title`	Yes	String	The headline of the article
`subTitle`	No	String	The subtitle of the article
`blurb`	No	String	A summary of the article to display
`date`	No	Unix Epoch Timestamp	Date of publication
`publisher`	No	String	Name of the publisher
`author`	No	String	Name of the author
`thumbnail`	No	URL (could be a data url)	Image to be displayed - 106x106px
`id`	Must provide either `id` or `href`, or both.	String	An identifier used by the application to deeplink to the article
`href`	Must provide either `id` or `href`, or both.	URL	URL to the article (opened in a new browser window)