Domains

About domains

Introduction

Domains

Domains form the data model for your project. You'll start off with a single domain, and many projects won't need more than that. They can be useful to group entities by purpose.

Every domain consists of a set of enums and entities.

Enums

An enum is a type that can hold several distinct values. Each value has an optional label, which is useful for showing users a natural language version of the value.

Entities

An entity is a set of records, each with a distinct id.

Entities can be private per tenant which means that end-users can't see each others data. You generally want to enable this flag for any entity that holds end-user data that they could access.

Entities can be is ref only which means their records are for reference only. Chat interactions can't create records in entities with this flag enabled.

When loading records into the platform via the API, any id field you set will be used. As long as the id values are unique per entity, this works, and can be useful when syncing between the platform and your own system.

Records

Records exist in entities and each one is assigned a distinct id.

On this page