@servicenow/sdk - v4.7.0
    Preparing search index...

    Type Alias TriggerConfigType

    Type representing the properties of a Trigger Configuration.

    type TriggerConfigType = {
        active?: boolean;
        businessRule?:
            | string
            | Record<"sys_script">
            | ReturnType<typeof BusinessRule>;
        channel: string;
        description?: string;
        domain?: string;
        enableDiscovery?: boolean;
        name: string;
        notificationScript?:
            | string
            | Record<"sys_script_client">
            | ReturnType<typeof ClientScript>;
        objectiveTemplate: string;
        portal?: string | Record<"now_assist_deployment_channel">;
        profile?: string | Record<"now_assist_deployment">;
        runAs?: string;
        runAsScript?: ((current: any, ...dependencies: any[]) => string) | string;
        runAsUser?: string | Record<"sys_user">;
        schedule?: AiAgenticWorkflowScheduleConfigType;
        showNotifications?: boolean;
        sysOverrides?: string | Record<"sn_aia_trigger_agent_usecase_m2m">;
        targetTable: TableName;
        triggerCondition: string;
        triggerFlowDefinitionType: TriggerFlowDefinition;
    }
    Index

    Properties

    active? businessRule? channel description? domain? enableDiscovery? name notificationScript? objectiveTemplate portal? profile? runAs? runAsScript? runAsUser? schedule? showNotifications? sysOverrides? targetTable triggerCondition triggerFlowDefinitionType

    Properties

    active?: boolean

    Active status - defaults to false

    businessRule?: string | Record<"sys_script"> | ReturnType<typeof BusinessRule>

    Reference to Business Rule (sys_id, Record<'sys_script'>, or BusinessRule)

    channel: string

    Reference to Messaging Channel - defaults to Now Assist Panel. Use string value: "Now Assist Panel"

    description?: string

    Description of the trigger

    domain?: string

    Domain ID

    enableDiscovery?: boolean

    Enable discovery flag - defaults to FALSE

    name: string

    Name of the trigger

    notificationScript?:
        | string
        | Record<"sys_script_client">
        | ReturnType<typeof ClientScript>

    Reference to Client Script for notifications

    objectiveTemplate: string

    Objective template

    portal?: string | Record<"now_assist_deployment_channel">

    Reference to Now Assist Deployment Channel (sys_id or Record<'now_assist_deployment_channel'>)

    profile?: string | Record<"now_assist_deployment">

    Reference to Now Assist Deployment (sys_id or Record<'now_assist_deployment'>)

    runAs?: string

    Run as field name

    runAsScript?: ((current: any, ...dependencies: any[]) => string) | string

    Run as script - supports inline scripts or Now.include() for external files

    runAsUser?: string | Record<"sys_user">

    Reference to User who runs the trigger (user sys_id or Record<'sys_user'>)

    schedule?: AiAgenticWorkflowScheduleConfigType

    Schedule configuration - used for scheduled triggers (scheduled, daily, weekly, monthly)

    showNotifications?: boolean

    Show notifications flag

    sysOverrides?: string | Record<"sn_aia_trigger_agent_usecase_m2m">

    Reference to override the trigger-agent-usecase mapping (sn_aia_trigger_agent_usecase_m2m)

    targetTable: TableName

    Target table name (Table Name)

    triggerCondition: string

    Conditions for the trigger (encoded query)

    triggerFlowDefinitionType: TriggerFlowDefinition

    Trigger flow definition type - choices: record_create, record_create_or_update, record_update, email, scheduled, daily, weekly, monthly

    Settings

    Member Visibility

    On This Page

    Properties