⚙️

experience.json

⚙️
JSON Config

Key Category
Key
Type
Description
blocksdefaultLivepages
predefinedBlocks
JSON Object

JSON object listing predefined blocks along with default configuration. Read full specs at predefinedBlocks

Root
author
String

Name of the author / company

Root
defaultLivepages
JSON Object

Root
defaultMenus
JSON Object

Root
description
String

Description. Limit to 250.

Root
features
String

Comma-separated list of features. Eg: Sticky menu, Live stream, Chat, Direct message, Participants list, Speakers and agenda, Content blocks, Notifications, Responsive template, Light and dark mode

Root
keyword
String

Comma-separated list of keywords. Eg: 1-Day, Multi-Track, Conference, Seminar, Meeting, Breakout

defaultMenus
name
String

Name of the menu group

Root
version
String

Version number to differentiate between releases. Recommended to use semantic versioning - ie MAJOR.MINOR.PATCH

predefinedBlocks
data
JSON Object

JSON representation of a Block as defined at 📦Blocks

predefinedBlocks
preventBlockSettings
BooleanJSON Object

Determines whether a user is able to view and edit the "Block Settings" section (that consists of Width, Bounding Box, Height, etc...) in Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can view and edit the settings 2. true - nobody can view and edit the settings 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false }

predefinedBlocks
preventChangeType
BooleanJSON Object

Determines whether a user is able to change the type of Block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can change the type 2. true - nobody can change the type 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false }

predefinedBlocks
preventDelete
BooleanJSON Object

Determines whether a user is able to delete a block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can delete the block 2. true - nobody can delete the block 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false }

predefinedBlocks
preventEdit
BooleanJSON Object

Determines whether a user is able to view and edit the settings of a Block in the Venue Editor for a LivePage. The possible values are: 1. false - (default value) - ie, everybody can view and edit the settings 2. true - nobody can view or edit the settings 3. JSON object specifying value for each user role. Eg: { "SPONSOR": true, "MANAGER": false }

defaultLivepages
title
String

Title of LivePage

predefinedBlocks
type
String

Refers to "Type Name" as listed in 📦Blocks

defaultLivepages
isPublic
Boolean

Flag to determine whether the LivePage should be made public.

defaultLivepages
slug
String

Unique slug for the LivePage. When instantiating the venue for a project, if the slug is already taken, it will be automatically suffixed with some additional characters to make it unique.

defaultLivepages
template
String

LivePage Template name as defined in the venue.

defaultLivepages
title
String

Title of LivePage

defaultMenus
items
Array

Array of JSON objects, where each object represents a menu item. The format of each menu item follows: { "name": "Lobby", "link": "lobby", "openInNewWindow": false } link can refer to one of the following: 1. Unique slug of a LivePage that is specified within defaultLivepages 2. External link that starts with https://

defaultMenus
name
String

Name of the menu group