Skip to main content

Embed

{
"id": "integer",
"embed_type": "string",
"embed_id": "string",
"url": "string",
"metadata": {}
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyA unique integer value identifying this embed
embed_typestringtruenoneType of the embed, can be any string except sc_vimeo, sc_link or sc_shared_object that are used for embedded objects auomatically created by the community
embed_idstringtruenoneExternal id for the embed object
urlstring(uri)¦nullfalsenoneUrl for the resource, if any
metadatajsonfalsenoneMetadata associated to this embed. It mus be a valid json object. For embed_type sc_vimeo or sc_link it contains metadata associated with the external resource. For embed_type sc_shared_object it contains a field type that is the type of the object (Discussion or Post) and a field id that contains the id of the object shared

Enumerated Values

ParameterValueDescription
embed_typesc_vimeoEmbed of type video uploaded on vimeo platform (when enabled). This type is used internally by the community
embed_typesc_linkEmbed of type link. This type is used internally by the community
embed_typesc_shared_objectEmbed of type shared object. This type is used internally by the community when the user share a Discussion or Post