This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.
To finish customizing the event, you may want to include a detailed description enhanced with images, videos, and other rich content. For example, if you have a concert event, you could embed a video teaser within the event's description.
To add a detailed description to an event:
Save the event ID of the event you created.
Generate the content you want to include using the Rich Content playground. For example:
{
"nodes": [
{
"type": "PARAGRAPH",
"id": "d40ny127",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Checkout out the concert from a previous year:"
}
}
]
},
{
"type": "VIDEO",
"id": "12k6s126",
"videoData": {
"containerData": {
"width": {
"size": "CONTENT"
},
"alignment": "CENTER",
"textWrap": true
},
"video": {
"src": {
"url": "https://www.youtube.com/watch?v=Fpn1imb9qZg"
},
"duration": 289
}
}
},
{
"type": "PARAGRAPH",
"id": "9822l128"
}
]
}Copy the generated document object.
Call Create Rich Content passing the document object together with the event ID where the description should be applied. The event description is automatically populated with the provided rich content.
Rich content ID.
Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.
Date and time when rich content was created.
Date and time the rich content was updated.
ID of the event to which rich content is applied.
Field name whose value uses rich content. For the event description, specify the about value.
Rich content of the event description.
See Ricos document referenceCustom field data for the rich content object.
Note: You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
{
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"revision": "1",
"createdDate": "2020-10-18T13:40:58.304800Z",
"updatedDate": "2020-10-18T13:40:58.304800Z",
"eventId": "cd3b6e8c-29b3-4470-9147-075ebae2794a",
"fieldName": "about",
"content": {
"nodes": [
{
"type": "PARAGRAPH",
"id": "fja1e120",
"nodes": [
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Embark on an extraordinary voyage through the vast expanse of the cosmos. Join us for "
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": "Cosmic Odyssey: Exploring the Mysteries of the Universe",
"decorations": [
{
"type": "BOLD",
"fontWeightValue": 700
}
]
}
},
{
"type": "TEXT",
"id": "",
"textData": {
"text": " where the boundaries of human knowledge will be shattered. Prepare to be awe-struck as leading astrophysicists, renowned astronomers, and space explorers come together to unravel the enigmas of our universe."
}
}
]
},
{
"type": "IMAGE",
"id": "zxh2h436",
"imageData": {
"containerData": {
"width": {
"size": "CONTENT"
},
"alignment": "CENTER",
"textWrap": true
},
"image": {
"src": {
"id": "8bb438_2a22b3e85bb1434e81f6fbd4878fb4ae.jpg"
},
"width": 5600,
"height": 3728
}
}
}
]
}
}