Interface CustomerIoNodeParameters

Source
interface CustomerIoNodeParameters {
    additionalFields?:
        | {
            steps?: number;
            type?: | "email"
            | "empty"
            | "webhook"
            | "push"
            | "slack"
            | "twilio"
            | "urbanAirship";
        }
        | {
            createdAt?: string;
            customProperties?: {
                customProperty: { key: string; value: string }[];
            };
            email?: string;
        }
        | {
            customAttributes?: {
                customAttribute: { key: string; value: string }[];
            };
            type?: string;
        }
        | {
            customAttributes?: {
                customAttribute: { key: string; value: string }[];
            };
        };
    additionalFieldsJson?: string;
    campaignId?: number;
    customerId?: string;
    customerIds?: string;
    eventName?: string;
    id?: string;
    jsonParameters?: boolean;
    operation?: | "get"
    | "getAll"
    | "add"
    | "remove"
    | "delete"
    | "upsert"
    | "getMetrics"
    | "track"
    | "trackAnonymous";
    period?: "hours"
    | "days"
    | "weeks"
    | "months";
    resource?:
        | "event"
        | "customer"
        | "campaign"
        | "segment";
    segmentId?: number;
}

Properties§

Source§

readonly additionalFields?:
    | {
        steps?: number;
        type?: | "email"
        | "empty"
        | "webhook"
        | "push"
        | "slack"
        | "twilio"
        | "urbanAirship";
    }
    | {
        createdAt?: string;
        customProperties?: {
            customProperty: { key: string; value: string }[];
        };
        email?: string;
    }
    | {
        customAttributes?: {
            customAttribute: { key: string; value: string }[];
        };
        type?: string;
    }
    | {
        customAttributes?: {
            customAttribute: { key: string; value: string }[];
        };
    }

Default: {}

Source§

readonly additionalFieldsJson?: string

Object of values to set as described here Type options: {"alwaysOpenEditWindow":true}

Source§

readonly campaignId?: number

The unique identifier for the campaign

Source§

readonly customerId?: string

The unique identifier for the customer

Source§

readonly customerIds?: string

A list of customer IDs to add to the segment

Source§

readonly eventName?: string

Name of the event to track

Source§

readonly id?: string

The unique identifier for the customer

Source§

readonly jsonParameters?: boolean

Source§

readonly operation?:
    | "get"
    | "getAll"
    | "add"
    | "remove"
    | "delete"
    | "upsert"
    | "getMetrics"
    | "track"
    | "trackAnonymous"

Default: "get"

Source§

readonly period?: "hours" | "days" | "weeks" | "months"

Specify metric period Default: "days"

Source§

readonly resource?: "event" | "customer" | "campaign" | "segment"

Default: "customer"

Source§

readonly segmentId?: number

The unique identifier of the segment