Digital Chat Channel JSON Schemas
Use the following schemas when sending messages with Digital Experience or channels. All IDs used for elements in these schemas must be unique. The exception to this is if you're referring to an element you previously defined to make sure an event happens to that specific element, such as with a postback.
The following schemas are available on the help site:
- Carousel
- Image
- Markdown
- Multiple messages in a single response
- Prompts
- Quick replies
- Text
- URL
The schemas are included below. You can also download a ZIP file that contains JSON text files with each schema.
Use the Digital Experience mirror tool to validate JSON you plan to use with Live Chat channels.
Carousel
{
"prompts": [{
"mediaSpecificObject": {
"dfoMessage": {
"messageContent": {
"type": "PLUGIN",
"payload": {
"elements": [
{
"id": "Ek4tPy1h4",
"type": "MENU",
"elements": [
{
"id": "Uk4tPy1h2",
"type": "FILE",
"url": "https://picsum.photos/300/150",
"filename": "photo.jpg",
"mimeType": "image/jpeg"
},
{
"id": "Ck4tPy1h3",
"type": "TITLE",
"text": "Hello!"
},
{
"id": "Ek4tPy1h1",
"type": "TEXT",
"text": "Lorem Impsum..."
},
{
"id": "Nkm0hRAiE",
"type": "BUTTON",
"text": "Click me!",
"postback": "click-on-button-1"
},
{
"id": "EyCyTRCi4",
"type": "BUTTON",
"text": "Aww don`t click on me",
"postback": "click-on-button-2"
}
]
},
{
"id": "Ek4tPy1h52",
"type": "MENU",
"elements": [
{
"id": "Uk4tPy1h22",
"type": "FILE",
"url": "https://picsum.photos/300/150",
"filename": "photo.jpg",
"mimeType": "image/jpeg"
},
{
"id": "Ck4tPy1h32",
"type": "TITLE",
"text": "Hello!"
},
{
"id": "Ek4tPy1h12",
"type": "TEXT",
"text": "Lorem Impsum..."
},
{
"id": "Nkm0hRAiE2",
"type": "BUTTON",
"text": "Click me!",
"postback": "click-on-button-1"
},
{
"id": "NkGJ6CAiN2",
"type": "BUTTON",
"text": "Aww don`t click on me",
"postback": "click-on-button-2"
}
]
}
]
}
}
}
}
}
]
}
Image
Markdown
Multiple Messages in a Single Response
Prompt
Quick Reply
Text
URL