Thankly SDK for JavaScript
    Preparing search index...

    Interface Playbook

    A stored engagement playbook.

    interface Playbook {
        active: boolean;
        audience_description?: string;
        created_at: string;
        created_by?: string;
        description?: string;
        eligible_for: PlaybookSurface[];
        engagement?: PlaybookEngagementBlock | null;
        excluded_capabilities: string[];
        goal: string;
        id: string;
        must_mention?: string[];
        must_not_mention?: string[];
        name: string;
        org_id: string;
        playbook_id: string;
        pre_filter?: PreFilter;
        tone_hint?: string;
        updated_at: string;
        version: number;
    }
    Index
    active audience_description? created_at created_by? description? eligible_for engagement? excluded_capabilities goal id must_mention? must_not_mention? name org_id playbook_id pre_filter? tone_hint? updated_at version
    active: boolean

    Whether the playbook is live.

    audience_description?: string

    Who this playbook is for, in prose.

    created_at: string

    When the record was created.

    created_by?: string

    Who created the record.

    description?: string

    Detailed description with relevant details and benefits

    eligible_for: PlaybookSurface[]

    Which surfaces this playbook may steer.

    engagement?: PlaybookEngagementBlock | null

    Delivery settings; null on a playbook that never initiates a message.

    excluded_capabilities: string[]

    Capabilities barred from this playbook's engagement blocks.

    goal: string

    The goal of the quiz (e.g., 'personalize shopping experience')

    id: string

    Stable item identifier for client-side matching

    must_mention?: string[]

    Points the copy is required to include.

    must_not_mention?: string[]

    Points the copy must avoid.

    name: string

    Product name

    org_id: string

    Organisation the record belongs to.

    playbook_id: string

    Playbook identifier.

    pre_filter?: PreFilter

    Audience filter applied before the decision runs.

    tone_hint?: string

    Desired tone for generated copy.

    updated_at: string

    When the record was last changed.

    version: number

    Increments each time the rules are amended.

    Settings
    Member Visibility

    On This Page
    Properties