Embed Field Reference
This article explains what the Embed field is and how to configure it in the Custom Type builder.
The Embed field allows you to add a valid oEmbed URL, like YouTube, Vimeo, or Soundcloud.
You can read more about the oEmbed format, view a list of supported providers, and see more examples of JSON responses on the oEmbed website.
When configuring an Embed field, you'll see the options to set the Field name, API ID, and Field placeholder.
Slice Machine vs. Legacy Editor
Editing fields is almost identical in Slice Machine and the Legacy editor. But it is important to know that the mock config option (to add data to preview content fields in the Slice Simulator) is only available in Slice Machine.
Edit the JSON model with caution
Only edit the JSON model to make changes to the Rich Text field labels. Making abrupt changes can cause conflicts when synchronizing changes with your documents.
type
string (required)
Value must be Embed
config
object
Object for the configuration options
config.label
string
The label that shows up for the field in the document editor
config.placeholder
string
A user-friendly placeholder for the field in the entry editor
"example_embed": {
"type": "Embed",
"config": {
"label": "oEmbed Link",
"placeholder": "Paste an oEmbed supported service resource URL"
}
}
Here is an API response example of an Embed field with the API ID of example_embed:
// API response example of an Embed field
{
// ...
"example_embed":{
"height":113,
"width":200,
"embed_url":"https://www.youtube.com/watch?v=GtuLg6hcV3w",
"type":"video",
"version":"1.0",
"title":"Prismic — Basics",
"author_name":"Prismic",
"author_url":"https://www.youtube.com/channel/UCJq6AEgtWeZt7ziQ-fLKOeA",
"provider_name":"YouTube",
"provider_url":"https://www.youtube.com/",
"cache_age":null,
"thumbnail_url":"https://i.ytimg.com/vi/GtuLg6hcV3w/hqdefault.jpg",
"thumbnail_width":480,
"thumbnail_height":360,
"html":"<iframe width=\"200\" height=\"113\" src=\"https://www.youtube.com/embed/GtuLg6hcV3w?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>"
}
}
Was this article helpful?
Can't find what you're looking for? Spot an error in the documentation? Get in touch with us on our Community Forum or using the feedback form above.