Skip to content
ebitex
developers
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Start here
Overview
ebitex.io
Getting started
Set up your organization
Render content in a static site
Render content on a server
Render content from a .NET server
Add a form to your site
Content as code
Recognise visitors with their consent
Read Data records from JavaScript
Read Data records from a .NET server
Start a client site from the starter kit
Concepts
The content model
Environments and keys
Publishing
Localization
Assets in Content
Reading Data records
Knowing your audience
Guides
Generate types from your content model
Keep your content model in git
Let editors preview drafts on your site
Navigation, links and sitemaps
Serve pages only to members
Personalize content per visitor
Caching
Build against a sandbox
Streams, filters and search
Webhooks
Receive events from your organization
Promote content from a pipeline
Render an email from your own site
Replace a hand-written client
Upload assets from a script
API reference
Overview
Delivery: Sites and locales
Overview
List published sites
Get the locale tree
List the audiences content uses
Delivery: Pages
Overview
Resolve a path
Query the page tree
Get sitemap data
Delivery: Components
Overview
Get a published component
List published components
Get the delivered schema bundle
Delivery: Streams
Overview
Query a stream
Get a stream facet
Delivery: Media
Overview
Download a published blob
Delivery: Preview
Overview
Exchange a preview token
Download a not-yet-published blob's bytes
Delivery: Assets
Overview
Describe the asset types
List and search assets
Get an asset with every rendition
Get an asset for one locale
Management: Assets
Overview
Find assets by the hash of the file
Get an asset
Update an asset's name, folder and text
Make an asset public
Make sure a folder exists
Start an upload
Complete an upload
Check an upload
Delivery: Data
Overview
List the models a key can read
List, filter and search records
Get a record by key
Forms SDK: Forms
Overview
Get a form
List published forms
Management: Key
Overview
Get the environment's neighbours
Describe the calling key
Management: Bundles and publishing
Overview
List the environment's items
Export a bundle
Plan an import
Import a bundle
Find stored blobs by hash
Upload a blob
Plan a publish
Publish content
Get a job's status
Download a blob
Management: Contracts
Overview
List contracts
Create a contract
Get a contract
Update a contract
Delete a contract
List contract versions
Get a contract version
List where a contract is used
List field types
Management: Templates
Overview
List templates
Create a template
Get a template
Update a template
Delete a template
List template versions
Get a template version
List a template's presentations
List where a template is used
Management: Components
Overview
List components
Create a component
Get a component
Update a component
Delete a component
Move components to a folder
List a component's references
Get everything that holds a component
Management: Folders
Overview
List folders
Create a folder
Count components per folder
Rename or move a folder
Delete a folder
Get a folder's access rules
Replace a folder's access rules
Get a folder's allowed contracts
Replace a folder's allowed contracts
Management: Experience
Overview
List sites
Create a site
Get a node
Update a node
Delete a node
List a node's children
Find nodes by category
Create a node
Move a node
Reorder sibling nodes
List what points at a node
Get where a node is used
Set a node's payload
Clear a node's payload
Get a node's access rules
Replace a node's access rules
Get a node's allowed Templates
Replace a node's allowed Templates
Management: Taxonomy
Overview
List category groups
Create a category group
Rename a category group
Delete a category group
List a group's categories
Add a category group to the environment
Remove a category group from the environment
Create a category
Update or move a category
Delete a category
Resolve a category path or id
Get a component's categories
Classify a component
Get a page's categories
Classify a page
Get a contract's categories
Classify a contract
Management: Adapters
Overview
List adapters
Create an adapter
Get an adapter
Delete an adapter
Update an adapter
List where an adapter is used
Validate an adapter
Preview an adapter
Management: Streams
Overview
List streams
Create a stream
Get a stream
Replace a stream
Delete a stream
Preview a stream
Management: Proposals
Overview
Offer content for review
Management: Checks and previews
Overview
Resolve a draft preview
List dangling references
List choice sources
Get a choice source's options
List unused items
Deployment: Promotion
Overview
Describe the calling key
Plan a promotion
Execute a promotion
Audience: People
Overview
Describe the calling key
Get the custom fields
List individuals
Create an individual
Get an individual
Update an individual
Add an identity
Remove an identity
Set a channel permission
List a person's interactions
Record an interaction
Identify a person
Forget a person
Audience: Lifecycle
Overview
List a person's lifecycle stages
Open a stage for a person
Change a pass's facts
Move a pass to another state
Walk the open passes in a stage
Count a stage by state
List the review queue
Create a task about a person
Resolve a review item
Dismiss a review item
Audience: Audiences
Overview
List audiences
Create an audience
Get an audience
Change an audience
Delete an audience
Audience: Accounts
Overview
List accounts
Get an account
Create or update an account
Delete an account
Add a person to an account
Remove a person from an account
Get an account's lifecycle
Open a pass for an account
Move an account's pass
Delivery: Audiences
Overview
Resolve which audiences a visitor is in
Ask for a sign-in link
Verify the browser that followed a link
Delivery: Visitors
Overview
Get or refresh a visitor token and the consent state
Forget a device
Record something a recognised visitor did
Record a behavioural event for a recognised visitor
SDK reference
@ebitex/content-sdk
index
Classes
ContentDeliveryError
ContentSdkError
RequestCache
Interfaces
AdapterDescriptor
AdapterWarning
AssetDocumentContent
AssetDocumentFile
AssetImageContent
AssetImageFile
AssetVideoContent
AssetVideoFile
AudienceAccess
AudienceClient
AudienceClientOptions
AudienceConsentSignals
AudienceGrant
AudienceHandle
AudienceOptions
AudienceTokenOption
BlobValue
BuiltInUnlock
CacheOptions
CategoryDescriptor
ComponentListItem
ComponentPage
ComponentPathEntry
ContentClient
ContentClientOptions
ContextBag
CurrentSiteOption
DeliveryClient
DeliveryClientOptions
EntityDescriptor
ExpandedReference
ExperienceLink
ExternalLink
GetComponentOptions
InlineValue
ListComponentsOptions
ListNodesOptions
LocaleTreeNode
MarkdownFragment
MembersOnlyBody
MembersOnlyDoor
MembersOnlyGate
NavigationNode
NavigationOptions
NavigationResult
NavigationTree
NotFoundExperience
PathOptions
PersistedExperience
PersistedReference
PersonalizedFragment
PresentationEnvelope
PresentationExperience
PresentationFragment
PresentationPathResult
QueryStreamOptions
ReadOptions
RedirectExperience
RedirectPathResult
ReferenceFragment
RequestOptions
ResolveAudiencesOptions
ResolvedAudiences
ResolvedSite
ResolveOverrides
SandboxRobots
SchemaBundle
SharedContentClientOptions
SiteLocaleHost
SiteSummary
StartSignInOptions
StreamFacetOptions
StreamFacetResult
StreamFacetValue
StreamPage
UnexpandedReference
UnresolvableReference
Type Aliases
AssetDocumentValue
AssetImageValue
AssetValue
AssetVideoValue
AudienceAssurance
AudienceRecognitionReason
BagPropertyValue
BagValue
ComponentValue
ContentDocument
ContentSdkErrorCode
ExperienceResult
JsonSchemaNode
LinkValue
LocationLike
NavigationInclude
NavigationNodeKind
OwnerRef
PathResult
ReferenceLike
RenderableComponentValue
ResolveStrategy
RichTextFragment
RichTextValue
SandboxMode
SiteAddressing
Variables
AUDIENCES_HEADER
AUDIENCES_STATUS_HEADER
DEFAULT_STRATEGY
FORM_SUBMITTED_EVENT
MARKER_COOKIE_NAME
MARKER_PATH
MAX_RESOLVE_DEPTH
NORMALIZED_DEFAULT_DEPTH
SANDBOX_HEADER
Functions
applyContextualOverlay
buildUrl
clearSharedContentClients
createAudienceClient
createContentClient
createDeliveryClient
createNavigationTree
depthFor
expandLanguageCandidates
hasAdapter
hasSessionHint
isAbortError
isAssetValue
isBlobValue
isCategoryDescriptor
isComponentValue
isInline
isLinkValue
isMarkerRequest
isPresentationEnvelope
isRecord
isReference
isResolved
isRichText
isRichTextFragment
isUnresolvable
isVariantSetEnvelope
markSessionHint
matchSite
membersOnlyOf
normalizePath
pathForSite
readSandboxMode
sandboxRobots
selectLocale
serializeContext
sharedContentClient
preview
Interfaces
ActivationWindow
DocumentMessage
DrawnPin
EditMessage
ErrorMessage
ModeMessage
NavigatedMessage
PreviewBoundaryFacts
PreviewBoundaryInfo
PreviewContext
PreviewEntity
PreviewFieldFacts
PreviewPin
PreviewReceiver
PreviewReceiverOptions
PreviewScriptHandle
PreviewScriptOptions
PreviewSource
PreviewTarget
ReadyMessage
Rect
RenderedMessage
ScriptOverlay
ScriptOverlayOptions
SelectMessage
StandaloneMessage
Type Aliases
BoundaryRegistry
BoundaryRegistryEntry
ComposerMessage
MessageBody
PreviewMessage
PreviewMode
PreviewPath
PreviewPinKind
SiteMessage
StandaloneResult
Variables
BOUNDARY_REGISTRY_SELECTOR
BOUNDARY_SELECTOR
DEFAULT_PREVIEW_ORIGINS
FALLBACK_SELECTOR
FIELD_SELECTOR
PREVIEW_MESSAGE_SOURCE
PREVIEW_PROTOCOL_VERSION
PREVIEW_QUERY_FLAG
Functions
bindBoundaries
computePins
createPreviewReceiver
createScriptOverlay
isPreviewActivated
isPreviewMessage
parseBoundaryRegistry
parseRegistryDocuments
previewMessage
readBoundaryRegistry
startPreviewScript
react
Interfaces
AudienceChangeState
ContentErrorProps
ContentProviderProps
EditorEntryCtaProps
ExperienceState
LazyRenderer
MarkdownRendererProps
NavigationState
PresentationListProps
PresentationRendererProps
PreviewBridgeProps
PreviewFieldAttributes
RendererModule
RenderPresentationProps
ResolveProps
RichTextProps
SignIn
StandaloneComponentProps
UnresolvedPresentationProps
UseExperienceInput
UseSignInOptions
Type Aliases
ExperienceProps
ExperienceStatus
FallbackReason
PresentationRenderer
RendererEntry
RendererResolver
Renderers
ResolutionState
SignInStatus
Variables
OwnerContext
REMEDIES
Functions
ContentError
ContentProvider
defineRenderers
EditorEntryCta
Experience
lazyRenderer
PresentationList
PreviewBridge
renderersFromGlob
RenderPresentation
Resolve
RichText
StandaloneComponent
UnresolvedPresentation
useAudienceChange
useAudienceRevision
useAudienceWatch
useExperience
useNavigation
useOwner
usePreviewField
usePreviewMode
usePreviewSource
usePreviewStandalone
useResolvedComponent
useResolveStrategy
useSignIn
References
OwnerRef
render
Classes
RenderNotFoundError
RenderUnrenderableError
Interfaces
EmailPage
RenderedEmail
RenderEmailOptions
RenderHandlerOptions
RenderRequest
RenderResult
Variables
RENDER_MAX_REQUEST_BYTES
RENDER_PATH
RENDER_SIGNATURE_HEADER
RENDER_TOLERANCE_SECONDS
Functions
createRenderHandler
escapeHtml
markdownToEmailHtml
renderEmail
safeUrl
signRenderBody
tokensIn
verifyRenderSignature
sitemap
Classes
SitemapTooLargeError
Interfaces
BuildSitemapDocumentsOptions
BuildSitemapXmlOptions
SitemapDocument
SitemapLocalePath
SitemapNode
SitemapResult
Type Aliases
SitemapTooLargeReason
Variables
MAX_SITEMAP_BYTES
MAX_SITEMAP_INDEX_ENTRIES
MAX_SITEMAP_URLS
Functions
buildSitemapDocuments
buildSitemapXml
@ebitex/forms-sdk
index
Classes
FormsApiError
Interfaces
AllOfPredicate
Attribution
ButtonField
ChoiceField
ChoiceOption
ConsentMessages
ConsentOptions
ConsentState
FieldComparisonPredicate
FieldsetNode
FormsClient
FormsClientOptions
FormStep
InputField
LookupSource
NumberField
RowNode
SdkForm
SharedVisitors
TextareaField
ValidateOptions
VariantBranch
VariantNode
VisitorSession
VisitorSessionOptions
VisitorStorage
Type Aliases
ButtonType
ChoiceType
FieldComparisonOperator
FormField
FormNode
InputVariant
SandboxMode
SubmissionData
ValidationErrors
VariantPredicate
Variables
LOOKUP_COMPANION_SUFFIX
MAX_LOOKUP_VALUE_LENGTH
SANDBOX_HEADER
Functions
adjacentVisibleStepSlot
collectDataFields
collectSubmissionKeys
createFormsClient
createPublicLookupSource
createVisitorSession
defaultChoiceValues
deriveDarkVariant
forgetUrlFromSubmissionUrl
isAllOfSatisfied
isDataField
isFieldComparisonSatisfied
isFormField
isSatisfied
lookupUrlFromSubmissionUrl
resolveSteps
resolveVariant
resolveVisibleStepSlot
sharedVisitorSession
validateSubmission
react
Interfaces
ChoiceFieldComponentProps
EbitexFormProps
FieldComponentProps
FieldComponents
Variables
FORM_SUBMITTED_EVENT
Functions
ActionButtons
ChoiceFieldControl
EbitexForm
InputFieldControl
LookupFieldControl
NodeList
NumberFieldControl
TextareaFieldControl
References
createVisitorSession
VisitorSession
VisitorSessionOptions
@ebitex/content-mcp
Classes
ConfigError
ContentApiError
StartupError
Type Aliases
BuiltServer
ContentClient
EntityKind
ServerConfig
Session
WhoAmI
Variables
SERVER_NAME
SERVER_VERSION
WRITABLE_KINDS
Functions
buildServer
createClient
isEntityKind
readConfig
resolveSession
routesFor
startupBanner
@ebitex/visitors-sdk
index
Classes
VisitorsApiError
Interfaces
Attribution
ConnectEmbedsOptions
ConsentMessages
ConsentOptions
ConsentSignals
ConsentState
CookieStorageOptions
EventInput
EventResult
InteractionOptions
InteractionResult
Visitors
VisitorSession
VisitorsOptions
VisitorsSnapshot
VisitorStorage
Variables
DEFAULT_ENDPOINT
DEFAULT_FORMS_ORIGIN
Functions
connectEmbeds
cookieStorage
createVisitors
react
Interfaces
ForgetDeviceButtonProps
Functions
ForgetDeviceButton
useVisitors
VisitorsProvider
@ebitex/data-sdk
Classes
DataApiError
DataNetworkError
Interfaces
BatchResult
CallOptions
DataClient
DataClientOptions
DataRecord
ExpansionOptions
FieldDescriptor
InlineValue
ModelDescriptor
ModelsResult
Pointer
RecordOptions
RecordsPage
RecordsQuery
ReferenceValue
Type Aliases
FieldFilter
FilterOperator
PointerKind
RecordResponse
Scalar
Variables
DEFAULT_BASE_URL
Limits
Functions
buildBatchQuery
buildRecordQuery
buildRecordsQuery
createDataClient
expanded
isInline
isReference
readPointer
@ebitex/starter-kit-react
index
Interfaces
MediaValueLike
Type Aliases
AccordionBehaviour
ActionStyle
Align
Appearance
Aspect
Background
Emphasis
InitiallyOpen
Layout
LogoSize
Media
Spacing
Theme
Tone
Width
Variables
ACCORDION_BEHAVIOURS
ACTION_STYLES
ALIGNS
APPEARANCES
ASPECT_CLASS
ASPECTS
BACKGROUNDS
EMPHASES
INITIALLY_OPEN
LAYOUTS
LOGO_SIZES
SPACING_GAP
SPACING_PAD
SPACINGS
THEMES
TONES
WIDTH_CLASS
WIDTHS
Functions
keyOf
pick
pickOptional
readMedia
text
whole
react
Interfaces
EbitexOptions
SiteChrome
SiteFooterContent
SiteHeaderContent
Type Aliases
EbitexLink
EbitexRendererProps
Variables
EbitexExperience
ICON_NAMES
SITE_CHROME_EXTERNAL_ID
Functions
Accordion
Action
Banner
Card
Cta
EbitexMarkdown
EbitexProvider
ebitexRenderers
Feature
Frame
Grid
Group
Hero
Icon
Media
MediaBlock
Nested
RichTextBlock
SiteFooter
SiteFooterTemplate
SiteHeader
SiteHeaderTemplate
Tabs
useAppearance
useEbitex
useNested
useSiteChrome
Errors
Changelog
Releases and versions
Select theme
Dark
Light
Auto
Overview
Management: Proposals
Section titled “Management: Proposals”
Offer content from outside the organization, for a person to review.
Operations
Section titled “ Operations ”
POST
/content/management/v1/proposals