Type alias ScheduledAction

ScheduledAction: {
    currentStep: string;
    eventKey: string;
    eventLabel?: string;
    eventStep: string;
    id: string;
    kind: "emitCaseEvent";
    maxOccurrences: number;
    repeatEveryHours: number;
    requiredExistingAttVals?: {
        [att: string]: string[];
    };
    sendWebhook?: boolean;
}

Type declaration

  • currentStep: string

    only cases currently at this step are eligible

  • eventKey: string

    stable event identifier used for reporting/deduplication

  • Optional eventLabel?: string

    display label stored in caseevents/reporting; defaults to eventStep

  • eventStep: string

    step-like value sent to existing case-moved webhooks

  • id: string

    internal id for worker logs and manual triggers

  • kind: "emitCaseEvent"

    emit a non-stateful case event on a schedule while a case stays on a step

  • maxOccurrences: number

    max number of emitted occurrences for a single stay on currentStep

  • repeatEveryHours: number

    hours between occurrences

  • Optional requiredExistingAttVals?: {
        [att: string]: string[];
    }

    further restrict eligibility to cases whose history already contains these attachment values

    • [att: string]: string[]
  • Optional sendWebhook?: boolean

    reuse existing step webhook/SMS plumbing after each event emission

Settings

Member Visibility

Theme