Skip to main content

A real-time chat feed attached to an experience, with configurable moderation and posting permissions.

​
id
string
required

The unique identifier for the entity

​
experience
object
required

The experience this chat feed is attached to.

​
ban_media
boolean
required

Whether media uploads such as images and videos are blocked in this chat.

​
ban_urls
boolean
required

Whether URL links are blocked from being posted in this chat.

​
who_can_post
enum<string>
required

The permission level controlling which users can send messages in this chat.

Available options:
everyone,
admins
​
who_can_react
enum<string>
required

The permission level controlling which users can add reactions in this chat.

Available options:
everyone,
no_one
​
user_posts_cooldown_seconds
integer | null
required

The minimum number of seconds a user must wait between consecutive messages. Null if no cooldown is enforced.

Example:

42

​
banned_words
string[]
required

A list of words that are automatically filtered from messages in this chat.

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.