Contentful Personalization & Analytics
    Preparing search index...

    Interface CoreStatefulConfig

    Configuration for CoreStateful.

    interface CoreStatefulConfig {
        allowedEventTypes?: AllowedEventType[];
        api?: CoreStatefulApiConfig;
        contentful?: ContentfulConfig;
        defaults?: CoreConfigDefaults;
        environment?: string;
        eventBuilder?: EventBuilderConfig;
        fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">;
        getAnonymousId?: () => string | undefined;
        locale?: string;
        logLevel?: LogLevels;
        onEventBlocked?: (event: BlockedEvent) => void;
        queuePolicy?: QueuePolicy;
        spaceId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowedEventTypes? api? contentful? defaults? environment? eventBuilder? fetchOptions? getAnonymousId? locale? logLevel? onEventBlocked? queuePolicy? spaceId

    Properties

    allowedEventTypes?: AllowedEventType[]

    Allow-listed event type strings permitted when consent is not set.

    api?: CoreStatefulApiConfig

    Unified API configuration for stateful environments.

    contentful?: ContentfulConfig

    Optional SDK-managed Contentful Delivery API entry fetching.

    Existing manual resolveOptimizedEntry() usage remains supported. Configure this when callers want the SDK to fetch entries by ID or by content type and slug through contentful.js.

    defaults?: CoreConfigDefaults

    Optional set of default values applied on initialization.

    environment?: string

    Contentful space environment identifier.

    Used by the Experience API v3 and Insights API v2 /environments/{environment}/ path segment.

    'master'

    eventBuilder?: EventBuilderConfig

    Event builder configuration (channel/library metadata, etc.).

    fetchOptions?: Omit<ProtectedFetchMethodOptions, "apiName">

    Options used to configure the underlying protected fetch method.

    apiName is derived from the client name and must not be provided here.

    getAnonymousId?: () => string | undefined

    Function used to obtain an anonymous user identifier.

    locale?: string

    Default SDK locale used for Experience API requests and event context.

    logLevel?: LogLevels

    Minimum log level for the default console sink.

    onEventBlocked?: (event: BlockedEvent) => void

    Callback invoked whenever an event call is blocked by checks.

    queuePolicy?: QueuePolicy

    Unified queue policy for queued stateful work.

    spaceId: string

    Contentful Space identifier used for authentication or tracking.

    Settings

    Member Visibility

    On This Page

    Properties