With the Rich Content API, you can create and manage rich content. Use this API, for example, to add a detailed description after you create an event.
The Rich Content API allows you to:
The following table shows field support for filters and sorting for the Rich Content object:
Field | Query Filter Operators | Sortable |
---|---|---|
id | $eq , $ne , $in , $nin , $hasSome , $startsWith | Sortable |
eventId | $eq , $ne , $in , $nin , $hasSome , $startsWith | Sortable |
fieldName | $eq , $ne , $in , $nin , $hasSome , $startsWith | Sortable |
Related content: API Query Language, Query Rich Content endpoint
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.
This field uses Ricos Document, a structured rich content data format. For a quick start, copy the JSON content from the sample playground below. Learn more about Rich Content (SDK | REST).
video
spoiler
linkPreview
link
lineSpacing
indent
image
html
heading
hashtag
giphy
gallery
file
emoji
divider
collapsibleList
codeBlock
audio
Custom 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
}
}
}
]
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This method has been replaced with Events V3's Create Event and will be removed on April 15, 2025. To create an event description with rich content, use the description
field.
If your app uses this method, we recommend updating your code as soon as possible.
Creates rich content, such as for an event description.
This method passes rich content value to the description of an already created event.
You can only call this method when authenticated as a Wix app or Wix user identity.
Rich content details.
Created rich content.
curl -X POST 'https://www.wixapis.com/events/v1/rich-content' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d' {
"richContent":{
"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
}
}
}
]
}
}
}'
{
"richContent": {
"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
}
}
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This method has been replaced with Events V3's Get Event and will be removed on April 15, 2025. The rich content of an event description is now returned in the description
field.
If your app uses this method, we recommend updating your code as soon as possible.
Retrieves rich content of an event's field.
Rich content ID.
The requested rich content.
curl -X GET 'https://www.wixapis.com/events/v1/rich-content/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \
-H 'Authorization: <AUTH>' \
{
"richContent": {
"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
}
}
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This method has been replaced with Events V3's Update Event and will be removed on April 15, 2025. To delete an event description with rich content, use the description
field.
If your app uses this method, we recommend updating your code as soon as possible.
Deletes rich content from the event description.
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of rich content to delete.
curl -X DELETE 'https://www.wixapis.com/events/v1/rich-content/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \
-H 'Authorization: <AUTH>' \
{}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This method has been replaced with Events V3's Update Event and will be removed on April 15, 2025. To update an event description with rich content, use the description
field.
If your app uses this method, we recommend updating your code as soon as possible.
Each time rich content is updated, revision
increments by 1. The current revision
must be passed when updating rich content. This ensures you're working with the latest rich content and prevents unintended overwrites.
You can only call this method when authenticated as a Wix app or Wix user identity.
Rich content ID.
Fields to update.
Updated rich content.
curl -X PATCH 'https://www.wixapis.com/events/v1/rich-content/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d' {
"richContent":{
"id": "cd3b6e8c-29b3-4470-9147-075ebae2794a",
"revision": "1"
"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
}
}
}
]
}
}
}'
{
"richContent": {
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"revision": "2",
"createdDate": "2020-10-18T13:40:58.304800Z",
"updatedDate": "2020-10-19T12:43:56.334300Z",
"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
}
}
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deprecation Notice
This method has been replaced with Events V3's Query Events and will be removed on April 15, 2025. The rich content of an event description is now returned in the description
field.
If your app uses this method, we recommend updating your code as soon as possible.
Retrieves a list of rich content entities, given the provided paging, filtering, and sorting.
Query Rich Content runs with these defaults, which you can override:
createdDate
is sorted in ASC
orderpaging.limit
is 100
paging.offset
is 0
For field support for filters and sorting, see Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Query options. See API Query Language for more details.
List of rich content entities.
Paging metadata.
curl -X POST 'https://www.wixapis.com/events/v1/rich-content/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
"query": {
"filter": {
"id": {
"$eq": "52269077-05f2-4b59-ba4f-36ef8c4c1e11"
}
},
"paging": {
"limit": 2
}
}
}'
{
"richContent": {
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"revision": "2",
"createdDate": "2020-10-18T13:40:58.304800Z",
"updatedDate": "2020-10-19T12:43:56.334300Z",
"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
}
}
}
]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when rich content is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.events.v1.rich_content_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"entityFqdn": "wix.events.v1.rich_content",
"slug": "created",
"entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
"createdEvent": {
"entity": {
"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
}
}
}
]
}
}
},
"eventTime": "2020-10-18T13:40:58.304800Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when rich content is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.events.v1.rich_content_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"entityFqdn": "wix.events.v1.rich_content",
"slug": "deleted",
"entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
"deletedEvent": {},
"eventTime": "2020-10-18T13:40:58.304800Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when rich content is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.events.v1.rich_content_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "52269077-05f2-4b59-ba4f-36ef8c4c1e11",
"entityFqdn": "wix.events.v1.rich_content",
"slug": "updated",
"entityId": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
"updatedEvent": {
"currentEntity": {
"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
}
}
}
]
}
}
},
"eventTime": "2020-10-18T13:40:58.304800Z",
"triggeredByAnonymizeRequest": false
}