nodes/generated

Interface SegmentNodeParameters

Source
interface SegmentNodeParameters {
    context?: {
        contextUi: {
            active?: boolean;
            app?: {
                appUi: {
                    build?: string;
                    name?: string;
                    version?: string;
                };
            };
            campaign?: {
                campaignUi: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
            };
            device?: {
                deviceUi: {
                    id?: string;
                    manufacturer?: string;
                    model?: string;
                    name?: string;
                    type?: string;
                    version?: string;
                };
            };
            ip?: string;
            locate?: string;
            page?: string;
            timezone?: string;
        };
    };
    event?: string;
    groupId?: string;
    integrations?: {
        integrationsUi: {
            all?: boolean;
            salesforce?: boolean;
        };
    };
    name?: string;
    operation?: "event"
    | "create"
    | "add"
    | "page";
    properties?: {
        propertiesUi: { key?: string; value?: string }[];
    };
    resource?: "group"
    | "track"
    | "identify";
    traits?: {
        traitsUi: { key?: string; value?: string }[];
    };
    userId?: string;
}

Properties§

§readonly context?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly event?: string

Name of the action that a user has performed

§readonly groupId?: string

A Group ID is the unique identifier which you recognize a group by in your own database

§readonly integrations?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly name?: string

Name of the page For example, most sites have a “Signup” page that can be useful to tag, so you can see users as they move through your funnel

§readonly operation?: "event" | "create" | "add" | "page"

Default: "add"

§readonly properties?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly resource?: "group" | "track" | "identify"

Default: "identify"

§readonly traits?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly userId?: string