About Rich Content

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:

  • Create, delete, update rich content.
  • Get the detailed information about every rich content entity you create.

Before you begin

Use cases

Terminology

  • Rich content: Digital content that includes elements beyond plain text, such as images, videos, and interactive components.
  • Ricos: The technology developed by Wix to enable rich content capabilities.
Did this help?

Rich Content: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Rich Content object:

FieldQuery Filter OperatorsSortable
id$eq, $ne, $in, $nin, $hasSome, $startsWithSortable
eventId$eq, $ne, $in, $nin, $hasSome, $startsWithSortable
fieldName$eq, $ne, $in, $nin, $hasSome, $startsWithSortable

Related content: API Query Language, Query Rich Content endpoint

Did this help?

Rich Content: Sample Use Cases and Flows

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.

Add a detailed description to an event

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:

  1. Save the event ID of the event you created.

  2. Generate the content you want to include using the Rich Content playground. For example:

    Copy
    { "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" } ] }
  3. Copy the generated document object.

  4. 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.

Did this help?

Rich Content Object


Properties
idstringRead-onlyformat GUID

Rich content ID.


revisionintegerRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time when rich content was created.


updatedDatestringRead-onlyformat date-time

Date and time the rich content was updated.


eventIdstringformat GUID

ID of the event to which rich content is applied.


fieldNamestringminLength 1maxLength 50

Field name whose value uses rich content. For the event description, specify the about value.


contentContent

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).

{
"nodes": [
{
"id": "jb38881",
"type": "HEADING",
"nodes": [
{
"id": "",
"type": "TEXT",
"textData": {
"text": "Wix Events"
}
}
],
"headingData": {
"level": 2
}
},
{
"id": "7yqnw110",
"type": "PARAGRAPH"
},
{
"id": "fja1e120",
"type": "PARAGRAPH",
"nodes": [
{
"id": "",
"type": "TEXT",
"textData": {
"text": "Host and showcase your events online. Sell tickets and collect RSVPs. Manage events on-the-go and check in guests with the Wix mobile app."
}
}
]
},
{
Note: This API enables the following Ricos plugins :
videospoilerlinkPreviewlinklineSpacingindentimagehtmlheadinghashtaggiphygalleryfileemojidividercollapsibleListcodeBlockaudio

extendedFieldsExtendedFields

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.

RichContent
JSON
{ "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 } } } ] } }
Did this help?

POST

Create Rich Content


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events-ricos/v1/rich-content

Body Params
richContentRichContentRequired

Rich content details.

Response Object
richContentRichContent

Created rich content.

Create rich content for an event description
Request
cURL
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 } } } ] } } }'
Response
JSON
{ "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 } } } ] } } }
Event TriggersThis method triggers the following events:
Did this help?

GET

Get Rich Content


Developer Preview

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.

Permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/events-ricos/v1/rich-content/{richContentId}

Path Params
richContentIdstringRequired

Rich content ID.

Response Object
richContentRichContent

The requested rich content.

Get rich content
Request
cURL
curl -X GET 'https://www.wixapis.com/events/v1/rich-content/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \ -H 'Authorization: <AUTH>' \
Response
JSON
{ "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 } } } ] } } }
Did this help?

DELETE

Delete Rich Content


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Events
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/events-ricos/v1/rich-content/{richContentId}

Path Params
richContentIdstringRequired

ID of rich content to delete.

Response Object
Returns an empty object.
Delete rich content
Request
cURL
curl -X DELETE 'https://www.wixapis.com/events/v1/rich-content/52269077-05f2-4b59-ba4f-36ef8c4c1e11' \ -H 'Authorization: <AUTH>' \
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

PATCH

Update Rich Content


Developer Preview

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Events
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events-ricos/v1/rich-content/{richContent.id}

Path Params
richContent.idstringRequired

Rich content ID.

Body Params
richContentRichContentRequired

Fields to update.

Response Object
richContentRichContent

Updated rich content.

Update rich content
Request
cURL
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 } } } ] } } }'
Response
JSON
{ "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 } } } ] } } }
Event TriggersThis method triggers the following events:
Did this help?

POST

Query Rich Content


Developer Preview

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 order
  • paging.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.

Permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events-ricos/v1/rich-content/query

Body Params
queryQuery

Query options. See API Query Language for more details.

Response Object
richContentArray <RichContent>

List of rich content entities.


pagingMetadataPagingMetadata

Paging metadata.

Query rich content
Request
cURL
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 } } }'
Response
JSON
{ "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 } } } ] } } }
Did this help?

Rich Content Created


Developer Preview

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.

Permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

RichContentCreated
JSON
{ "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 }
Did this help?

Rich Content Deleted


Developer Preview

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.

Permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

RichContentDeleted
JSON
{ "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 }
Did this help?

Rich Content Updated


Developer Preview

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.

Permissions
Manage Bookings Services and Settings
Manage Events - all permissions
Read Events - all read permissions
Read Events
Manage Guest List
Manage Portfolio
Manage Restaurants - all permissions
Manage Events
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v1.rich_content.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "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 } } }

RichContentUpdated
JSON
{ "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 }
Did this help?