Interface TriggerInterface

Base entity interface for all platform resources

All entities in the Mosaia platform extend this interface to provide consistent base properties across all resource types. This ensures that all entities have common fields for identification, status, and integration capabilities.

Example

const entity: BaseEntity = {
  id: 'entity-123',
  active: true,
  external_id: 'external-system-id',
  extensors: {
    custom_field: 'custom_value'
  }
};
interface TriggerInterface {
    record_history?: RecordHistory;
    id?: string;
    org?: string | { id?: string; [key: string]: any };
    user?: string | { id?: string; [key: string]: any };
    name?: string;
    description?: string;
    type?: TriggerType;
    agent?: string | { id?: string; [key: string]: any };
    task?: string | { id?: string; [key: string]: any };
    plan?: string | { id?: string; [key: string]: any };
    log?: string | { id?: string; [key: string]: any };
    user_message?: string;
    status?: TriggerStatus;
    pause_on_completion?: boolean;
    last_triggered_at?: string | Date;
    next_trigger_at?: string | Date;
    trigger_count?: number;
    active?: boolean;
    config?: TriggerConfig;
    metadata?: Record<string, any>;
    keywords?: string[];
    tags?: string[];
    external_id?: string;
    extensors?: Record<string, any>;
}

Hierarchy (View Summary)

Properties

record_history? id? org? user? name? description? type? agent? task? plan? log? user_message? status? pause_on_completion? last_triggered_at? next_trigger_at? trigger_count? active? config? metadata? keywords? tags? external_id? extensors?

Properties

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string | { id?: string; [key: string]: any }

Organization reference (optional)

Optionaluser

user?: string | { id?: string; [key: string]: any }

User reference (optional)

Optionalname

name?: string

Optionaldescription

description?: string

Optionaltype

type?: TriggerType

Optionalagent

agent?: string | { id?: string; [key: string]: any }

Agent reference (optional)

Optionaltask

task?: string | { id?: string; [key: string]: any }

Task reference (optional; exactly one of agent, task, plan required)

Optionalplan

plan?: string | { id?: string; [key: string]: any }

Plan reference (optional)

Optionallog

log?: string | { id?: string; [key: string]: any }

AgentLog reference (optional)

Optionaluser_message

user_message?: string

Optionalstatus

status?: TriggerStatus

Optionalpause_on_completion

pause_on_completion?: boolean

Auto-pause when task/plan completes (main indicator for whether cron runs again)

Optionallast_triggered_at

last_triggered_at?: string | Date

Optionalnext_trigger_at

next_trigger_at?: string | Date

Optionaltrigger_count

trigger_count?: number

Optionalactive

active?: boolean

Whether the entity is active

Optionalconfig

config?: TriggerConfig

Type-specific config (e.g. CRON: cron_expression, timezone, run_once)

Optionalmetadata

metadata?: Record<string, any>

Optionalkeywords

keywords?: string[]

Optionaltags

tags?: string[]

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: Record<string, any>

Extended properties for custom integrations

Settings

Member Visibility

On This Page

Properties