Thankly SDK for JavaScript
    Preparing search index...

    Interface PlaybookEngagementBlock

    Settings that only mean something when Thankly initiates the message.

    Present iff 'engagement' is in eligible_for — the API rejects any other combination. On an experience-only playbook these are not empty, they are unrepresentable: a widget renders immediately, so there is no channel to deliver on, nothing to defer, and no cached decision to expire.

    interface PlaybookEngagementBlock {
        channels: string[];
        content_ttl?: number | null;
        frequency_cap?: Record<string, unknown> | null;
        quiet_hours?: Record<string, unknown> | null;
    }
    Index
    channels content_ttl? frequency_cap? quiet_hours?
    channels: string[]

    Channels the playbook may deliver on.

    Optionalcontent_ttl

    content_ttl?: number | null

    Seconds a cached decision is served before regenerating (null = global default; 0 = no expiry).

    frequency_cap?: Record<string, unknown> | null

    Frequency cap: { max_per_day | max_per_N_days: n }.

    quiet_hours?: Record<string, unknown> | null

    Quiet-hours defer window: { start, end, tz }.

    Settings
    Member Visibility

    On This Page
    Properties