Thankly SDK for JavaScript
    Preparing search index...

    Interface Signal

    One behavioural event about a customer.

    interface Signal {
        client_signal_id: string;
        customer_location?: {
            country: string;
            postal_code?: string;
            subdivision?: string;
        };
        external_customer_id?: string;
        fingerprint?: string;
        occurred_at: string;
        product_refs?: ProductRef[];
        properties?: Record<string, unknown>;
        signal_type: string;
    }
    Index
    client_signal_id customer_location? external_customer_id? fingerprint? occurred_at product_refs? properties? signal_type
    client_signal_id: string

    Caller-supplied id, echoed back so a rejected signal can be matched to its source.

    customer_location?: {
        country: string;
        postal_code?: string;
        subdivision?: string;
    }

    Coarse location the event happened in.

    Type Declaration

    • country: string

      ISO country code.

    • Optionalpostal_code?: string

      Postal code.

    • Optionalsubdivision?: string

      State, province or region.

    external_customer_id?: string

    The partner's own identifier for the customer.

    fingerprint?: string

    Anonymous device fingerprint. This or external_customer_id is required.

    occurred_at: string

    When the event happened; may be backdated.

    product_refs?: ProductRef[]

    Products the event refers to.

    properties?: Record<string, unknown>

    Type-specific payload, validated against the type's schema.

    signal_type: string

    Registered signal type this event reports.

    Settings
    Member Visibility

    On This Page
    Properties